GraphQL API Reference
Welcome to the Oog GraphQL API Reference. You can use this reference to understand the capabilities of the GraphQL API, including the query and mutation structure and the available types.
API Endpoints
# Staging:
https://staging.api.oog.health/graphql
Authentication
All request to the API require a bearer token included in the Authorization header.
User Roles & Authentication
Oog users can be one of two roles: Admin or User.
The User role is for users who will be logging into the Oog app and creating/consuming content. They login exlusively with their number number and an OTP code. First call the sendPhoneOTP mutation, then consume the OTP with the verifyPhoneOTP mutation.
Users with an Admin are identified by email address and login to the admin panel to perform moderation and content tasks. See the verifyPhoneOTP mutation for an example of how to authenticate users via phone number.
Both mutations return a [LoginResponse] object that contains a JWT token you can add to your requests as a Bearer token in the Authorization header.
Video & Images
Video Uploading
Uploading a video to Oog begins with a call to generateVideoUploadURL to obtain a signed URL to upload the video to a storage bucket on Amazon S3. The mutation response also includes a draft Video object that you can poll to determine when the video is ready to stream.
Downloading/Viewing Videos
Poll the video to watch for it's status to change to "ready". Choose from the hlsUrl or the dashUrl field to stream the transcoded video.
Tracking Video Completion
Use the createVideoEvent mutation to send a notfication when a user has completed watching a video.
Image Uploading
Uploading an Image is similar to uploading a video. Obtain a signed upload URL by calling generateImageUploadURL to obtain both the url and a draft Image
Downloading/Viewing Images
The image is available for download immediately after the uploading completes at the url listed on the Image object received earlier + choosing a variant of transformation to add on to the end of the url.
Images are hosted on Cloudflare images. See their documentation on how to specify a transformation.
Posts
Queries
collections
Response
Returns a CollectionConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CollectionWhereInput
|
Filtering options for Collections returned from the connection. |
Example
Query
query collections(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CollectionWhereInput
) {
collections(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CollectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"where": CollectionWhereInput
}
Response
{
"data": {
"collections": {
"edges": [CollectionEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
post
Example
Query
query post($id: ID!) {
post(id: $id) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"post": {
"id": "4",
"title": "abc123",
"suggestedTitle": "xyz789",
"creditHours": 123.45,
"status": "draft",
"body": "abc123",
"suggestedBody": "abc123",
"totalVideos": 123,
"totalImages": 123,
"totalDuration": 987,
"totalLikes": 987,
"totalComments": 987,
"totalReactions": 987,
"totalBookmarks": 123,
"speakMediaID": "xyz789",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 123,
"termsPerMinute": 987.65,
"terms": ["abc123"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
posts
Response
Returns a PostConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - PostOrder
|
Ordering options for Posts returned from the connection. |
where - PostWhereInput
|
Filtering options for Posts returned from the connection. |
search - String
|
The search term to filter posts by. Using this argument will:
|
Example
Query
query posts(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: PostOrder,
$where: PostWhereInput,
$search: String
) {
posts(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where,
search: $search
) {
edges {
...PostEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": PostOrder,
"where": PostWhereInput,
"search": "abc123"
}
Response
{
"data": {
"posts": {
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
Mutations
createPost
Description
Creates a post for the current user
Response
Returns a Post!
Arguments
| Name | Description |
|---|---|
input - CreatePostInput!
|
The fields to use when creating the post |
Example
Query
mutation createPost($input: CreatePostInput!) {
createPost(input: $input) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"input": CreatePostInput}
Response
{
"data": {
"createPost": {
"id": "4",
"title": "xyz789",
"suggestedTitle": "abc123",
"creditHours": 123.45,
"status": "draft",
"body": "xyz789",
"suggestedBody": "xyz789",
"totalVideos": 123,
"totalImages": 987,
"totalDuration": 123,
"totalLikes": 987,
"totalComments": 987,
"totalReactions": 123,
"totalBookmarks": 987,
"speakMediaID": "xyz789",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["abc123"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 123,
"termsPerMinute": 123.45,
"terms": ["abc123"],
"termFrequencies": Map,
"wordcloud": "xyz789",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": false,
"topicClassifications": [TopicClassification]
}
}
}
updatePost
Description
Updates the post for the specified id. The post must belong to the current user
Response
Returns a Post!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The id of the post to update |
input - UpdatePostInput!
|
The fields to use when updating the post |
Example
Query
mutation updatePost(
$id: ID!,
$input: UpdatePostInput!
) {
updatePost(
id: $id,
input: $input
) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"id": 4, "input": UpdatePostInput}
Response
{
"data": {
"updatePost": {
"id": 4,
"title": "abc123",
"suggestedTitle": "abc123",
"creditHours": 123.45,
"status": "draft",
"body": "xyz789",
"suggestedBody": "xyz789",
"totalVideos": 123,
"totalImages": 987,
"totalDuration": 123,
"totalLikes": 987,
"totalComments": 123,
"totalReactions": 987,
"totalBookmarks": 123,
"speakMediaID": "xyz789",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["abc123"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 987,
"termsPerMinute": 123.45,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "xyz789",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
likePost
Description
Creates a Like for the specified post and current user. If the user has already liked the post, this will return the existing like.
Response
Returns a Like!
Arguments
| Name | Description |
|---|---|
input - LikePostInput!
|
The fields to use when creating the like |
Example
Query
mutation likePost($input: LikePostInput!) {
likePost(input: $input) {
id
likedAt
userID
postID
user {
...UserFragment
}
post {
...PostFragment
}
}
}
Variables
{"input": LikePostInput}
Response
{
"data": {
"likePost": {
"id": 4,
"likedAt": "10:15:30Z",
"userID": 4,
"postID": 4,
"user": User,
"post": Post
}
}
}
unLikePost
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - LikePostInput!
|
Example
Query
mutation unLikePost($input: LikePostInput!) {
unLikePost(input: $input)
}
Variables
{"input": LikePostInput}
Response
{"data": {"unLikePost": {}}}
bookmarkPost
Description
Creates a Bookmark for the specified post and current user
Response
Returns a Bookmark!
Arguments
| Name | Description |
|---|---|
input - BookmarkPostInput!
|
The fields to use when creating the bookmark |
Example
Query
mutation bookmarkPost($input: BookmarkPostInput!) {
bookmarkPost(input: $input) {
id
bookmarkedAt
userID
postID
user {
...UserFragment
}
post {
...PostFragment
}
}
}
Variables
{"input": BookmarkPostInput}
Response
{
"data": {
"bookmarkPost": {
"id": "4",
"bookmarkedAt": "10:15:30Z",
"userID": "4",
"postID": 4,
"user": User,
"post": Post
}
}
}
removeBookmark
Description
Removes a Bookmark for the specified post and current user
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - BookmarkPostInput!
|
Example
Query
mutation removeBookmark($input: BookmarkPostInput!) {
removeBookmark(input: $input)
}
Variables
{"input": BookmarkPostInput}
Response
{"data": {"removeBookmark": {}}}
createPostReaction
Description
Creates a PostReaction for the specified post and current user
Response
Returns a PostReaction!
Arguments
| Name | Description |
|---|---|
input - PostReactionInput!
|
The fields to use when creating the post reaction |
Example
Query
mutation createPostReaction($input: PostReactionInput!) {
createPostReaction(input: $input) {
id
reactedAt
value
userID
postID
user {
...UserFragment
}
post {
...PostFragment
}
}
}
Variables
{"input": PostReactionInput}
Response
{
"data": {
"createPostReaction": {
"id": 4,
"reactedAt": "10:15:30Z",
"value": "xyz789",
"userID": 4,
"postID": 4,
"user": User,
"post": Post
}
}
}
Types
Bookmark
Example
{
"id": "4",
"bookmarkedAt": "10:15:30Z",
"userID": "4",
"postID": "4",
"user": User,
"post": Post
}
Like
Example
{
"id": 4,
"likedAt": "10:15:30Z",
"userID": "4",
"postID": 4,
"user": User,
"post": Post
}
Post
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
title - String!
|
Title of the post |
suggestedTitle - String
|
A suggested title based on the audio transcription |
creditHours - Float!
|
The number of CE credits this post is accredited for |
status - PostStatus!
|
Status of the post |
body - String!
|
Body of the post. Tags (starting with a #) and Mentions (starting with an @) are allowed |
suggestedBody - String
|
A suggested body based on the audio transcription |
totalVideos - Int!
|
Total number of videos on this post. |
totalImages - Int!
|
Total number of images on this post. |
totalDuration - Int!
|
The total duration of all videos for this post, in seconds. |
totalLikes - Int!
|
Total number of likes |
totalComments - Int!
|
Total number of comments |
totalReactions - Int!
|
Total number of reactions |
totalBookmarks - Int!
|
Total number of bookmarks |
speakMediaID - String
|
The ID of this post in SpeakAI |
featured - Boolean!
|
Whether this post is featured |
transcription - SpeakInsightResult
|
The transcription result from SpeakAI |
discussionPoints - [String!]
|
The main discussion points for this post |
topLearningObjectives - [String!]
|
The top learning objectives for this post |
createdAt - Time!
|
|
updatedAt - Time!
|
|
transcriptionStartedAt - Time
|
The time when the transcription started |
transcriptionCompletedAt - Time
|
The time when the transcription completed |
insightsGeneratedAt - Time
|
The time when the insights were last generated |
sortKey - Int
|
|
termsPerMinute - Float!
|
The number of terms per minute in the video |
terms - [String!]
|
|
termFrequencies - Map
|
|
wordcloud - String
|
|
type - PostType!
|
The type of the post |
author - User
|
The author of this post |
topics - [Topic!]
|
The topics this post is associated with |
citations - [PostCitation!]
|
The citations this post is associated with |
tenant - Tenant
|
The tenant that the topic belongs to. |
accreditedLearningObjective - LearningObjective
|
The accredited learning objective for this post |
comments - [Comment!]
|
The comments on this post |
mediaItems - [MediaItem!]
|
The media items in this post |
videos - [Video!]
|
The videos for this post. |
coverImage - Image
|
The cover image for this post. Images are hosted using Cloudflare images. Please see https://developers.cloudflare.com/images/cloudflare-images/serve-images/ for details on how to serve images. |
images - [Image!]
|
The images for this post. |
postCollections - [PostCollection!]
|
The collections this post is associated with |
educationCredits - [EducationCredit!]
|
All credits earned from this post, across all the user. |
audiences - [Audience!]
|
The audiences for this post |
tags - [Tag!]
|
The tags on this post |
likedUsers - [User!]
|
The users who liked this post |
bookmarkedUsers - [User!]
|
The users who bookmarked this post |
learningObjectives - [LearningObjective!]
|
The selected learning objectives for this post |
postReports - [PostReport!]
|
The post reports this post has received |
poll - Poll
|
|
embeddings - [PostEmbedding!]
|
|
likes - [Like!]
|
|
bookmarks - [Bookmark!]
|
|
postlearningobectives - [PostLearningObjective!]
|
|
likedAt - Time
|
|
bookmarkedAt - Time
|
|
commentsDisabled - Boolean
|
|
topicClassifications - [TopicClassification!]
|
|
Example
{
"id": 4,
"title": "xyz789",
"suggestedTitle": "xyz789",
"creditHours": 987.65,
"status": "draft",
"body": "xyz789",
"suggestedBody": "xyz789",
"totalVideos": 123,
"totalImages": 123,
"totalDuration": 987,
"totalLikes": 123,
"totalComments": 987,
"totalReactions": 987,
"totalBookmarks": 123,
"speakMediaID": "abc123",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 123,
"termsPerMinute": 123.45,
"terms": ["abc123"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": false,
"topicClassifications": [TopicClassification]
}
PostReaction
Example
{
"id": 4,
"reactedAt": "10:15:30Z",
"value": "xyz789",
"userID": "4",
"postID": "4",
"user": User,
"post": Post
}
Search
Queries
searchV2
Description
Returns a list of posts or users that match the query. Each SearchResult also includes an ID you can use to create a SearchConversion.
Response
Returns a SearchResults!
Arguments
| Name | Description |
|---|---|
query - String!
|
Example
Query
query searchV2($query: String!) {
searchV2(query: $query) {
id
results {
... on UserSearchResult {
...UserSearchResultFragment
}
... on TopicSearchResult {
...TopicSearchResultFragment
}
... on PostSearchResult {
...PostSearchResultFragment
}
}
}
}
Variables
{"query": "xyz789"}
Response
{
"data": {
"searchV2": {"id": 4, "results": [UserSearchResult]}
}
}
Mutations
createSearchConversion
Description
Creates a SearchConversion for a SearchResult. This is used to track when a user clicks on a search result.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - SearchConversionInput!
|
Example
Query
mutation createSearchConversion($input: SearchConversionInput!) {
createSearchConversion(input: $input)
}
Variables
{"input": SearchConversionInput}
Response
{"data": {"createSearchConversion": {}}}
Types
SearchConversion
Example
{
"id": 4,
"createdAt": "10:15:30Z",
"convertableType": "abc123",
"convertableID": 987,
"search": Search
}
SearchResult
Types
| Union Types |
|---|
Example
{}
Topics
Queries
topics
Response
Returns a TopicConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - TopicOrder
|
Ordering options for Topics returned from the connection. |
where - TopicWhereInput
|
Filtering options for Topics returned from the connection. |
search - String
|
The search term to filter topics by. Using this argument will:
|
Example
Query
query topics(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: TopicOrder,
$where: TopicWhereInput,
$search: String
) {
topics(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where,
search: $search
) {
edges {
...TopicEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"orderBy": TopicOrder,
"where": TopicWhereInput,
"search": "xyz789"
}
Response
{
"data": {
"topics": {
"edges": [TopicEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
Mutations
followTopic
Description
Follow a single Topic
Example
Query
mutation followTopic($id: ID!) {
followTopic(id: $id) {
id
name
ordinal
type
modelID
modelVersion
totalPosts
words
wordFrequencies
generatedLabel
clusterID
clusterLabel
tenant {
...TenantFragment
}
cover {
...MediaItemFragment
}
coverImage {
...ImageFragment
}
users {
...UserFragment
}
classifications {
...TopicClassificationFragment
}
posts {
...PostFragment
}
pubmedArticles {
...PubmedArticleFragment
}
npiTaxonomies {
...NpiTaxonomyFragment
}
parent {
...TopicFragment
}
children {
...TopicFragment
}
pubmedTopicClusters {
...PubmedTopicClusterFragment
}
topicNpiTaxonomies {
...TopicNpiTaxonomyFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"followTopic": {
"id": "4",
"name": "abc123",
"ordinal": 123,
"type": "specialty",
"modelID": "xyz789",
"modelVersion": "abc123",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "xyz789",
"clusterID": 987,
"clusterLabel": "xyz789",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
followTopics
Description
Follow multiple topics
Example
Query
mutation followTopics($ids: [ID!]) {
followTopics(ids: $ids) {
id
name
ordinal
type
modelID
modelVersion
totalPosts
words
wordFrequencies
generatedLabel
clusterID
clusterLabel
tenant {
...TenantFragment
}
cover {
...MediaItemFragment
}
coverImage {
...ImageFragment
}
users {
...UserFragment
}
classifications {
...TopicClassificationFragment
}
posts {
...PostFragment
}
pubmedArticles {
...PubmedArticleFragment
}
npiTaxonomies {
...NpiTaxonomyFragment
}
parent {
...TopicFragment
}
children {
...TopicFragment
}
pubmedTopicClusters {
...PubmedTopicClusterFragment
}
topicNpiTaxonomies {
...TopicNpiTaxonomyFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"followTopics": [
{
"id": 4,
"name": "xyz789",
"ordinal": 123,
"type": "specialty",
"modelID": "xyz789",
"modelVersion": "xyz789",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "abc123",
"clusterID": 987,
"clusterLabel": "xyz789",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [
TopicPubmedTopicCluster
]
}
]
}
}
Types
Topic
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
The name of the topic. |
ordinal - Int!
|
The ordinal of the topic. |
type - TopicType!
|
The type of the topic. |
modelID - String
|
|
modelVersion - String
|
|
totalPosts - Int!
|
The total number of posts that are tagged with the topic. |
words - [String!]
|
|
wordFrequencies - Map
|
|
generatedLabel - String
|
|
clusterID - Int
|
|
clusterLabel - String
|
|
tenant - Tenant
|
The tenant that the topic belongs to. |
cover - MediaItem
|
The cover image of the topic. |
coverImage - Image
|
The cover image of the topic. |
users - [User!]
|
The users that are subscribed to the topic. |
classifications - [TopicClassification!]
|
The classifications of the topic. |
posts - [Post!]
|
The posts that are tagged with the topic. |
pubmedArticles - [PubmedArticle!]
|
The articles that are tagged with the topic. |
npiTaxonomies - [NpiTaxonomy!]
|
The NPI taxonomies that are tagged with the topic. |
parent - Topic
|
The children topics of the topic. |
children - [Topic!]
|
|
pubmedTopicClusters - [PubmedTopicCluster!]
|
|
topicNpiTaxonomies - [TopicNpiTaxonomy!]
|
|
topicPubmedTopicCluster - [TopicPubmedTopicCluster!]
|
Example
{
"id": "4",
"name": "abc123",
"ordinal": 987,
"type": "specialty",
"modelID": "xyz789",
"modelVersion": "abc123",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "abc123",
"clusterID": 987,
"clusterLabel": "abc123",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
Comments
Mutations
createComment
Description
Create a new comment. Comments are owned by the currently authenticated user, the authorID field can only be set by admins
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
input - CreateCommentInput!
|
Example
Query
mutation createComment($input: CreateCommentInput!) {
createComment(input: $input) {
id
body
reflectionPrompt
namedEntities {
...NamedEntityFragment
}
sentiment {
...SentimentFragment
}
totalLikes
createdAt
reflectionAnalysisResults {
...ReflectionResultFragment
}
updatedAt
shouldEarnCredits
didEarnCredits
creditWasApproved
author {
...UserFragment
}
post {
...PostFragment
}
parent {
...CommentFragment
}
replies {
...CommentFragment
}
educationCredit {
...EducationCreditFragment
}
commentNamedEntities {
...CommentNamedEntityFragment
}
reviewedBy {
...UserFragment
}
sparkyConversations {
...SparkyConversationFragment
}
likedUsers {
...UserFragment
}
commentLikes {
...CommentLikeFragment
}
}
}
Variables
{"input": CreateCommentInput}
Response
{
"data": {
"createComment": {
"id": "4",
"body": "xyz789",
"reflectionPrompt": "xyz789",
"namedEntities": [NamedEntity],
"sentiment": Sentiment,
"totalLikes": 987,
"createdAt": "10:15:30Z",
"reflectionAnalysisResults": ReflectionResult,
"updatedAt": "10:15:30Z",
"shouldEarnCredits": false,
"didEarnCredits": false,
"creditWasApproved": false,
"author": User,
"post": Post,
"parent": Comment,
"replies": [Comment],
"educationCredit": EducationCredit,
"commentNamedEntities": [CommentNamedEntity],
"reviewedBy": User,
"sparkyConversations": [SparkyConversation],
"likedUsers": [User],
"commentLikes": [CommentLike]
}
}
}
deleteComment
Description
Delete a comment by ID. Admins can delete any comment, users can only delete their own comments
Types
Comment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
body - String!
|
Body of the comment |
reflectionPrompt - String
|
The reflection prompt the user chose for this comment |
namedEntities - [NamedEntity!]
|
|
sentiment - Sentiment
|
|
totalLikes - Int!
|
The total number of likes this comment has |
createdAt - Time!
|
|
reflectionAnalysisResults - ReflectionResult
|
The results of the reflection analysis |
updatedAt - Time!
|
|
shouldEarnCredits - Boolean!
|
Whether or not the user should earn credits for this comment |
didEarnCredits - Boolean!
|
Whether or not the user earned credits for this comment |
creditWasApproved - Boolean
|
Whether or not the credit was approved |
author - User
|
The author of the comment |
post - Post
|
The post this comment belongs to |
parent - Comment
|
The replies to this comment |
replies - [Comment!]
|
|
educationCredit - EducationCredit
|
The education credit this comment earned |
commentNamedEntities - [CommentNamedEntity!]
|
|
reviewedBy - User
|
The user who reviewed this comment |
sparkyConversations - [SparkyConversation!]
|
|
likedUsers - [User!]
|
The users who liked this comment |
commentLikes - [CommentLike!]
|
Example
{
"id": "4",
"body": "abc123",
"reflectionPrompt": "xyz789",
"namedEntities": [NamedEntity],
"sentiment": Sentiment,
"totalLikes": 987,
"createdAt": "10:15:30Z",
"reflectionAnalysisResults": ReflectionResult,
"updatedAt": "10:15:30Z",
"shouldEarnCredits": true,
"didEarnCredits": false,
"creditWasApproved": true,
"author": User,
"post": Post,
"parent": Comment,
"replies": [Comment],
"educationCredit": EducationCredit,
"commentNamedEntities": [CommentNamedEntity],
"reviewedBy": User,
"sparkyConversations": [SparkyConversation],
"likedUsers": [User],
"commentLikes": [CommentLike]
}
Notifications
Queries
notifications
Response
Returns a NotificationConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - NotificationOrder
|
Ordering options for Notifications returned from the connection. |
where - NotificationWhereInput
|
Filtering options for Notifications returned from the connection. |
Example
Query
query notifications(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: NotificationOrder,
$where: NotificationWhereInput
) {
notifications(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...NotificationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": NotificationOrder,
"where": NotificationWhereInput
}
Response
{
"data": {
"notifications": {
"edges": [NotificationEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
Mutations
registerNotificationToken
Description
Registers a device token for push notifications for the current user
Example
Query
mutation registerNotificationToken(
$token: String!,
$platform: String!
) {
registerNotificationToken(
token: $token,
platform: $platform
)
}
Variables
{
"token": "xyz789",
"platform": "xyz789"
}
Response
{"data": {"registerNotificationToken": {}}}
unregisterNotificationToken
Description
Unregisters a device token for push notifications for the current user
Example
Query
mutation unregisterNotificationToken(
$token: String!,
$platform: String!
) {
unregisterNotificationToken(
token: $token,
platform: $platform
)
}
Variables
{
"token": "abc123",
"platform": "abc123"
}
Response
{"data": {"unregisterNotificationToken": {}}}
markNotificationsAsRead
Description
Marks a Notification as read, for the current user
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - MarkNotificationsAsRead!
|
Example
Query
mutation markNotificationsAsRead($input: MarkNotificationsAsRead!) {
markNotificationsAsRead(input: $input)
}
Variables
{"input": MarkNotificationsAsRead}
Response
{"data": {"markNotificationsAsRead": {}}}
Types
Notification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
notificationType - NotificationNotificationType!
|
The type of notification. |
resourceType - String!
|
The type of resource that the notification is for. |
resourceID - String!
|
The ID of the resource that the notification is for. |
message - String!
|
(DEPRECATED - Use body instead) The message of the notification. |
body - String!
|
The body of the notification. This is the fully rendered message minus the user's name ie. liked your post "Test Post" or reflected on your post "Test Post" |
readAt - Time
|
The time that the notification was read. |
createdAt - Time!
|
|
pushSentAt - Time
|
|
user - User
|
The user that the notification is for. |
from - User
|
The user that sent the notification. |
Example
{
"id": 4,
"notificationType": "like",
"resourceType": "abc123",
"resourceID": "abc123",
"message": "abc123",
"body": "xyz789",
"readAt": "10:15:30Z",
"createdAt": "10:15:30Z",
"pushSentAt": "10:15:30Z",
"user": User,
"from": User
}
Signup
Queries
searchRegistry
Description
Search the NPI registry for a provider by name or number
Response
Returns [RegistryResult!]
Example
Query
query searchRegistry(
$number: String,
$firstName: String,
$lastName: String,
$state: String
) {
searchRegistry(
number: $number,
firstName: $firstName,
lastName: $lastName,
state: $state
) {
number
firstName
lastName
address
zip
state
credential
taxonomyCode
taxonomyDesc
claimed
}
}
Variables
{
"number": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"state": "xyz789"
}
Response
{
"data": {
"searchRegistry": [
{
"number": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"address": "abc123",
"zip": "abc123",
"state": "abc123",
"credential": "xyz789",
"taxonomyCode": "abc123",
"taxonomyDesc": "abc123",
"claimed": false
}
]
}
}
suggestHandle
Description
Suggest a unique handle for a user based on their name and credential
Response
Returns a String!
Example
Query
query suggestHandle(
$firstName: String!,
$lastName: String!,
$credential: String!
) {
suggestHandle(
firstName: $firstName,
lastName: $lastName,
credential: $credential
)
}
Variables
{
"firstName": "abc123",
"lastName": "xyz789",
"credential": "xyz789"
}
Response
{"data": {"suggestHandle": {}}}
validateHandle
Description
Validate a handle for uniqueness
validateEmail
Description
Validate an email for uniqueness
validatePhone
Description
Validate a phone number for uniqueness
Mutations
signup
Description
Creates a new user with the User role
Response
Returns a LoginResponse
Arguments
| Name | Description |
|---|---|
input - SignupInput!
|
Example
Query
mutation signup($input: SignupInput!) {
signup(input: $input) {
token
expiresAt
user {
...UserFragment
}
}
}
Variables
{"input": SignupInput}
Response
{
"data": {
"signup": {
"token": "abc123",
"expiresAt": "10:15:30Z",
"user": User
}
}
}
sendPhoneOTP
Description
Sends a phone OTP to the given phone number. Exchange the OTP for a JWT auth token
Login
Mutations
sendPhoneOTP
Description
Sends a phone OTP to the given phone number. Exchange the OTP for a JWT auth token
verifyPhoneOTP
Description
Verify's the phone number and OTP match
Response
Returns a PhoneVerificationResponse!
Example
Query
mutation verifyPhoneOTP(
$phone: String!,
$otp: String!
) {
verifyPhoneOTP(
phone: $phone,
otp: $otp
) {
token
}
}
Variables
{
"phone": "abc123",
"otp": "abc123"
}
Response
{
"data": {
"verifyPhoneOTP": {"token": "xyz789"}
}
}
User
Queries
user
Description
Returns a user by ID
Example
Query
query user($id: ID!) {
user(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"user": {
"id": "4",
"firstName": "abc123",
"lastName": "abc123",
"disabled": false,
"status": "active",
"phone": "xyz789",
"email": "abc123",
"username": "abc123",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "abc123",
"npiTaxonomyDescription": "abc123",
"bio": "abc123",
"isStudent": true,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": false,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "abc123",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
currentUser
Description
The currently authenticated user
Response
Returns a User!
Example
Query
query currentUser {
currentUser {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Response
{
"data": {
"currentUser": {
"id": "4",
"firstName": "abc123",
"lastName": "xyz789",
"disabled": false,
"status": "active",
"phone": "abc123",
"email": "xyz789",
"username": "xyz789",
"credential": "xyz789",
"npiNumber": "abc123",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": true,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": false,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "abc123",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
friends
Response
Returns [User!]!
Example
Query
query friends {
friends {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Response
{
"data": {
"friends": [
{
"id": 4,
"firstName": "abc123",
"lastName": "xyz789",
"disabled": true,
"status": "active",
"phone": "xyz789",
"email": "xyz789",
"username": "xyz789",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "xyz789",
"isStudent": false,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": true,
"totalFollowers": 123,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "abc123",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
]
}
}
Mutations
followUser
Description
Follows a user
Example
Query
mutation followUser($id: ID!) {
followUser(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"followUser": {
"id": "4",
"firstName": "xyz789",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "xyz789",
"email": "xyz789",
"username": "xyz789",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "abc123",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": true,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": false,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "abc123",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
unfollowUser
Description
Unfollows a user
updateProfile
Description
Updates the profile for the current user
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Example
Query
mutation updateProfile($input: UpdateUserInput!) {
updateProfile(input: $input) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateProfile": {
"id": 4,
"firstName": "xyz789",
"lastName": "xyz789",
"disabled": false,
"status": "active",
"phone": "xyz789",
"email": "xyz789",
"username": "xyz789",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "abc123",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": false,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": false,
"financialDisclosures": "abc123",
"isStaff": false,
"totalFollowers": 987,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
Types
User
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
firstName - String
|
The first name of the user |
lastName - String
|
The last name of the user |
disabled - Boolean!
|
(Deprecated, use status instead) Whether the user is disabled |
status - UserStatus!
|
The status of the user |
phone - String
|
The phone number of the user, stored in E.164 format |
email - String
|
The email address of the user |
username - String
|
The username of the user |
credential - String
|
The credential of the user, ie MD, DO, PA, NP, etc. Note: Credentials are normalized to uppercase and any periods are removed. |
npiNumber - String
|
The NPI number of the user |
npiTaxonomyCode - String
|
The NPI taxonomy code of the user |
npiTaxonomyDescription - String
|
The NPI taxonomy description of the user |
bio - String
|
The bio of the user |
isStudent - Boolean!
|
Whether the user is a student |
hasSubmittedDisclosure - Boolean!
|
Whether the user has submitted a disclosure |
hasDisclosuresNeedingReview - Boolean!
|
Whether the user has disclosures needing review |
reflectionsOnAuthoredPostsDisabled - Boolean!
|
Whether reflections are disabled on posts authored by this user |
role - UserRole!
|
The role of the user |
limitedRoles - [String!]
|
The limited roles of the user. Null or Empty array means no limited roles. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
lastLoginAt - Time
|
The last time the user logged in |
cmeGoalValue - String
|
The CME goal value of the user |
cmeGoalDate - Time
|
The CME goal date of the user |
totalCmeEarned - Float
|
The total CME earned by the user |
suggested - Boolean!
|
Whether the user has should appear in the suggested users list |
financialDisclosures - String
|
The financial disclosures for the user |
isStaff - Boolean!
|
Whether the user is an oog staff user |
totalFollowers - Int!
|
The total number of followers the user has |
totalFollowing - Int!
|
The total number of users the user is following |
tenants - [Tenant!]
|
The tenants the user belongs to |
topics - [Topic!]
|
The topics the user follows |
followers - [User!]
|
The users that follow this user |
following - [User!]
|
|
posts - [Post!]
|
The posts the user has made |
links - [UserLink!]
|
The links the user has added |
offices - [Office!]
|
The providers offices |
comments - [Comment!]
|
The comments the user has made |
likedPosts - [Post!]
|
The posts the user has liked |
likedComments - [Comment!]
|
The comments the user has liked |
bookmarkedPosts - [Post!]
|
The posts the user has bookmarked |
avatar - MediaItem
|
(DEPRECATED) The avatar of the user |
profileImage - Image
|
The profile image for the user. Images are hosted using Cloudflare images. Please see https://developers.cloudflare.com/images/cloudflare-images/serve-images/ for details on how to serve images. |
specialty - NpiTaxonomy
|
The NPI taxonomy of the user |
workHistory - [WorkExperience!]
|
The work history of the user |
educationHistory - [EducationHistory!]
|
The education history of the user |
licenseHistory - [LicenseHistory!]
|
The license history of the user |
educationCredits - [EducationCredit!]
|
The education credits of the user |
notificationTokens - [UserNotificationToken!]
|
The notification tokens for the user |
notifications - [Notification!]
|
The notifications for the user: Likes, Comments, etc. |
outgoingNotifications - [Notification!]
|
The notifications the user has generated for other users |
searches - [Search!]
|
The searches the user has made |
apiTokens - [ApiToken!]
|
The API tokens the user has generated |
userCompletions - [UserCollectionCompletion!]
|
The user collection completions |
financialDisclosureStatement - FinancialDisclosureStatement
|
The financial disclosures for the user |
coursesCreated - [Course!]
|
The courses the user has created |
coursesReviewed - [Course!]
|
The courses the user has reviewed |
coursesFaculty - [Course!]
|
The courses the user is faculty for |
userReports - [UserReport!]
|
The user reports this user has created |
reportedBy - [UserReport!]
|
The user reports this user has been reported by |
postReports - [PostReport!]
|
The post reports this user has created |
mutedUsers - [UserMute!]
|
The users this user has muted |
blockedUsers - [UserBlock!]
|
The users this user has blocked |
accountConnections - [AccountConnection!]
|
3rd party account connections |
importedVideos - [ImportedVideo!]
|
The imported videos for the user |
userTenants - [UserTenant!]
|
|
likes - [Like!]
|
|
commentLikes - [CommentLike!]
|
|
bookmarks - [Bookmark!]
|
|
streamToken - String!
|
The Stream (getstream.io) chat token for the current user |
currentTenant - Tenant
|
|
npiTaxonomy - NpiTaxonomy
|
Example
{
"id": 4,
"firstName": "xyz789",
"lastName": "xyz789",
"disabled": true,
"status": "active",
"phone": "xyz789",
"email": "xyz789",
"username": "abc123",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "abc123",
"bio": "xyz789",
"isStudent": false,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": false,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "abc123",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
Links
Queries
createUserLink
Description
Creates a new link for the current users bio
Response
Returns a UserLink!
Arguments
| Name | Description |
|---|---|
input - CreateUserLinkInput!
|
Example
Query
query createUserLink($input: CreateUserLinkInput!) {
createUserLink(input: $input) {
id
title
url
ordinal
user {
...UserFragment
}
}
}
Variables
{"input": CreateUserLinkInput}
Response
{
"data": {
"createUserLink": {
"id": 4,
"title": "xyz789",
"url": "abc123",
"ordinal": 123,
"user": User
}
}
}
updateUserLink
Description
Updates a link for the current users bio
Response
Returns a UserLink!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateUserLinkInput!
|
Example
Query
query updateUserLink(
$id: ID!,
$input: UpdateUserLinkInput!
) {
updateUserLink(
id: $id,
input: $input
) {
id
title
url
ordinal
user {
...UserFragment
}
}
}
Variables
{"id": 4, "input": UpdateUserLinkInput}
Response
{
"data": {
"updateUserLink": {
"id": "4",
"title": "abc123",
"url": "abc123",
"ordinal": 987,
"user": User
}
}
}
deleteUserLink
Description
Deletes a link for the current users bio
Example
Query
query deleteUserLink($id: ID!) {
deleteUserLink(id: $id) {
id
title
url
ordinal
user {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteUserLink": {
"id": 4,
"title": "xyz789",
"url": "abc123",
"ordinal": 987,
"user": User
}
}
}
Types
UserLink
Work Experience
Queries
createWorkExperience
Description
Creates a new WorkExperience entry for the current user
Response
Returns a WorkExperience!
Arguments
| Name | Description |
|---|---|
input - CreateWorkExperienceInput!
|
Example
Query
query createWorkExperience($input: CreateWorkExperienceInput!) {
createWorkExperience(input: $input) {
id
institution
specialty
title
employment
startDate
endDate
city
state
user {
...UserFragment
}
}
}
Variables
{"input": CreateWorkExperienceInput}
Response
{
"data": {
"createWorkExperience": {
"id": 4,
"institution": "xyz789",
"specialty": "xyz789",
"title": "xyz789",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "abc123",
"state": "abc123",
"user": User
}
}
}
updateWorkExperience
Description
Updates a WorkExperience entry for the current user
Response
Returns a WorkExperience!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateWorkExperienceInput!
|
Example
Query
query updateWorkExperience(
$id: ID!,
$input: UpdateWorkExperienceInput!
) {
updateWorkExperience(
id: $id,
input: $input
) {
id
institution
specialty
title
employment
startDate
endDate
city
state
user {
...UserFragment
}
}
}
Variables
{"id": 4, "input": UpdateWorkExperienceInput}
Response
{
"data": {
"updateWorkExperience": {
"id": 4,
"institution": "xyz789",
"specialty": "xyz789",
"title": "abc123",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "abc123",
"state": "xyz789",
"user": User
}
}
}
deleteWorkExperience
Description
Deletes a WorkExperience entry for the current user
Response
Returns a WorkExperience!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query deleteWorkExperience($id: ID!) {
deleteWorkExperience(id: $id) {
id
institution
specialty
title
employment
startDate
endDate
city
state
user {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteWorkExperience": {
"id": "4",
"institution": "abc123",
"specialty": "abc123",
"title": "xyz789",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "abc123",
"state": "xyz789",
"user": User
}
}
}
Types
WorkExperience
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
institution - String!
|
The institution of the work experience. |
specialty - String!
|
The specialty of the work experience. |
title - String!
|
The title of the work experience. |
employment - WorkExperienceEmployment!
|
The employment type of the work experience. |
startDate - Time
|
The start date of the work experience. |
endDate - Time
|
The end date of the work experience. |
city - String!
|
The city of the work experience. |
state - String!
|
The state of the work experience. |
user - User
|
The user that the work experience is for. |
Example
{
"id": 4,
"institution": "abc123",
"specialty": "xyz789",
"title": "xyz789",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "abc123",
"state": "xyz789",
"user": User
}
Education
Queries
educationCredits
Response
Returns an EducationCreditConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - EducationCreditOrder
|
Ordering options for EducationCredits returned from the connection. |
where - EducationCreditWhereInput
|
Filtering options for EducationCredits returned from the connection. |
Example
Query
query educationCredits(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: EducationCreditOrder,
$where: EducationCreditWhereInput
) {
educationCredits(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...EducationCreditEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": EducationCreditOrder,
"where": EducationCreditWhereInput
}
Response
{
"data": {
"educationCredits": {
"edges": [EducationCreditEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
generateReflectionPrompts
Description
Generates a reflective prompt for a specified post
Response
Returns [ReflectionPrompt!]!
Example
Query
query generateReflectionPrompts(
$id: ID!,
$learningObjective: String
) {
generateReflectionPrompts(
id: $id,
learningObjective: $learningObjective
) {
text
}
}
Variables
{"id": 4, "learningObjective": "xyz789"}
Response
{
"data": {
"generateReflectionPrompts": [
{"text": "xyz789"}
]
}
}
Types
EducationCredit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
value - Float!
|
The value of the credit. |
deletedAt - Time
|
The time that the credit was deleted. |
redeemedAt - Time
|
The time that the credit was redeemed. |
deletedReason - String
|
The reason that the credit was deleted. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
survey - Map
|
The survey for the credit. |
userID - ID!
|
|
sparkyConversationID - ID
|
|
postID - ID
|
|
commentID - ID
|
|
type - EducationCreditType!
|
The type of the credit. |
tenant - Tenant
|
The tenant that the topic belongs to. |
user - User!
|
The user that created/earned the credit. |
comment - Comment
|
The comment that the credit was created on. |
post - Post
|
The post that the credit was created on. |
sparkyConversation - SparkyConversation
|
|
learningObjective - LearningObjective
|
The learning objective that the credit was for. |
deletedBy - User
|
The user that deleted the credit. |
userCollectionCompletions - [UserCollectionCompletion!]
|
The collections the user redeemed for this credit |
certificate - Certificate
|
The certificate that the credit was redeemed for. |
Example
{
"id": 4,
"value": 123.45,
"deletedAt": "10:15:30Z",
"redeemedAt": "10:15:30Z",
"deletedReason": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"survey": Map,
"userID": 4,
"sparkyConversationID": "4",
"postID": "4",
"commentID": "4",
"type": "reflection",
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"sparkyConversation": SparkyConversation,
"learningObjective": LearningObjective,
"deletedBy": User,
"userCollectionCompletions": [UserCollectionCompletion],
"certificate": Certificate
}
Media
Queries
generateVideoUploadURL
Description
Generates a URL that can be used to upload a video to Cloudflare (https://developers.cloudflare.com/stream/uploading-videos/direct-creator-uploads#basic-upload-flow-for-small-videos) Also returns a draft Video object with a status of "waiting". After the video has been uploaded and ready to stream, the status will change to "ready".
Response
Returns a VideoUploadResponse!
Example
Query
query generateVideoUploadURL {
generateVideoUploadURL {
url
video {
...VideoFragment
}
}
}
Response
{
"data": {
"generateVideoUploadURL": {
"url": "abc123",
"video": Video
}
}
}
createVideoEvent
Description
Send START and END events for tracking video completions to earn CE credits.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
videoId - ID!
|
|
type - VideoEventType!
|
Example
Query
query createVideoEvent(
$videoId: ID!,
$type: VideoEventType!
) {
createVideoEvent(
videoId: $videoId,
type: $type
)
}
Variables
{"videoId": 4, "type": "PLAY"}
Response
{"data": {"createVideoEvent": {}}}
accountConnections
Response
Returns an AccountConnectionConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - AccountConnectionOrder
|
Ordering options for AccountConnections returned from the connection. |
where - AccountConnectionWhereInput
|
Filtering options for AccountConnections returned from the connection. |
Example
Query
query accountConnections(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: AccountConnectionOrder,
$where: AccountConnectionWhereInput
) {
accountConnections(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...AccountConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": AccountConnectionOrder,
"where": AccountConnectionWhereInput
}
Response
{
"data": {
"accountConnections": {
"edges": [AccountConnectionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
adminActiveUsers
Response
Returns a TableData!
Example
Query
query adminActiveUsers(
$startDate: Time,
$endDate: Time
) {
adminActiveUsers(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminActiveUsers": {
"columns": [TableDataColumn],
"rowData": ["abc123"],
"sortField": "abc123",
"sortDirection": "xyz789"
}
}
}
adminActivityLogSummary
Response
Returns a TableData!
Arguments
| Name | Description |
|---|---|
where - ApiQueryLogWhereInput
|
Example
Query
query adminActivityLogSummary($where: ApiQueryLogWhereInput) {
adminActivityLogSummary(where: $where) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{"where": ApiQueryLogWhereInput}
Response
{
"data": {
"adminActivityLogSummary": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "xyz789",
"sortDirection": "xyz789"
}
}
}
adminFinancialDisclosurePrintTemplate
Response
Returns a FinancialDisclosurePrintTemplate!
Example
Query
query adminFinancialDisclosurePrintTemplate {
adminFinancialDisclosurePrintTemplate {
id
template
createdAt
updatedAt
}
}
Response
{
"data": {
"adminFinancialDisclosurePrintTemplate": {
"id": "4",
"template": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
adminGetNotificationConfig
Response
Returns a NotificationConfig!
Example
Query
query adminGetNotificationConfig {
adminGetNotificationConfig {
id
followUserMessage
likedPostMessage
reflectedPostMessage
reflectionApproved
createdAt
updatedAt
}
}
Response
{
"data": {
"adminGetNotificationConfig": {
"id": "4",
"followUserMessage": "xyz789",
"likedPostMessage": "abc123",
"reflectedPostMessage": "abc123",
"reflectionApproved": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
adminMostViewedPosts
Response
Returns a TableData!
Example
Query
query adminMostViewedPosts(
$startDate: Time,
$endDate: Time
) {
adminMostViewedPosts(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminMostViewedPosts": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "xyz789",
"sortDirection": "xyz789"
}
}
}
adminMostViewedUsers
Response
Returns a TableData!
Example
Query
query adminMostViewedUsers(
$startDate: Time,
$endDate: Time
) {
adminMostViewedUsers(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminMostViewedUsers": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "xyz789",
"sortDirection": "xyz789"
}
}
}
adminReflectionsByUser
Response
Returns a TableData!
Example
Query
query adminReflectionsByUser(
$startDate: Time,
$endDate: Time
) {
adminReflectionsByUser(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminReflectionsByUser": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "abc123",
"sortDirection": "abc123"
}
}
}
adminReflectionsOverTime
Response
Returns a TableSeries!
Example
Query
query adminReflectionsOverTime(
$startDate: Time,
$endDate: Time
) {
adminReflectionsOverTime(
startDate: $startDate,
endDate: $endDate
) {
series {
...TableSeriesItemFragment
}
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminReflectionsOverTime": {
"series": [TableSeriesItem]
}
}
}
adminShowDeletedFinancialDisclosures
Response
Returns [FinancialDisclosure!]
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query adminShowDeletedFinancialDisclosures($id: ID!) {
adminShowDeletedFinancialDisclosures(id: $id) {
id
deletedAt
companyName
createdAt
hasEnded
updatedAt
statement {
...FinancialDisclosureStatementFragment
}
role {
...FinancialDisclosureRoleFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"adminShowDeletedFinancialDisclosures": [
{
"id": 4,
"deletedAt": "10:15:30Z",
"companyName": "abc123",
"createdAt": "10:15:30Z",
"hasEnded": true,
"updatedAt": "10:15:30Z",
"statement": FinancialDisclosureStatement,
"role": FinancialDisclosureRole
}
]
}
}
adminTopUsersByTotalPosts
Response
Returns a TableData!
Example
Query
query adminTopUsersByTotalPosts(
$startDate: Time,
$endDate: Time
) {
adminTopUsersByTotalPosts(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminTopUsersByTotalPosts": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "xyz789",
"sortDirection": "abc123"
}
}
}
adminTotalSearchesOverTime
Response
Returns a TableData!
Example
Query
query adminTotalSearchesOverTime(
$startDate: Time,
$endDate: Time
) {
adminTotalSearchesOverTime(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminTotalSearchesOverTime": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "xyz789",
"sortDirection": "abc123"
}
}
}
adminTrendingTopics
Response
Returns a TableData!
Example
Query
query adminTrendingTopics(
$startDate: Time,
$endDate: Time
) {
adminTrendingTopics(
startDate: $startDate,
endDate: $endDate
) {
columns {
...TableDataColumnFragment
}
rowData
sortField
sortDirection
}
}
Variables
{
"startDate": "10:15:30Z",
"endDate": "10:15:30Z"
}
Response
{
"data": {
"adminTrendingTopics": {
"columns": [TableDataColumn],
"rowData": ["xyz789"],
"sortField": "xyz789",
"sortDirection": "xyz789"
}
}
}
adminVideoCompletions
Response
Returns [AdminVideoCompletion!]!
Example
Query
query adminVideoCompletions(
$userId: ID!,
$videoIds: [ID!]!
) {
adminVideoCompletions(
userId: $userId,
videoIds: $videoIds
) {
id
completedAt
}
}
Variables
{
"userId": "4",
"videoIds": ["4"]
}
Response
{
"data": {
"adminVideoCompletions": [
{"id": 4, "completedAt": "10:15:30Z"}
]
}
}
anatomicalModels
Response
Returns an AnatomicalModelConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - AnatomicalModelWhereInput
|
Filtering options for AnatomicalModels returned from the connection. |
Example
Query
query anatomicalModels(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: AnatomicalModelWhereInput
) {
anatomicalModels(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...AnatomicalModelEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"where": AnatomicalModelWhereInput
}
Response
{
"data": {
"anatomicalModels": {
"edges": [AnatomicalModelEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
apiQueryLogs
Response
Returns an ApiQueryLogConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - ApiQueryLogOrder
|
Ordering options for ApiQueryLogs returned from the connection. |
where - ApiQueryLogWhereInput
|
Filtering options for ApiQueryLogs returned from the connection. |
Example
Query
query apiQueryLogs(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: ApiQueryLogOrder,
$where: ApiQueryLogWhereInput
) {
apiQueryLogs(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...ApiQueryLogEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": ApiQueryLogOrder,
"where": ApiQueryLogWhereInput
}
Response
{
"data": {
"apiQueryLogs": {
"edges": [ApiQueryLogEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
articles
Response
Returns an ArticleConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - ArticleOrder
|
Ordering options for Articles returned from the connection. |
where - ArticleWhereInput
|
Filtering options for Articles returned from the connection. |
Example
Query
query articles(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: ArticleOrder,
$where: ArticleWhereInput
) {
articles(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...ArticleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": ArticleOrder,
"where": ArticleWhereInput
}
Response
{
"data": {
"articles": {
"edges": [ArticleEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
audiences
Response
Returns an AudienceConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - AudienceOrder
|
Ordering options for Audiences returned from the connection. |
where - AudienceWhereInput
|
Filtering options for Audiences returned from the connection. |
Example
Query
query audiences(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: AudienceOrder,
$where: AudienceWhereInput
) {
audiences(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...AudienceEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": AudienceOrder,
"where": AudienceWhereInput
}
Response
{
"data": {
"audiences": {
"edges": [AudienceEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
auditLogs
Response
Returns an AuditLogConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - AuditLogOrder
|
Ordering options for AuditLogs returned from the connection. |
where - AuditLogWhereInput
|
Filtering options for AuditLogs returned from the connection. |
Example
Query
query auditLogs(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: AuditLogOrder,
$where: AuditLogWhereInput
) {
auditLogs(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...AuditLogEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"orderBy": AuditLogOrder,
"where": AuditLogWhereInput
}
Response
{
"data": {
"auditLogs": {
"edges": [AuditLogEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
blockedUsers
Response
Returns a UserConnection!
Example
Query
query blockedUsers(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
blockedUsers(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...UserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"blockedUsers": {
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
bookmarks
Response
Returns a BookmarkConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - BookmarkOrder
|
Ordering options for Bookmarks returned from the connection. |
where - BookmarkWhereInput
|
Filtering options for Bookmarks returned from the connection. |
Example
Query
query bookmarks(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: BookmarkOrder,
$where: BookmarkWhereInput
) {
bookmarks(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...BookmarkEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": BookmarkOrder,
"where": BookmarkWhereInput
}
Response
{
"data": {
"bookmarks": {
"edges": [BookmarkEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
certificateSurveyAnswers
Response
Returns a CertificateSurveyAnswerConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CertificateSurveyAnswerWhereInput
|
Filtering options for CertificateSurveyAnswers returned from the connection. |
Example
Query
query certificateSurveyAnswers(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CertificateSurveyAnswerWhereInput
) {
certificateSurveyAnswers(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CertificateSurveyAnswerEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": CertificateSurveyAnswerWhereInput
}
Response
{
"data": {
"certificateSurveyAnswers": {
"edges": [CertificateSurveyAnswerEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
certificateSurveyQuestionChoices
Response
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CertificateSurveyQuestionChoiceWhereInput
|
Filtering options for CertificateSurveyQuestionChoices returned from the connection. |
Example
Query
query certificateSurveyQuestionChoices(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CertificateSurveyQuestionChoiceWhereInput
) {
certificateSurveyQuestionChoices(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CertificateSurveyQuestionChoiceEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": CertificateSurveyQuestionChoiceWhereInput
}
Response
{
"data": {
"certificateSurveyQuestionChoices": {
"edges": [CertificateSurveyQuestionChoiceEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
certificateSurveyQuestions
Response
Returns a CertificateSurveyQuestionConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CertificateSurveyQuestionWhereInput
|
Filtering options for CertificateSurveyQuestions returned from the connection. |
Example
Query
query certificateSurveyQuestions(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CertificateSurveyQuestionWhereInput
) {
certificateSurveyQuestions(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CertificateSurveyQuestionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"where": CertificateSurveyQuestionWhereInput
}
Response
{
"data": {
"certificateSurveyQuestions": {
"edges": [CertificateSurveyQuestionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
certificates
Response
Returns a CertificateConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CertificateWhereInput
|
Filtering options for Certificates returned from the connection. |
Example
Query
query certificates(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CertificateWhereInput
) {
certificates(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CertificateEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": CertificateWhereInput
}
Response
{
"data": {
"certificates": {
"edges": [CertificateEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
clinicalTrialConditionCounts
Response
Returns [ClinicalTrialConditionCount!]
Example
Query
query clinicalTrialConditionCounts(
$search: String,
$statusIn: [String],
$conditionIn: [String],
$hasSearch: String
) {
clinicalTrialConditionCounts(
search: $search,
statusIn: $statusIn,
conditionIn: $conditionIn,
hasSearch: $hasSearch
) {
name
count
}
}
Variables
{
"search": "abc123",
"statusIn": ["abc123"],
"conditionIn": ["xyz789"],
"hasSearch": "abc123"
}
Response
{
"data": {
"clinicalTrialConditionCounts": [
{"name": "xyz789", "count": 123}
]
}
}
clinicalTrialMapPoints
Response
Returns [ClinicalTrialMapPoint!]
Example
Query
query clinicalTrialMapPoints(
$search: String,
$statusIn: [String],
$conditionIn: [String]
) {
clinicalTrialMapPoints(
search: $search,
statusIn: $statusIn,
conditionIn: $conditionIn
) {
id
lat
lng
}
}
Variables
{
"search": "xyz789",
"statusIn": ["xyz789"],
"conditionIn": ["abc123"]
}
Response
{"data": {"clinicalTrialMapPoints": [{"id": 4, "lat": 123.45, "lng": 123.45}]}}
clinicalTrialStatusCounts
Response
Returns [ClinicalTrialStatusCount!]
Example
Query
query clinicalTrialStatusCounts(
$statusIn: [String],
$conditionIn: [String]
) {
clinicalTrialStatusCounts(
statusIn: $statusIn,
conditionIn: $conditionIn
) {
name
count
}
}
Variables
{
"statusIn": ["xyz789"],
"conditionIn": ["xyz789"]
}
Response
{
"data": {
"clinicalTrialStatusCounts": [
{"name": "abc123", "count": 123}
]
}
}
clinicalTrials
Response
Returns a ClinicalTrialConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - ClinicalTrialOrder
|
Ordering options for ClinicalTrials returned from the connection. |
where - ClinicalTrialWhereInput
|
Filtering options for ClinicalTrials returned from the connection. |
search - String
|
Full text search query. Searches the title, description, and contacts fields. |
conditionIn - [String]
|
Example
Query
query clinicalTrials(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: ClinicalTrialOrder,
$where: ClinicalTrialWhereInput,
$search: String,
$conditionIn: [String]
) {
clinicalTrials(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where,
search: $search,
conditionIn: $conditionIn
) {
edges {
...ClinicalTrialEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": ClinicalTrialOrder,
"where": ClinicalTrialWhereInput,
"search": "xyz789",
"conditionIn": ["abc123"]
}
Response
{
"data": {
"clinicalTrials": {
"edges": [ClinicalTrialEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
collections
Response
Returns a CollectionConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CollectionWhereInput
|
Filtering options for Collections returned from the connection. |
Example
Query
query collections(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CollectionWhereInput
) {
collections(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CollectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"where": CollectionWhereInput
}
Response
{
"data": {
"collections": {
"edges": [CollectionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
commentLikes
Response
Returns a CommentLikeConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - CommentLikeOrder
|
Ordering options for CommentLikes returned from the connection. |
where - CommentLikeWhereInput
|
Filtering options for CommentLikes returned from the connection. |
Example
Query
query commentLikes(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: CommentLikeOrder,
$where: CommentLikeWhereInput
) {
commentLikes(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...CommentLikeEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": CommentLikeOrder,
"where": CommentLikeWhereInput
}
Response
{
"data": {
"commentLikes": {
"edges": [CommentLikeEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
commentNamedEntityStats
Description
** Admin Only ** Returns Yes/No totals for each model prediction
Response
Returns an AdminReflectionStats
Example
Query
query commentNamedEntityStats {
commentNamedEntityStats {
isInquisitive {
...AdminReflectionStatValueFragment
}
isReflective {
...AdminReflectionStatValueFragment
}
isLinguisticallyAcceptable {
...AdminReflectionStatValueFragment
}
isToxic {
...AdminReflectionStatValueFragment
}
containsMedicalTerms {
...AdminReflectionStatValueFragment
}
topEntityGroups {
...NamedEntityStatFragment
}
}
}
Response
{
"data": {
"commentNamedEntityStats": {
"isInquisitive": [AdminReflectionStatValue],
"isReflective": [AdminReflectionStatValue],
"isLinguisticallyAcceptable": [
AdminReflectionStatValue
],
"isToxic": [AdminReflectionStatValue],
"containsMedicalTerms": [AdminReflectionStatValue],
"topEntityGroups": [NamedEntityStat]
}
}
}
comments
Response
Returns a CommentConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - CommentOrder
|
Ordering options for Comments returned from the connection. |
where - CommentWhereInput
|
Filtering options for Comments returned from the connection. |
Example
Query
query comments(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: CommentOrder,
$where: CommentWhereInput
) {
comments(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...CommentEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": CommentOrder,
"where": CommentWhereInput
}
Response
{
"data": {
"comments": {
"edges": [CommentEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
courses
Response
Returns a CourseConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - CourseWhereInput
|
Filtering options for Courses returned from the connection. |
Example
Query
query courses(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: CourseWhereInput
) {
courses(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...CourseEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": CourseWhereInput
}
Response
{
"data": {
"courses": {
"edges": [CourseEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
currentUser
Description
The currently authenticated user
Response
Returns a User!
Example
Query
query currentUser {
currentUser {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Response
{
"data": {
"currentUser": {
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "abc123",
"email": "abc123",
"username": "abc123",
"credential": "abc123",
"npiNumber": "abc123",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "abc123",
"bio": "abc123",
"isStudent": false,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": false,
"totalFollowers": 123,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
dashboards
Response
Returns a DashboardConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - DashboardWhereInput
|
Filtering options for Dashboards returned from the connection. |
Example
Query
query dashboards(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: DashboardWhereInput
) {
dashboards(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...DashboardEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": DashboardWhereInput
}
Response
{
"data": {
"dashboards": {
"edges": [DashboardEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
educationCredits
Response
Returns an EducationCreditConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - EducationCreditOrder
|
Ordering options for EducationCredits returned from the connection. |
where - EducationCreditWhereInput
|
Filtering options for EducationCredits returned from the connection. |
Example
Query
query educationCredits(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: EducationCreditOrder,
$where: EducationCreditWhereInput
) {
educationCredits(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...EducationCreditEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"orderBy": EducationCreditOrder,
"where": EducationCreditWhereInput
}
Response
{
"data": {
"educationCredits": {
"edges": [EducationCreditEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
educationHistories
Response
Returns an EducationHistoryConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - EducationHistoryWhereInput
|
Filtering options for EducationHistories returned from the connection. |
Example
Query
query educationHistories(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: EducationHistoryWhereInput
) {
educationHistories(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...EducationHistoryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": EducationHistoryWhereInput
}
Response
{
"data": {
"educationHistories": {
"edges": [EducationHistoryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
feed
Response
Returns a PostConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - PostOrder
|
Ordering options for Posts returned from the connection. |
where - PostWhereInput
|
Filtering options for Posts returned from the connection. |
Example
Query
query feed(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: PostOrder,
$where: PostWhereInput
) {
feed(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...PostEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": PostOrder,
"where": PostWhereInput
}
Response
{
"data": {
"feed": {
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
feedV2
Response
Returns a FeedConnection!
Example
Query
query feedV2(
$after: String,
$taxonomyCode: String,
$feedType: FeedType
) {
feedV2(
after: $after,
taxonomyCode: $taxonomyCode,
feedType: $feedType
) {
edges {
...PostEdgeFragment
}
pageInfo {
...FeedPageInfoFragment
}
}
}
Variables
{
"after": "xyz789",
"taxonomyCode": "xyz789",
"feedType": "V2"
}
Response
{
"data": {
"feedV2": {
"edges": [PostEdge],
"pageInfo": FeedPageInfo
}
}
}
financialDisclosurePrintTemplates
Response
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - FinancialDisclosurePrintTemplateOrder
|
Ordering options for FinancialDisclosurePrintTemplates returned from the connection. |
where - FinancialDisclosurePrintTemplateWhereInput
|
Filtering options for FinancialDisclosurePrintTemplates returned from the connection. |
Example
Query
query financialDisclosurePrintTemplates(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: FinancialDisclosurePrintTemplateOrder,
$where: FinancialDisclosurePrintTemplateWhereInput
) {
financialDisclosurePrintTemplates(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...FinancialDisclosurePrintTemplateEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": FinancialDisclosurePrintTemplateOrder,
"where": FinancialDisclosurePrintTemplateWhereInput
}
Response
{
"data": {
"financialDisclosurePrintTemplates": {
"edges": [FinancialDisclosurePrintTemplateEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
financialDisclosureRoles
Response
Returns a FinancialDisclosureRoleConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - FinancialDisclosureRoleOrder
|
Ordering options for FinancialDisclosureRoles returned from the connection. |
where - FinancialDisclosureRoleWhereInput
|
Filtering options for FinancialDisclosureRoles returned from the connection. |
Example
Query
query financialDisclosureRoles(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: FinancialDisclosureRoleOrder,
$where: FinancialDisclosureRoleWhereInput
) {
financialDisclosureRoles(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...FinancialDisclosureRoleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": FinancialDisclosureRoleOrder,
"where": FinancialDisclosureRoleWhereInput
}
Response
{
"data": {
"financialDisclosureRoles": {
"edges": [FinancialDisclosureRoleEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
financialDisclosureStatements
Response
Returns a FinancialDisclosureStatementConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - FinancialDisclosureStatementOrder
|
Ordering options for FinancialDisclosureStatements returned from the connection. |
where - FinancialDisclosureStatementWhereInput
|
Filtering options for FinancialDisclosureStatements returned from the connection. |
Example
Query
query financialDisclosureStatements(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: FinancialDisclosureStatementOrder,
$where: FinancialDisclosureStatementWhereInput
) {
financialDisclosureStatements(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...FinancialDisclosureStatementEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": FinancialDisclosureStatementOrder,
"where": FinancialDisclosureStatementWhereInput
}
Response
{
"data": {
"financialDisclosureStatements": {
"edges": [FinancialDisclosureStatementEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
financialDisclosures
Response
Returns a FinancialDisclosureConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - FinancialDisclosureOrder
|
Ordering options for FinancialDisclosures returned from the connection. |
where - FinancialDisclosureWhereInput
|
Filtering options for FinancialDisclosures returned from the connection. |
Example
Query
query financialDisclosures(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: FinancialDisclosureOrder,
$where: FinancialDisclosureWhereInput
) {
financialDisclosures(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...FinancialDisclosureEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": FinancialDisclosureOrder,
"where": FinancialDisclosureWhereInput
}
Response
{
"data": {
"financialDisclosures": {
"edges": [FinancialDisclosureEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
friends
Response
Returns [User!]!
Example
Query
query friends {
friends {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Response
{
"data": {
"friends": [
{
"id": 4,
"firstName": "xyz789",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "abc123",
"email": "xyz789",
"username": "xyz789",
"credential": "xyz789",
"npiNumber": "abc123",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": true,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
]
}
}
generateReflectionPrompts
Description
Generates a reflective prompt for a specified post
Response
Returns [ReflectionPrompt!]!
Example
Query
query generateReflectionPrompts(
$id: ID!,
$learningObjective: String
) {
generateReflectionPrompts(
id: $id,
learningObjective: $learningObjective
) {
text
}
}
Variables
{"id": 4, "learningObjective": "xyz789"}
Response
{
"data": {
"generateReflectionPrompts": [
{"text": "xyz789"}
]
}
}
generateReflectionPromptsFromText
Response
Returns [ReflectionPrompt!]!
Example
Query
query generateReflectionPromptsFromText(
$discussionPoints: String,
$learningObjective: String
) {
generateReflectionPromptsFromText(
discussionPoints: $discussionPoints,
learningObjective: $learningObjective
) {
text
}
}
Variables
{
"discussionPoints": "xyz789",
"learningObjective": "xyz789"
}
Response
{
"data": {
"generateReflectionPromptsFromText": [
{"text": "xyz789"}
]
}
}
googleDriveFiles
Response
Returns a GoogleDriveFileConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - GoogleDriveFileOrder
|
Ordering options for GoogleDriveFiles returned from the connection. |
where - GoogleDriveFileWhereInput
|
Filtering options for GoogleDriveFiles returned from the connection. |
Example
Query
query googleDriveFiles(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: GoogleDriveFileOrder,
$where: GoogleDriveFileWhereInput
) {
googleDriveFiles(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...GoogleDriveFileEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": GoogleDriveFileOrder,
"where": GoogleDriveFileWhereInput
}
Response
{
"data": {
"googleDriveFiles": {
"edges": [GoogleDriveFileEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
importedVideos
Response
Returns an ImportedVideoConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - ImportedVideoOrder
|
Ordering options for ImportedVideos returned from the connection. |
where - ImportedVideoWhereInput
|
Filtering options for ImportedVideos returned from the connection. |
Example
Query
query importedVideos(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: ImportedVideoOrder,
$where: ImportedVideoWhereInput
) {
importedVideos(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...ImportedVideoEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": ImportedVideoOrder,
"where": ImportedVideoWhereInput
}
Response
{
"data": {
"importedVideos": {
"edges": [ImportedVideoEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
jobHistories
Response
Returns a JobHistoryConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - JobHistoryWhereInput
|
Filtering options for JobHistories returned from the connection. |
Example
Query
query jobHistories(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: JobHistoryWhereInput
) {
jobHistories(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...JobHistoryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"where": JobHistoryWhereInput
}
Response
{
"data": {
"jobHistories": {
"edges": [JobHistoryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
learningObjectives
Response
Returns a LearningObjectiveConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - LearningObjectiveWhereInput
|
Filtering options for LearningObjectives returned from the connection. |
Example
Query
query learningObjectives(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: LearningObjectiveWhereInput
) {
learningObjectives(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...LearningObjectiveEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"where": LearningObjectiveWhereInput
}
Response
{
"data": {
"learningObjectives": {
"edges": [LearningObjectiveEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
licenseHistories
Response
Returns a LicenseHistoryConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - LicenseHistoryWhereInput
|
Filtering options for LicenseHistories returned from the connection. |
Example
Query
query licenseHistories(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: LicenseHistoryWhereInput
) {
licenseHistories(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...LicenseHistoryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": LicenseHistoryWhereInput
}
Response
{
"data": {
"licenseHistories": {
"edges": [LicenseHistoryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
likes
Response
Returns a LikeConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - LikeOrder
|
Ordering options for Likes returned from the connection. |
where - LikeWhereInput
|
Filtering options for Likes returned from the connection. |
Example
Query
query likes(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: LikeOrder,
$where: LikeWhereInput
) {
likes(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...LikeEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": LikeOrder,
"where": LikeWhereInput
}
Response
{
"data": {
"likes": {
"edges": [LikeEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
mediaItems
Response
Returns a MediaItemConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - MediaItemWhereInput
|
Filtering options for MediaItems returned from the connection. |
Example
Query
query mediaItems(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: MediaItemWhereInput
) {
mediaItems(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...MediaItemEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": MediaItemWhereInput
}
Response
{
"data": {
"mediaItems": {
"edges": [MediaItemEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
medicalDictionaryDefinition
Response
Returns a MedicalDictionaryDefinition!
Arguments
| Name | Description |
|---|---|
word - String!
|
Example
Query
query medicalDictionaryDefinition($word: String!) {
medicalDictionaryDefinition(word: $word) {
word
source
definition
}
}
Variables
{"word": "xyz789"}
Response
{
"data": {
"medicalDictionaryDefinition": {
"word": "abc123",
"source": "abc123",
"definition": "xyz789"
}
}
}
medicalDictionarySearch
Response
Arguments
| Name | Description |
|---|---|
word - String!
|
Example
Query
query medicalDictionarySearch($word: String!) {
medicalDictionarySearch(word: $word) {
word
source
}
}
Variables
{"word": "abc123"}
Response
{
"data": {
"medicalDictionarySearch": [
{
"word": "xyz789",
"source": "xyz789"
}
]
}
}
mutedUsers
Response
Returns a UserConnection!
Example
Query
query mutedUsers(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
mutedUsers(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...UserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"mutedUsers": {
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
node
Description
Fetches an object given its ID.
nodes
Description
Lookup nodes by a list of IDs.
notificationConfigs
Response
Returns a NotificationConfigConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - NotificationConfigOrder
|
Ordering options for NotificationConfigs returned from the connection. |
where - NotificationConfigWhereInput
|
Filtering options for NotificationConfigs returned from the connection. |
Example
Query
query notificationConfigs(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: NotificationConfigOrder,
$where: NotificationConfigWhereInput
) {
notificationConfigs(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...NotificationConfigEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"orderBy": NotificationConfigOrder,
"where": NotificationConfigWhereInput
}
Response
{
"data": {
"notificationConfigs": {
"edges": [NotificationConfigEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
notifications
Response
Returns a NotificationConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - NotificationOrder
|
Ordering options for Notifications returned from the connection. |
where - NotificationWhereInput
|
Filtering options for Notifications returned from the connection. |
Example
Query
query notifications(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: NotificationOrder,
$where: NotificationWhereInput
) {
notifications(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...NotificationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": NotificationOrder,
"where": NotificationWhereInput
}
Response
{
"data": {
"notifications": {
"edges": [NotificationEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
npiTaxonomies
Response
Returns a NpiTaxonomyConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - NpiTaxonomyOrder
|
Ordering options for NpiTaxonomies returned from the connection. |
where - NpiTaxonomyWhereInput
|
Filtering options for NpiTaxonomies returned from the connection. |
Example
Query
query npiTaxonomies(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: NpiTaxonomyOrder,
$where: NpiTaxonomyWhereInput
) {
npiTaxonomies(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...NpiTaxonomyEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": NpiTaxonomyOrder,
"where": NpiTaxonomyWhereInput
}
Response
{
"data": {
"npiTaxonomies": {
"edges": [NpiTaxonomyEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
offices
Response
Returns an OfficeConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - OfficeWhereInput
|
Filtering options for Offices returned from the connection. |
Example
Query
query offices(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: OfficeWhereInput
) {
offices(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...OfficeEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": OfficeWhereInput
}
Response
{
"data": {
"offices": {
"edges": [OfficeEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
phoneVerificationTokens
Response
Returns a PhoneVerificationTokenConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - PhoneVerificationTokenOrder
|
Ordering options for PhoneVerificationTokens returned from the connection. |
where - PhoneVerificationTokenWhereInput
|
Filtering options for PhoneVerificationTokens returned from the connection. |
Example
Query
query phoneVerificationTokens(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: PhoneVerificationTokenOrder,
$where: PhoneVerificationTokenWhereInput
) {
phoneVerificationTokens(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...PhoneVerificationTokenEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": PhoneVerificationTokenOrder,
"where": PhoneVerificationTokenWhereInput
}
Response
{
"data": {
"phoneVerificationTokens": {
"edges": [PhoneVerificationTokenEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
ping
Response
Returns a String!
Example
Query
query ping {
ping
}
Response
{"data": {"ping": {}}}
pollForSparkyResponse
Response
Returns a SparkyQuery!
Arguments
| Name | Description |
|---|---|
queryId - ID!
|
Example
Query
query pollForSparkyResponse($queryId: ID!) {
pollForSparkyResponse(queryId: $queryId) {
id
query
stepBackPrompt
stepBackResponse
hydePrompt
hydeResponse
step
candidateIds
rankedCandidateIds
prompt
tokens
draftResponse
finalResponse
createdAt
updatedAt
completedAt
user {
...UserFragment
}
references {
...PubmedArticleFragment
}
}
}
Variables
{"queryId": "4"}
Response
{
"data": {
"pollForSparkyResponse": {
"id": 4,
"query": "abc123",
"stepBackPrompt": "abc123",
"stepBackResponse": "xyz789",
"hydePrompt": "xyz789",
"hydeResponse": "abc123",
"step": "query",
"candidateIds": ["abc123"],
"rankedCandidateIds": ["xyz789"],
"prompt": "xyz789",
"tokens": 987,
"draftResponse": "xyz789",
"finalResponse": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"completedAt": "10:15:30Z",
"user": User,
"references": [PubmedArticle]
}
}
}
popularVideos
Description
List of popular videos
Response
Returns a PostConnection
Example
Query
query popularVideos(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
popularVideos(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...PostEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"popularVideos": {
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
post
Example
Query
query post($id: ID!) {
post(id: $id) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"post": {
"id": 4,
"title": "xyz789",
"suggestedTitle": "abc123",
"creditHours": 123.45,
"status": "draft",
"body": "xyz789",
"suggestedBody": "abc123",
"totalVideos": 987,
"totalImages": 123,
"totalDuration": 987,
"totalLikes": 987,
"totalComments": 987,
"totalReactions": 123,
"totalBookmarks": 987,
"speakMediaID": "abc123",
"featured": true,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 123,
"termsPerMinute": 123.45,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
postReports
Response
Returns a PostReportConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - PostReportOrder
|
Ordering options for PostReports returned from the connection. |
where - PostReportWhereInput
|
Filtering options for PostReports returned from the connection. |
Example
Query
query postReports(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: PostReportOrder,
$where: PostReportWhereInput
) {
postReports(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...PostReportEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": PostReportOrder,
"where": PostReportWhereInput
}
Response
{
"data": {
"postReports": {
"edges": [PostReportEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
posts
Response
Returns a PostConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - PostOrder
|
Ordering options for Posts returned from the connection. |
where - PostWhereInput
|
Filtering options for Posts returned from the connection. |
search - String
|
The search term to filter posts by. Using this argument will:
|
Example
Query
query posts(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: PostOrder,
$where: PostWhereInput,
$search: String
) {
posts(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where,
search: $search
) {
edges {
...PostEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": PostOrder,
"where": PostWhereInput,
"search": "abc123"
}
Response
{
"data": {
"posts": {
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
pubmedArticleCountDates
Response
Returns [PubmedArticleCountDate]
Example
Query
query pubmedArticleCountDates {
pubmedArticleCountDates {
date
count
}
}
Response
{
"data": {
"pubmedArticleCountDates": [
{"date": "10:15:30Z", "count": 123}
]
}
}
pubmedArticles
Response
Returns a PubmedArticleConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - PubmedArticleOrder
|
Ordering options for PubmedArticles returned from the connection. |
where - PubmedArticleWhereInput
|
Filtering options for PubmedArticles returned from the connection. |
Example
Query
query pubmedArticles(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: PubmedArticleOrder,
$where: PubmedArticleWhereInput
) {
pubmedArticles(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...PubmedArticleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": PubmedArticleOrder,
"where": PubmedArticleWhereInput
}
Response
{
"data": {
"pubmedArticles": {
"edges": [PubmedArticleEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
pubmedSummaries
Response
Returns a PubmedArticleConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query pubmedSummaries(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
pubmedSummaries(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...PubmedArticleEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"pubmedSummaries": {
"edges": [PubmedArticleEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
pubmedTopicClusterCountDates
Response
Returns [PubmedClusterCountDate]
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query pubmedTopicClusterCountDates($id: ID!) {
pubmedTopicClusterCountDates(id: $id) {
id
name
clusterLabel
date
count
}
}
Variables
{"id": "4"}
Response
{
"data": {
"pubmedTopicClusterCountDates": [
{
"id": "4",
"name": "abc123",
"clusterLabel": "abc123",
"date": "10:15:30Z",
"count": 987
}
]
}
}
pubmedTopicClusterCounts
Response
Returns [PubmedClusterCount]
Example
Query
query pubmedTopicClusterCounts {
pubmedTopicClusterCounts {
id
name
clusterLabel
count
}
}
Response
{
"data": {
"pubmedTopicClusterCounts": [
{
"id": "4",
"name": "abc123",
"clusterLabel": "xyz789",
"count": 987
}
]
}
}
pubmedTopicClusters
Response
Returns a PubmedTopicClusterConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - PubmedTopicClusterWhereInput
|
Filtering options for PubmedTopicClusters returned from the connection. |
Example
Query
query pubmedTopicClusters(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: PubmedTopicClusterWhereInput
) {
pubmedTopicClusters(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...PubmedTopicClusterEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": PubmedTopicClusterWhereInput
}
Response
{
"data": {
"pubmedTopicClusters": {
"edges": [PubmedTopicClusterEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
relationship
Response
Returns a UserRelationship!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query relationship($id: ID!) {
relationship(id: $id) {
follower
following
}
}
Variables
{"id": "4"}
Response
{"data": {"relationship": {"follower": false, "following": true}}}
reportReasons
Response
Returns a ReportReasonConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - ReportReasonWhereInput
|
Filtering options for ReportReasons returned from the connection. |
Example
Query
query reportReasons(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: ReportReasonWhereInput
) {
reportReasons(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...ReportReasonEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": ReportReasonWhereInput
}
Response
{
"data": {
"reportReasons": {
"edges": [ReportReasonEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
search
Response
Returns [SearchResult!]!
Arguments
| Name | Description |
|---|---|
query - String!
|
Example
Query
query search($query: String!) {
search(query: $query) {
... on UserSearchResult {
...UserSearchResultFragment
}
... on TopicSearchResult {
...TopicSearchResultFragment
}
... on PostSearchResult {
...PostSearchResultFragment
}
}
}
Variables
{"query": "xyz789"}
Response
{"data": {"search": [{}]}}
searchPosts
Response
Returns a PostSearchConnection!
Arguments
| Name | Description |
|---|---|
first - Int
|
Returns the first n elements from the search results. |
after - Cursor
|
Returns the search results that come after the specified cursor. |
filter - SearchPostFilterInput
|
The filters to apply to the search. |
query - String!
|
The search query. |
orderBy - SearchPostOrderBy
|
The order in which to sort the search results. |
semantic - Boolean
|
Example
Query
query searchPosts(
$first: Int,
$after: Cursor,
$filter: SearchPostFilterInput,
$query: String!,
$orderBy: SearchPostOrderBy,
$semantic: Boolean
) {
searchPosts(
first: $first,
after: $after,
filter: $filter,
query: $query,
orderBy: $orderBy,
semantic: $semantic
) {
edges {
...PostEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
topics {
...TopicFragment
}
}
}
Variables
{
"first": 987,
"after": Cursor,
"filter": SearchPostFilterInput,
"query": "abc123",
"orderBy": "Popular",
"semantic": false
}
Response
{
"data": {
"searchPosts": {
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 987,
"topics": [Topic]
}
}
}
searchPubmed
Response
Returns a PubmedSearchConnection!
Example
Query
query searchPubmed(
$first: Int,
$after: Cursor,
$query: String!,
$semantic: Boolean
) {
searchPubmed(
first: $first,
after: $after,
query: $query,
semantic: $semantic
) {
edges {
...PubmedEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"first": 987,
"after": Cursor,
"query": "abc123",
"semantic": false
}
Response
{
"data": {
"searchPubmed": {
"edges": [PubmedEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
searchRegistry
Description
Search the NPI registry for a provider by name or number
Response
Returns [RegistryResult!]
Example
Query
query searchRegistry(
$number: String,
$firstName: String,
$lastName: String,
$state: String
) {
searchRegistry(
number: $number,
firstName: $firstName,
lastName: $lastName,
state: $state
) {
number
firstName
lastName
address
zip
state
credential
taxonomyCode
taxonomyDesc
claimed
}
}
Variables
{
"number": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"state": "abc123"
}
Response
{
"data": {
"searchRegistry": [
{
"number": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"address": "abc123",
"zip": "abc123",
"state": "xyz789",
"credential": "abc123",
"taxonomyCode": "xyz789",
"taxonomyDesc": "xyz789",
"claimed": true
}
]
}
}
searchSuggestions
Response
Returns a SearchSuggestionResult!
Arguments
| Name | Description |
|---|---|
query - String!
|
Example
Query
query searchSuggestions($query: String!) {
searchSuggestions(query: $query) {
users {
...UserSearchResultFragment
}
topics {
...TopicSearchResultFragment
}
}
}
Variables
{"query": "abc123"}
Response
{
"data": {
"searchSuggestions": {
"users": [UserSearchResult],
"topics": [TopicSearchResult]
}
}
}
searchSuggestionsV2
Response
Returns a SearchSuggestionResultV2!
Arguments
| Name | Description |
|---|---|
query - String!
|
Example
Query
query searchSuggestionsV2($query: String!) {
searchSuggestionsV2(query: $query) {
users {
...UserFragment
}
topics {
...TopicFragment
}
}
}
Variables
{"query": "abc123"}
Response
{
"data": {
"searchSuggestionsV2": {
"users": [User],
"topics": [Topic]
}
}
}
searchUsers
Response
Returns a UserSearchConnection!
Arguments
| Name | Description |
|---|---|
first - Int
|
Returns the first n elements from the search results. |
after - Cursor
|
Returns the search results that come after the specified cursor. |
filter - SearchUserFilterInput
|
The filters to apply to the search. |
query - String!
|
The search query. |
orderBy - SearchUserOrderBy
|
The order in which to sort the search results. |
Example
Query
query searchUsers(
$first: Int,
$after: Cursor,
$filter: SearchUserFilterInput,
$query: String!,
$orderBy: SearchUserOrderBy
) {
searchUsers(
first: $first,
after: $after,
filter: $filter,
query: $query,
orderBy: $orderBy
) {
edges {
...UserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
specialties {
...NpiTaxonomyFragment
}
}
}
Variables
{
"first": 987,
"after": Cursor,
"filter": SearchUserFilterInput,
"query": "abc123",
"orderBy": "Popular"
}
Response
{
"data": {
"searchUsers": {
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 987,
"specialties": [NpiTaxonomy]
}
}
}
searchV2
Description
Returns a list of posts or users that match the query. Each SearchResult also includes an ID you can use to create a SearchConversion.
Response
Returns a SearchResults!
Arguments
| Name | Description |
|---|---|
query - String!
|
Example
Query
query searchV2($query: String!) {
searchV2(query: $query) {
id
results {
... on UserSearchResult {
...UserSearchResultFragment
}
... on TopicSearchResult {
...TopicSearchResultFragment
}
... on PostSearchResult {
...PostSearchResultFragment
}
}
}
}
Variables
{"query": "abc123"}
Response
{
"data": {
"searchV2": {
"id": "4",
"results": [UserSearchResult]
}
}
}
searches
Response
Returns a SearchConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - SearchOrder
|
Ordering options for Searches returned from the connection. |
where - SearchWhereInput
|
Filtering options for Searches returned from the connection. |
Example
Query
query searches(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: SearchOrder,
$where: SearchWhereInput
) {
searches(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...SearchEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": SearchOrder,
"where": SearchWhereInput
}
Response
{
"data": {
"searches": {
"edges": [SearchEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
shortcode
Example
Query
query shortcode($code: String!) {
shortcode(code: $code) {
id
url
code
title
body
summary
discussionPoints
status
createdAt
updatedAt
}
}
Variables
{"code": "xyz789"}
Response
{
"data": {
"shortcode": {
"id": "4",
"url": "xyz789",
"code": "abc123",
"title": "abc123",
"body": "xyz789",
"summary": "xyz789",
"discussionPoints": ["xyz789"],
"status": "generating",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
sparkyAnswers
Response
Returns a SparkyQueryConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query sparkyAnswers(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
sparkyAnswers(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...SparkyQueryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"sparkyAnswers": {
"edges": [SparkyQueryEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
sparkyChatConfigs
Response
Returns a SparkyChatConfigConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - SparkyChatConfigOrder
|
Ordering options for SparkyChatConfigs returned from the connection. |
where - SparkyChatConfigWhereInput
|
Filtering options for SparkyChatConfigs returned from the connection. |
Example
Query
query sparkyChatConfigs(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: SparkyChatConfigOrder,
$where: SparkyChatConfigWhereInput
) {
sparkyChatConfigs(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...SparkyChatConfigEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": SparkyChatConfigOrder,
"where": SparkyChatConfigWhereInput
}
Response
{
"data": {
"sparkyChatConfigs": {
"edges": [SparkyChatConfigEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
sparkyConversations
Response
Returns a SparkyConversationConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - SparkyConversationOrder
|
Ordering options for SparkyConversations returned from the connection. |
where - SparkyConversationWhereInput
|
Filtering options for SparkyConversations returned from the connection. |
Example
Query
query sparkyConversations(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: SparkyConversationOrder,
$where: SparkyConversationWhereInput
) {
sparkyConversations(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...SparkyConversationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": SparkyConversationOrder,
"where": SparkyConversationWhereInput
}
Response
{
"data": {
"sparkyConversations": {
"edges": [SparkyConversationEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
sparkyPrompts
Response
Returns a SparkyPromptConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - SparkyPromptOrder
|
Ordering options for SparkyPrompts returned from the connection. |
where - SparkyPromptWhereInput
|
Filtering options for SparkyPrompts returned from the connection. |
Example
Query
query sparkyPrompts(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: SparkyPromptOrder,
$where: SparkyPromptWhereInput
) {
sparkyPrompts(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...SparkyPromptEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": SparkyPromptOrder,
"where": SparkyPromptWhereInput
}
Response
{
"data": {
"sparkyPrompts": {
"edges": [SparkyPromptEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
suggestHandle
Description
Suggest a unique handle for a user based on their name and credential
Response
Returns a String!
Example
Query
query suggestHandle(
$firstName: String!,
$lastName: String!,
$credential: String!
) {
suggestHandle(
firstName: $firstName,
lastName: $lastName,
credential: $credential
)
}
Variables
{
"firstName": "abc123",
"lastName": "xyz789",
"credential": "xyz789"
}
Response
{"data": {"suggestHandle": {}}}
suggestedUsers
Description
List of recommended users
Response
Returns a UserConnection!
Example
Query
query suggestedUsers(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
suggestedUsers(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...UserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"suggestedUsers": {
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
topicClassifications
Response
Returns a TopicClassificationConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - TopicClassificationWhereInput
|
Filtering options for TopicClassifications returned from the connection. |
Example
Query
query topicClassifications(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: TopicClassificationWhereInput
) {
topicClassifications(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...TopicClassificationEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": TopicClassificationWhereInput
}
Response
{
"data": {
"topicClassifications": {
"edges": [TopicClassificationEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
topicClusters
Response
Returns a TopicClusterConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - TopicClusterWhereInput
|
Filtering options for TopicClusters returned from the connection. |
Example
Query
query topicClusters(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: TopicClusterWhereInput
) {
topicClusters(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...TopicClusterEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"where": TopicClusterWhereInput
}
Response
{
"data": {
"topicClusters": {
"edges": [TopicClusterEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
topics
Response
Returns a TopicConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - TopicOrder
|
Ordering options for Topics returned from the connection. |
where - TopicWhereInput
|
Filtering options for Topics returned from the connection. |
search - String
|
The search term to filter topics by. Using this argument will:
|
Example
Query
query topics(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: TopicOrder,
$where: TopicWhereInput,
$search: String
) {
topics(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where,
search: $search
) {
edges {
...TopicEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"orderBy": TopicOrder,
"where": TopicWhereInput,
"search": "xyz789"
}
Response
{
"data": {
"topics": {
"edges": [TopicEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
trendingTopics
Description
List of trending topics
Response
Returns a TopicConnection
Example
Query
query trendingTopics(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int
) {
trendingTopics(
after: $after,
first: $first,
before: $before,
last: $last
) {
edges {
...TopicEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987
}
Response
{
"data": {
"trendingTopics": {
"edges": [TopicEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
uploads
Response
Returns an UploadConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - UploadOrder
|
Ordering options for Uploads returned from the connection. |
where - UploadWhereInput
|
Filtering options for Uploads returned from the connection. |
Example
Query
query uploads(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: UploadOrder,
$where: UploadWhereInput
) {
uploads(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...UploadEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 123,
"orderBy": UploadOrder,
"where": UploadWhereInput
}
Response
{
"data": {
"uploads": {
"edges": [UploadEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
user
Description
Returns a user by ID
Example
Query
query user($id: ID!) {
user(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"user": {
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "xyz789",
"email": "xyz789",
"username": "xyz789",
"credential": "abc123",
"npiNumber": "abc123",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "xyz789",
"isStudent": false,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": false,
"totalFollowers": 123,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
userBlocks
Response
Returns a UserBlockConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - UserBlockOrder
|
Ordering options for UserBlocks returned from the connection. |
where - UserBlockWhereInput
|
Filtering options for UserBlocks returned from the connection. |
Example
Query
query userBlocks(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: UserBlockOrder,
$where: UserBlockWhereInput
) {
userBlocks(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...UserBlockEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": UserBlockOrder,
"where": UserBlockWhereInput
}
Response
{
"data": {
"userBlocks": {
"edges": [UserBlockEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
userCollectionCompletions
Response
Returns a UserCollectionCompletionConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - UserCollectionCompletionWhereInput
|
Filtering options for UserCollectionCompletions returned from the connection. |
Example
Query
query userCollectionCompletions(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: UserCollectionCompletionWhereInput
) {
userCollectionCompletions(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...UserCollectionCompletionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"where": UserCollectionCompletionWhereInput
}
Response
{
"data": {
"userCollectionCompletions": {
"edges": [UserCollectionCompletionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
userLinks
Response
Returns a UserLinkConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - UserLinkWhereInput
|
Filtering options for UserLinks returned from the connection. |
Example
Query
query userLinks(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: UserLinkWhereInput
) {
userLinks(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...UserLinkEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"where": UserLinkWhereInput
}
Response
{
"data": {
"userLinks": {
"edges": [UserLinkEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
userMutes
Response
Returns a UserMuteConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - UserMuteOrder
|
Ordering options for UserMutes returned from the connection. |
where - UserMuteWhereInput
|
Filtering options for UserMutes returned from the connection. |
Example
Query
query userMutes(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: UserMuteOrder,
$where: UserMuteWhereInput
) {
userMutes(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...UserMuteEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": UserMuteOrder,
"where": UserMuteWhereInput
}
Response
{
"data": {
"userMutes": {
"edges": [UserMuteEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
userNotificationTokens
Response
Returns a UserNotificationTokenConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - UserNotificationTokenWhereInput
|
Filtering options for UserNotificationTokens returned from the connection. |
Example
Query
query userNotificationTokens(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: UserNotificationTokenWhereInput
) {
userNotificationTokens(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...UserNotificationTokenEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"where": UserNotificationTokenWhereInput
}
Response
{
"data": {
"userNotificationTokens": {
"edges": [UserNotificationTokenEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
userReports
Response
Returns a UserReportConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - UserReportOrder
|
Ordering options for UserReports returned from the connection. |
where - UserReportWhereInput
|
Filtering options for UserReports returned from the connection. |
Example
Query
query userReports(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: UserReportOrder,
$where: UserReportWhereInput
) {
userReports(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...UserReportEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": UserReportOrder,
"where": UserReportWhereInput
}
Response
{
"data": {
"userReports": {
"edges": [UserReportEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
users
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - UserOrder
|
Ordering options for Users returned from the connection. |
where - UserWhereInput
|
Filtering options for Users returned from the connection. |
search - String
|
The search term to filter users by. Using this argument will:
|
Example
Query
query users(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: UserOrder,
$where: UserWhereInput,
$search: String
) {
users(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where,
search: $search
) {
edges {
...UserEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": UserOrder,
"where": UserWhereInput,
"search": "xyz789"
}
Response
{
"data": {
"users": {
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
validateEmail
Description
Validate an email for uniqueness
validateHandle
Description
Validate a handle for uniqueness
validatePhone
Description
Validate a phone number for uniqueness
validateProviderNumber
Description
Validate an NPI number for uniqueness
verificationRequests
Response
Returns a VerificationRequestConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - VerificationRequestOrder
|
Ordering options for VerificationRequests returned from the connection. |
where - VerificationRequestWhereInput
|
Filtering options for VerificationRequests returned from the connection. |
Example
Query
query verificationRequests(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: VerificationRequestOrder,
$where: VerificationRequestWhereInput
) {
verificationRequests(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...VerificationRequestEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 123,
"orderBy": VerificationRequestOrder,
"where": VerificationRequestWhereInput
}
Response
{
"data": {
"verificationRequests": {
"edges": [VerificationRequestEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
video
Example
Query
query video($id: ID!) {
video(id: $id) {
id
storageKey
width
height
duration
thumbnailURL
hlsURL
dashURL
verticalUID
verticalThumbnailURL
verticalHlsURL
verticalDashURL
verticalWidth
verticalHeight
status
createdAt
updatedAt
transcription
suggestedTitle
suggestedBody
discussionPoints
topLearningObjectives
insightsGeneratedAt
cloudflareUploadStartedAt
cloudflareUploadEndedAt
cloudflareUploadUID
cloudflareUploadStatus
cloudflareUploadError
transcodeStartedAt
transcodeEndedAt
transcodeStatus
transcodeError
transcribeStartedAt
transcribeEndedAt
transcribeStatus
transcribeError
generateInsightsStartedAt
generateInsightsEndedAt
generateInsightsStatus
generateInsightsError
likelyAudience
terms
termFrequencies
wordcloud
termsPerMinute
speakMediaID
workflowID
workflowRunID
post {
...PostFragment
}
suggestedLearningObjectives {
...LearningObjectiveFragment
}
userVideoEvents {
...UserVideoEventFragment
}
course {
...CourseFragment
}
googleDriveFile {
...GoogleDriveFileFragment
}
faceDetectionRequest {
...FaceDetectRequestFragment
}
images {
...ImageFragment
}
frames {
...VideoFrameFragment
}
importedVideo {
...ImportedVideoFragment
}
alternatePlaylists {
...AlternatePlaylistFragment
}
suggestedTopics {
...TopicFragment
}
topicClassifications {
...TopicClassificationFragment
}
completedAt
transcriptionRequest {
...TranscriptionRequestFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"video": {
"id": "4",
"storageKey": "xyz789",
"width": 987,
"height": 987,
"duration": 123,
"thumbnailURL": "xyz789",
"hlsURL": "xyz789",
"dashURL": "xyz789",
"verticalUID": "xyz789",
"verticalThumbnailURL": "xyz789",
"verticalHlsURL": "abc123",
"verticalDashURL": "xyz789",
"verticalWidth": 987,
"verticalHeight": 987,
"status": "waiting",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcription": "abc123",
"suggestedTitle": "xyz789",
"suggestedBody": "abc123",
"discussionPoints": ["abc123"],
"topLearningObjectives": ["xyz789"],
"insightsGeneratedAt": "10:15:30Z",
"cloudflareUploadStartedAt": "10:15:30Z",
"cloudflareUploadEndedAt": "10:15:30Z",
"cloudflareUploadUID": "xyz789",
"cloudflareUploadStatus": "started",
"cloudflareUploadError": "xyz789",
"transcodeStartedAt": "10:15:30Z",
"transcodeEndedAt": "10:15:30Z",
"transcodeStatus": "started",
"transcodeError": "abc123",
"transcribeStartedAt": "10:15:30Z",
"transcribeEndedAt": "10:15:30Z",
"transcribeStatus": "started",
"transcribeError": "abc123",
"generateInsightsStartedAt": "10:15:30Z",
"generateInsightsEndedAt": "10:15:30Z",
"generateInsightsStatus": "started",
"generateInsightsError": "xyz789",
"likelyAudience": "abc123",
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "abc123",
"termsPerMinute": 987.65,
"speakMediaID": "abc123",
"workflowID": "xyz789",
"workflowRunID": "xyz789",
"post": Post,
"suggestedLearningObjectives": [LearningObjective],
"userVideoEvents": [UserVideoEvent],
"course": [Course],
"googleDriveFile": GoogleDriveFile,
"faceDetectionRequest": [FaceDetectRequest],
"images": [Image],
"frames": [VideoFrame],
"importedVideo": ImportedVideo,
"alternatePlaylists": [AlternatePlaylist],
"suggestedTopics": [Topic],
"topicClassifications": [TopicClassification],
"completedAt": "10:15:30Z",
"transcriptionRequest": TranscriptionRequest
}
}
}
videoPipelines
Response
Returns a VideoPipelineConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - VideoPipelineOrder
|
Ordering options for VideoPipelines returned from the connection. |
where - VideoPipelineWhereInput
|
Filtering options for VideoPipelines returned from the connection. |
Example
Query
query videoPipelines(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: VideoPipelineOrder,
$where: VideoPipelineWhereInput
) {
videoPipelines(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...VideoPipelineEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 987,
"before": Cursor,
"last": 987,
"orderBy": VideoPipelineOrder,
"where": VideoPipelineWhereInput
}
Response
{
"data": {
"videoPipelines": {
"edges": [VideoPipelineEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
videos
Response
Returns a VideoConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
orderBy - VideoOrder
|
Ordering options for Videos returned from the connection. |
where - VideoWhereInput
|
Filtering options for Videos returned from the connection. |
Example
Query
query videos(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$orderBy: VideoOrder,
$where: VideoWhereInput
) {
videos(
after: $after,
first: $first,
before: $before,
last: $last,
orderBy: $orderBy,
where: $where
) {
edges {
...VideoEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"orderBy": VideoOrder,
"where": VideoWhereInput
}
Response
{
"data": {
"videos": {
"edges": [VideoEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
watchHistoryByLearningObjective
Response
Example
Query
query watchHistoryByLearningObjective {
watchHistoryByLearningObjective {
learningObjective {
...LearningObjectiveFragment
}
totalVideos
totalCredits
educationCredits {
...EducationCreditFragment
}
surveyQuestions {
...CertificateSurveyQuestionFragment
}
}
}
Response
{
"data": {
"watchHistoryByLearningObjective": [
{
"learningObjective": LearningObjective,
"totalVideos": 987,
"totalCredits": 123.45,
"educationCredits": [EducationCredit],
"surveyQuestions": [CertificateSurveyQuestion]
}
]
}
}
workExperiences
Response
Returns a WorkExperienceConnection!
Arguments
| Name | Description |
|---|---|
after - Cursor
|
Returns the elements in the list that come after the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
before - Cursor
|
Returns the elements in the list that come before the specified cursor. |
last - Int
|
Returns the last n elements from the list. |
where - WorkExperienceWhereInput
|
Filtering options for WorkExperiences returned from the connection. |
Example
Query
query workExperiences(
$after: Cursor,
$first: Int,
$before: Cursor,
$last: Int,
$where: WorkExperienceWhereInput
) {
workExperiences(
after: $after,
first: $first,
before: $before,
last: $last,
where: $where
) {
edges {
...WorkExperienceEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": Cursor,
"first": 123,
"before": Cursor,
"last": 987,
"where": WorkExperienceWhereInput
}
Response
{
"data": {
"workExperiences": {
"edges": [WorkExperienceEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
addPostToCollection
Response
Returns a Collection!
Example
Query
mutation addPostToCollection(
$collectionId: ID!,
$postId: ID!
) {
addPostToCollection(
collectionId: $collectionId,
postId: $postId
) {
id
name
description
totalDuration
totalPosts
tenant {
...TenantFragment
}
postcollections {
...PostCollectionFragment
}
cover {
...ImageFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
posts {
...PostFragment
}
educationCredit {
...EducationCreditFragment
}
userCompletion {
...UserCollectionCompletionFragment
}
}
}
Variables
{"collectionId": 4, "postId": "4"}
Response
{
"data": {
"addPostToCollection": {
"id": "4",
"name": "xyz789",
"description": "xyz789",
"totalDuration": 987,
"totalPosts": 123,
"tenant": Tenant,
"postcollections": [PostCollection],
"cover": Image,
"userCompletions": [UserCollectionCompletion],
"posts": [Post],
"educationCredit": EducationCredit,
"userCompletion": UserCollectionCompletion
}
}
}
adminAddTaxonomyToTopic
Example
Query
mutation adminAddTaxonomyToTopic(
$topicId: ID!,
$taxonomyId: ID!
) {
adminAddTaxonomyToTopic(
topicId: $topicId,
taxonomyId: $taxonomyId
)
}
Variables
{"topicId": "4", "taxonomyId": 4}
Response
{"data": {"adminAddTaxonomyToTopic": {}}}
adminAnalyzeComment
Response
Returns a ReflectionResult!
Arguments
| Name | Description |
|---|---|
postId - ID!
|
|
body - String!
|
|
previousReflection - PreviousReflectionResultInput
|
Example
Query
mutation adminAnalyzeComment(
$postId: ID!,
$body: String!,
$previousReflection: PreviousReflectionResultInput
) {
adminAnalyzeComment(
postId: $postId,
body: $body,
previousReflection: $previousReflection
) {
isLinguisticallyAcceptable
qaPrediction
isToxic
shouldEarnCredits
totalWords
isInquisitive
isReflective
personalProperNounCount
followUpPrompt
medicalTermCount
tags {
...PartOfSpeechTagFragment
}
allTerms {
...MedicalNreResultFragment
}
medicalTerms {
...MedicalNreResultFragment
}
sentiments {
...SentimentResultFragment
}
medicalDictionaryMatches {
...MedicalDictionaryMatchFragment
}
}
}
Variables
{
"postId": 4,
"body": "abc123",
"previousReflection": PreviousReflectionResultInput
}
Response
{
"data": {
"adminAnalyzeComment": {
"isLinguisticallyAcceptable": false,
"qaPrediction": "xyz789",
"isToxic": false,
"shouldEarnCredits": false,
"totalWords": 123,
"isInquisitive": true,
"isReflective": false,
"personalProperNounCount": 987,
"followUpPrompt": "abc123",
"medicalTermCount": 123,
"tags": [PartOfSpeechTag],
"allTerms": [MedicalNreResult],
"medicalTerms": [MedicalNreResult],
"sentiments": [SentimentResult],
"medicalDictionaryMatches": [MedicalDictionaryMatch]
}
}
}
adminAnalyzeText
Response
Returns a SparkyInsights!
Arguments
| Name | Description |
|---|---|
text - String!
|
Example
Query
mutation adminAnalyzeText($text: String!) {
adminAnalyzeText(text: $text) {
learningObjectives
discussionPoints
}
}
Variables
{"text": "xyz789"}
Response
{
"data": {
"adminAnalyzeText": {
"learningObjectives": ["xyz789"],
"discussionPoints": ["xyz789"]
}
}
}
adminApproveEducationCredit
Example
Query
mutation adminApproveEducationCredit(
$id: ID!,
$reason: String!
) {
adminApproveEducationCredit(
id: $id,
reason: $reason
)
}
Variables
{"id": 4, "reason": "xyz789"}
Response
{"data": {"adminApproveEducationCredit": {}}}
adminApproveFinancialDisclosure
adminCreateAnatomicalModel
Response
Returns an AnatomicalModel!
Arguments
| Name | Description |
|---|---|
input - CreateAnatomicalModelInput!
|
Example
Query
mutation adminCreateAnatomicalModel($input: CreateAnatomicalModelInput!) {
adminCreateAnatomicalModel(input: $input) {
id
name
description
keywords
createdAt
updatedAt
video {
...VideoFragment
}
renderedImage {
...ImageFragment
}
}
}
Variables
{"input": CreateAnatomicalModelInput}
Response
{
"data": {
"adminCreateAnatomicalModel": {
"id": "4",
"name": "xyz789",
"description": "xyz789",
"keywords": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"video": Video,
"renderedImage": Image
}
}
}
adminCreateConversationFromPost
Description
Identical to createConversationFromPost, but allows the admin to specify a config id
Response
Returns a SparkyConversation!
Example
Query
mutation adminCreateConversationFromPost(
$postId: ID!,
$configID: ID
) {
adminCreateConversationFromPost(
postId: $postId,
configID: $configID
) {
id
demo
createdAt
updatedAt
startedFrom
config {
...SparkyChatConfigFragment
}
tenant {
...TenantFragment
}
user {
...UserFragment
}
comment {
...CommentFragment
}
post {
...PostFragment
}
collection {
...CollectionFragment
}
video {
...VideoFragment
}
messages {
...SparkyMessageFragment
}
educationCredit {
...EducationCreditFragment
}
}
}
Variables
{"postId": "4", "configID": 4}
Response
{
"data": {
"adminCreateConversationFromPost": {
"id": "4",
"demo": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"startedFrom": "post",
"config": SparkyChatConfig,
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"collection": [Collection],
"video": Video,
"messages": [SparkyMessage],
"educationCredit": EducationCredit
}
}
}
adminCreateFinancialDisclosureRole
Response
Returns a FinancialDisclosureRole!
Arguments
| Name | Description |
|---|---|
input - CreateFinancialDisclosureRoleInput!
|
Example
Query
mutation adminCreateFinancialDisclosureRole($input: CreateFinancialDisclosureRoleInput!) {
adminCreateFinancialDisclosureRole(input: $input) {
id
deletedAt
name
requiresApproval
automaticallyReject
createdAt
updatedAt
}
}
Variables
{"input": CreateFinancialDisclosureRoleInput}
Response
{
"data": {
"adminCreateFinancialDisclosureRole": {
"id": "4",
"deletedAt": "10:15:30Z",
"name": "xyz789",
"requiresApproval": false,
"automaticallyReject": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
adminCreateInstagramConnection
Response
Returns an AccountConnection
Example
Query
mutation adminCreateInstagramConnection(
$userID: Int,
$username: String!
) {
adminCreateInstagramConnection(
userID: $userID,
username: $username
) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"userID": 987, "username": "abc123"}
Response
{
"data": {
"adminCreateInstagramConnection": {
"id": 4,
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "xyz789",
"userID": 4,
"username": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
adminCreatePostFromImportedVideo
Example
Query
mutation adminCreatePostFromImportedVideo(
$userID: Int,
$videoID: String!
) {
adminCreatePostFromImportedVideo(
userID: $userID,
videoID: $videoID
) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"userID": 123, "videoID": "xyz789"}
Response
{
"data": {
"adminCreatePostFromImportedVideo": {
"id": 4,
"title": "xyz789",
"suggestedTitle": "xyz789",
"creditHours": 123.45,
"status": "draft",
"body": "xyz789",
"suggestedBody": "abc123",
"totalVideos": 987,
"totalImages": 123,
"totalDuration": 987,
"totalLikes": 123,
"totalComments": 987,
"totalReactions": 123,
"totalBookmarks": 987,
"speakMediaID": "xyz789",
"featured": true,
"transcription": SpeakInsightResult,
"discussionPoints": ["abc123"],
"topLearningObjectives": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 987,
"termsPerMinute": 987.65,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "xyz789",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": false,
"topicClassifications": [TopicClassification]
}
}
}
adminCreatePostFromUploader
Description
Creates a new draft post from the uploaded file, represented by the given storage key.
Example
Query
mutation adminCreatePostFromUploader($storageKey: String!) {
adminCreatePostFromUploader(storageKey: $storageKey) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"storageKey": "abc123"}
Response
{
"data": {
"adminCreatePostFromUploader": {
"id": "4",
"title": "abc123",
"suggestedTitle": "abc123",
"creditHours": 123.45,
"status": "draft",
"body": "abc123",
"suggestedBody": "abc123",
"totalVideos": 123,
"totalImages": 987,
"totalDuration": 987,
"totalLikes": 987,
"totalComments": 987,
"totalReactions": 987,
"totalBookmarks": 987,
"speakMediaID": "abc123",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["abc123"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 987,
"termsPerMinute": 987.65,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
adminCreatePostFromVideo
Description
Download a video from a URL and create a post from it, attributed to the user with the given ID.
Example
Query
mutation adminCreatePostFromVideo($id: ID!) {
adminCreatePostFromVideo(id: $id) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"adminCreatePostFromVideo": {
"id": "4",
"title": "abc123",
"suggestedTitle": "xyz789",
"creditHours": 123.45,
"status": "draft",
"body": "abc123",
"suggestedBody": "abc123",
"totalVideos": 123,
"totalImages": 123,
"totalDuration": 123,
"totalLikes": 987,
"totalComments": 987,
"totalReactions": 123,
"totalBookmarks": 123,
"speakMediaID": "xyz789",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["abc123"],
"topLearningObjectives": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 987,
"termsPerMinute": 123.45,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "xyz789",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
adminCreateReply
Description
Identical to createReply, but allows the admin to specify a config id
Response
Returns a SparkyMessage!
Example
Query
mutation adminCreateReply(
$conversationId: ID!,
$content: String!,
$configID: ID
) {
adminCreateReply(
conversationId: $conversationId,
content: $content,
configID: $configID
) {
id
body
sentBySparky
invalidMessage
shouldEarnCredits
reflectionAnalysisResultsV1 {
...ReflectionResultFragment
}
createdAt
updatedAt
promptValue
conversation {
...SparkyConversationFragment
}
addendum {
...SparkyMessageAddendumFragment
}
}
}
Variables
{
"conversationId": "4",
"content": "abc123",
"configID": "4"
}
Response
{
"data": {
"adminCreateReply": {
"id": 4,
"body": "abc123",
"sentBySparky": true,
"invalidMessage": true,
"shouldEarnCredits": true,
"reflectionAnalysisResultsV1": ReflectionResult,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"promptValue": "abc123",
"conversation": SparkyConversation,
"addendum": [SparkyMessageAddendum]
}
}
}
adminCreateReportReason
Response
Returns a ReportReason!
Arguments
| Name | Description |
|---|---|
input - CreateReportReasonInput!
|
Example
Query
mutation adminCreateReportReason($input: CreateReportReasonInput!) {
adminCreateReportReason(input: $input) {
id
name
}
}
Variables
{"input": CreateReportReasonInput}
Response
{
"data": {
"adminCreateReportReason": {
"id": 4,
"name": "abc123"
}
}
}
adminCreateSparkyChatConfig
Response
Returns a SparkyChatConfig!
Arguments
| Name | Description |
|---|---|
input - CreateSparkyChatConfigInput!
|
Example
Query
mutation adminCreateSparkyChatConfig($input: CreateSparkyChatConfigInput!) {
adminCreateSparkyChatConfig(input: $input) {
id
name
suggestReflectionPrompt
reflectionNudgePrompt
isDefault
createdAt
reflectionGradingExpression
updatedAt
user {
...UserFragment
}
copies {
...SparkyChatConfigFragment
}
copiedFrom {
...SparkyChatConfigFragment
}
rules {
...SparkyRuleFragment
}
}
}
Variables
{"input": CreateSparkyChatConfigInput}
Response
{
"data": {
"adminCreateSparkyChatConfig": {
"id": 4,
"name": "abc123",
"suggestReflectionPrompt": "xyz789",
"reflectionNudgePrompt": "xyz789",
"isDefault": false,
"createdAt": "10:15:30Z",
"reflectionGradingExpression": "abc123",
"updatedAt": "10:15:30Z",
"user": User,
"copies": SparkyChatConfig,
"copiedFrom": [SparkyChatConfig],
"rules": [SparkyRule]
}
}
}
adminCreateVideoFromUploader
Description
Create a Video from an uploaded file, represented by the given storage key.
Example
Query
mutation adminCreateVideoFromUploader($storageKey: String!) {
adminCreateVideoFromUploader(storageKey: $storageKey) {
id
storageKey
width
height
duration
thumbnailURL
hlsURL
dashURL
verticalUID
verticalThumbnailURL
verticalHlsURL
verticalDashURL
verticalWidth
verticalHeight
status
createdAt
updatedAt
transcription
suggestedTitle
suggestedBody
discussionPoints
topLearningObjectives
insightsGeneratedAt
cloudflareUploadStartedAt
cloudflareUploadEndedAt
cloudflareUploadUID
cloudflareUploadStatus
cloudflareUploadError
transcodeStartedAt
transcodeEndedAt
transcodeStatus
transcodeError
transcribeStartedAt
transcribeEndedAt
transcribeStatus
transcribeError
generateInsightsStartedAt
generateInsightsEndedAt
generateInsightsStatus
generateInsightsError
likelyAudience
terms
termFrequencies
wordcloud
termsPerMinute
speakMediaID
workflowID
workflowRunID
post {
...PostFragment
}
suggestedLearningObjectives {
...LearningObjectiveFragment
}
userVideoEvents {
...UserVideoEventFragment
}
course {
...CourseFragment
}
googleDriveFile {
...GoogleDriveFileFragment
}
faceDetectionRequest {
...FaceDetectRequestFragment
}
images {
...ImageFragment
}
frames {
...VideoFrameFragment
}
importedVideo {
...ImportedVideoFragment
}
alternatePlaylists {
...AlternatePlaylistFragment
}
suggestedTopics {
...TopicFragment
}
topicClassifications {
...TopicClassificationFragment
}
completedAt
transcriptionRequest {
...TranscriptionRequestFragment
}
}
}
Variables
{"storageKey": "abc123"}
Response
{
"data": {
"adminCreateVideoFromUploader": {
"id": 4,
"storageKey": "abc123",
"width": 987,
"height": 123,
"duration": 123,
"thumbnailURL": "xyz789",
"hlsURL": "xyz789",
"dashURL": "abc123",
"verticalUID": "xyz789",
"verticalThumbnailURL": "abc123",
"verticalHlsURL": "abc123",
"verticalDashURL": "xyz789",
"verticalWidth": 123,
"verticalHeight": 987,
"status": "waiting",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcription": "abc123",
"suggestedTitle": "xyz789",
"suggestedBody": "abc123",
"discussionPoints": ["abc123"],
"topLearningObjectives": ["abc123"],
"insightsGeneratedAt": "10:15:30Z",
"cloudflareUploadStartedAt": "10:15:30Z",
"cloudflareUploadEndedAt": "10:15:30Z",
"cloudflareUploadUID": "xyz789",
"cloudflareUploadStatus": "started",
"cloudflareUploadError": "xyz789",
"transcodeStartedAt": "10:15:30Z",
"transcodeEndedAt": "10:15:30Z",
"transcodeStatus": "started",
"transcodeError": "xyz789",
"transcribeStartedAt": "10:15:30Z",
"transcribeEndedAt": "10:15:30Z",
"transcribeStatus": "started",
"transcribeError": "xyz789",
"generateInsightsStartedAt": "10:15:30Z",
"generateInsightsEndedAt": "10:15:30Z",
"generateInsightsStatus": "started",
"generateInsightsError": "abc123",
"likelyAudience": "xyz789",
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "abc123",
"termsPerMinute": 123.45,
"speakMediaID": "abc123",
"workflowID": "abc123",
"workflowRunID": "xyz789",
"post": Post,
"suggestedLearningObjectives": [LearningObjective],
"userVideoEvents": [UserVideoEvent],
"course": [Course],
"googleDriveFile": GoogleDriveFile,
"faceDetectionRequest": [FaceDetectRequest],
"images": [Image],
"frames": [VideoFrame],
"importedVideo": ImportedVideo,
"alternatePlaylists": [AlternatePlaylist],
"suggestedTopics": [Topic],
"topicClassifications": [TopicClassification],
"completedAt": "10:15:30Z",
"transcriptionRequest": TranscriptionRequest
}
}
}
adminCreateYoutubeConnection
Response
Returns an AccountConnection
Example
Query
mutation adminCreateYoutubeConnection(
$userID: Int,
$username: String!
) {
adminCreateYoutubeConnection(
userID: $userID,
username: $username
) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"userID": 987, "username": "xyz789"}
Response
{
"data": {
"adminCreateYoutubeConnection": {
"id": "4",
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "abc123",
"userID": "4",
"username": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
adminDeleteAnatomicalModel
Response
Returns an AnatomicalModel!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation adminDeleteAnatomicalModel($id: ID!) {
adminDeleteAnatomicalModel(id: $id) {
id
name
description
keywords
createdAt
updatedAt
video {
...VideoFragment
}
renderedImage {
...ImageFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"adminDeleteAnatomicalModel": {
"id": "4",
"name": "xyz789",
"description": "abc123",
"keywords": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"video": Video,
"renderedImage": Image
}
}
}
adminDeleteBookmark
adminDeleteComment
adminDeleteFinancialDisclosureRole
adminDeleteLike
adminDeleteNotification
adminDeleteReportReason
Response
Returns a ReportReason!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation adminDeleteReportReason($id: ID!) {
adminDeleteReportReason(id: $id) {
id
name
}
}
Variables
{"id": 4}
Response
{
"data": {
"adminDeleteReportReason": {
"id": 4,
"name": "xyz789"
}
}
}
adminDenyEducationCredit
Example
Query
mutation adminDenyEducationCredit(
$id: ID!,
$reason: String!
) {
adminDenyEducationCredit(
id: $id,
reason: $reason
)
}
Variables
{
"id": "4",
"reason": "xyz789"
}
Response
{"data": {"adminDenyEducationCredit": {}}}
adminDisableUser
Example
Query
mutation adminDisableUser($id: ID!) {
adminDisableUser(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"adminDisableUser": {
"id": "4",
"firstName": "xyz789",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "xyz789",
"email": "abc123",
"username": "abc123",
"credential": "xyz789",
"npiNumber": "xyz789",
"npiTaxonomyCode": "abc123",
"npiTaxonomyDescription": "xyz789",
"bio": "xyz789",
"isStudent": true,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
adminDownloadFinancialDisclosureStatement
Response
Returns a DownloadFinancialDisclosureStatement!
Example
Query
mutation adminDownloadFinancialDisclosureStatement(
$id: ID!,
$templateID: ID!
) {
adminDownloadFinancialDisclosureStatement(
id: $id,
templateID: $templateID
) {
url
}
}
Variables
{
"id": "4",
"templateID": "4"
}
Response
{
"data": {
"adminDownloadFinancialDisclosureStatement": {
"url": "abc123"
}
}
}
adminEnableUser
Example
Query
mutation adminEnableUser($id: ID!) {
adminEnableUser(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"adminEnableUser": {
"id": "4",
"firstName": "abc123",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "abc123",
"email": "abc123",
"username": "abc123",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "xyz789",
"isStudent": false,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": false,
"totalFollowers": 123,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
adminImportImageFromURL
Example
Query
mutation adminImportImageFromURL($url: String!) {
adminImportImageFromURL(url: $url) {
id
storageKey
url
variantKey
metadata
video {
...VideoFragment
}
}
}
Variables
{"url": "xyz789"}
Response
{
"data": {
"adminImportImageFromURL": {
"id": "4",
"storageKey": "abc123",
"url": "abc123",
"variantKey": "abc123",
"metadata": Map,
"video": Video
}
}
}
adminLogin
Description
Authenticates an admin user and returns a JWT auth token
Response
Returns a LoginResponse
Arguments
| Name | Description |
|---|---|
input - AdminLoginInput!
|
Example
Query
mutation adminLogin($input: AdminLoginInput!) {
adminLogin(input: $input) {
token
expiresAt
user {
...UserFragment
}
}
}
Variables
{"input": AdminLoginInput}
Response
{
"data": {
"adminLogin": {
"token": "abc123",
"expiresAt": "10:15:30Z",
"user": User
}
}
}
adminRefreshInsights
adminRemoveSparkyChatConfig
adminRemoveTaxonomyFromTopic
adminRevokeFinancialDisclosure
adminTestSparkyRules
Response
Returns a SparkyTestRuleResult!
Arguments
| Name | Description |
|---|---|
text - String!
|
|
rules - [SparkyRuleInput!]!
|
Example
Query
mutation adminTestSparkyRules(
$text: String!,
$rules: [SparkyRuleInput!]!
) {
adminTestSparkyRules(
text: $text,
rules: $rules
) {
shouldEarnCredits
result {
...ReflectionResultFragment
}
messages {
...SparkyTestMessageFragment
}
}
}
Variables
{
"text": "abc123",
"rules": [SparkyRuleInput]
}
Response
{
"data": {
"adminTestSparkyRules": {
"shouldEarnCredits": false,
"result": ReflectionResult,
"messages": [SparkyTestMessage]
}
}
}
adminUnfollowUser
adminUpdateAnatomicalModel
Response
Returns an AnatomicalModel!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateAnatomicalModelInput!
|
Example
Query
mutation adminUpdateAnatomicalModel(
$id: ID!,
$input: UpdateAnatomicalModelInput!
) {
adminUpdateAnatomicalModel(
id: $id,
input: $input
) {
id
name
description
keywords
createdAt
updatedAt
video {
...VideoFragment
}
renderedImage {
...ImageFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateAnatomicalModelInput
}
Response
{
"data": {
"adminUpdateAnatomicalModel": {
"id": 4,
"name": "abc123",
"description": "xyz789",
"keywords": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"video": Video,
"renderedImage": Image
}
}
}
adminUpdateFinancialDisclosurePrintTemplate
Response
Returns a FinancialDisclosurePrintTemplate!
Arguments
| Name | Description |
|---|---|
input - UpdateFinancialDisclosurePrintTemplateInput!
|
Example
Query
mutation adminUpdateFinancialDisclosurePrintTemplate($input: UpdateFinancialDisclosurePrintTemplateInput!) {
adminUpdateFinancialDisclosurePrintTemplate(input: $input) {
id
template
createdAt
updatedAt
}
}
Variables
{"input": UpdateFinancialDisclosurePrintTemplateInput}
Response
{
"data": {
"adminUpdateFinancialDisclosurePrintTemplate": {
"id": "4",
"template": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
adminUpdateFinancialDisclosureRole
Response
Returns a FinancialDisclosureRole!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateFinancialDisclosureRoleInput!
|
Example
Query
mutation adminUpdateFinancialDisclosureRole(
$id: ID!,
$input: UpdateFinancialDisclosureRoleInput!
) {
adminUpdateFinancialDisclosureRole(
id: $id,
input: $input
) {
id
deletedAt
name
requiresApproval
automaticallyReject
createdAt
updatedAt
}
}
Variables
{"id": 4, "input": UpdateFinancialDisclosureRoleInput}
Response
{
"data": {
"adminUpdateFinancialDisclosureRole": {
"id": 4,
"deletedAt": "10:15:30Z",
"name": "abc123",
"requiresApproval": true,
"automaticallyReject": false,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
adminUpdateNotificationConfig
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateNotificationConfigInput!
|
Example
Query
mutation adminUpdateNotificationConfig($input: UpdateNotificationConfigInput!) {
adminUpdateNotificationConfig(input: $input)
}
Variables
{"input": UpdateNotificationConfigInput}
Response
{"data": {"adminUpdateNotificationConfig": {}}}
adminUpdatePostReport
Response
Returns a PostReport!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdatePostReportInput!
|
Example
Query
mutation adminUpdatePostReport(
$id: ID!,
$input: UpdatePostReportInput!
) {
adminUpdatePostReport(
id: $id,
input: $input
) {
id
description
createdAt
reviewedAt
reportReason {
...ReportReasonFragment
}
author {
...UserFragment
}
reportedPost {
...PostFragment
}
reviewedBy {
...UserFragment
}
}
}
Variables
{"id": 4, "input": UpdatePostReportInput}
Response
{
"data": {
"adminUpdatePostReport": {
"id": "4",
"description": "xyz789",
"createdAt": "10:15:30Z",
"reviewedAt": "10:15:30Z",
"reportReason": ReportReason,
"author": User,
"reportedPost": Post,
"reviewedBy": User
}
}
}
adminUpdateReportReason
Response
Returns a ReportReason!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateReportReasonInput!
|
Example
Query
mutation adminUpdateReportReason(
$id: ID!,
$input: UpdateReportReasonInput!
) {
adminUpdateReportReason(
id: $id,
input: $input
) {
id
name
}
}
Variables
{
"id": "4",
"input": UpdateReportReasonInput
}
Response
{
"data": {
"adminUpdateReportReason": {
"id": 4,
"name": "abc123"
}
}
}
adminUpdateSparkyChatConfig
Response
Returns a SparkyChatConfig!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateSparkyChatConfigInput!
|
Example
Query
mutation adminUpdateSparkyChatConfig(
$id: ID!,
$input: UpdateSparkyChatConfigInput!
) {
adminUpdateSparkyChatConfig(
id: $id,
input: $input
) {
id
name
suggestReflectionPrompt
reflectionNudgePrompt
isDefault
createdAt
reflectionGradingExpression
updatedAt
user {
...UserFragment
}
copies {
...SparkyChatConfigFragment
}
copiedFrom {
...SparkyChatConfigFragment
}
rules {
...SparkyRuleFragment
}
}
}
Variables
{"id": 4, "input": UpdateSparkyChatConfigInput}
Response
{
"data": {
"adminUpdateSparkyChatConfig": {
"id": "4",
"name": "abc123",
"suggestReflectionPrompt": "xyz789",
"reflectionNudgePrompt": "xyz789",
"isDefault": true,
"createdAt": "10:15:30Z",
"reflectionGradingExpression": "xyz789",
"updatedAt": "10:15:30Z",
"user": User,
"copies": SparkyChatConfig,
"copiedFrom": [SparkyChatConfig],
"rules": [SparkyRule]
}
}
}
adminUpdateSparkyChatConfigRules
Response
Returns a SparkyChatConfig!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
rules - [SparkyRuleInput!]!
|
Example
Query
mutation adminUpdateSparkyChatConfigRules(
$id: ID!,
$rules: [SparkyRuleInput!]!
) {
adminUpdateSparkyChatConfigRules(
id: $id,
rules: $rules
) {
id
name
suggestReflectionPrompt
reflectionNudgePrompt
isDefault
createdAt
reflectionGradingExpression
updatedAt
user {
...UserFragment
}
copies {
...SparkyChatConfigFragment
}
copiedFrom {
...SparkyChatConfigFragment
}
rules {
...SparkyRuleFragment
}
}
}
Variables
{"id": 4, "rules": [SparkyRuleInput]}
Response
{
"data": {
"adminUpdateSparkyChatConfigRules": {
"id": "4",
"name": "xyz789",
"suggestReflectionPrompt": "abc123",
"reflectionNudgePrompt": "abc123",
"isDefault": true,
"createdAt": "10:15:30Z",
"reflectionGradingExpression": "xyz789",
"updatedAt": "10:15:30Z",
"user": User,
"copies": SparkyChatConfig,
"copiedFrom": [SparkyChatConfig],
"rules": [SparkyRule]
}
}
}
adminUpdateUserReport
Response
Returns a UserReport!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateUserReportInput!
|
Example
Query
mutation adminUpdateUserReport(
$id: ID!,
$input: UpdateUserReportInput!
) {
adminUpdateUserReport(
id: $id,
input: $input
) {
id
description
createdAt
reviewedAt
reportReason {
...ReportReasonFragment
}
author {
...UserFragment
}
reportedUser {
...UserFragment
}
reviewedBy {
...UserFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateUserReportInput
}
Response
{
"data": {
"adminUpdateUserReport": {
"id": 4,
"description": "xyz789",
"createdAt": "10:15:30Z",
"reviewedAt": "10:15:30Z",
"reportReason": ReportReason,
"author": User,
"reportedUser": User,
"reviewedBy": User
}
}
}
adminUpdateVerificationRequest
Description
Update a verification request for the specified user. Only admins can do this.
Response
Returns a VerificationRequest!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateVerificationRequestInput!
|
Example
Query
mutation adminUpdateVerificationRequest(
$id: ID!,
$input: UpdateVerificationRequestInput!
) {
adminUpdateVerificationRequest(
id: $id,
input: $input
) {
id
dob
zip
storageKey
url
status
createdAt
updatedAt
user {
...UserFragment
}
}
}
Variables
{"id": 4, "input": UpdateVerificationRequestInput}
Response
{
"data": {
"adminUpdateVerificationRequest": {
"id": 4,
"dob": "xyz789",
"zip": "xyz789",
"storageKey": "abc123",
"url": "xyz789",
"status": "waiting",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User
}
}
}
askSparky
Response
Returns a SparkyQuery!
Arguments
| Name | Description |
|---|---|
question - String!
|
Example
Query
mutation askSparky($question: String!) {
askSparky(question: $question) {
id
query
stepBackPrompt
stepBackResponse
hydePrompt
hydeResponse
step
candidateIds
rankedCandidateIds
prompt
tokens
draftResponse
finalResponse
createdAt
updatedAt
completedAt
user {
...UserFragment
}
references {
...PubmedArticleFragment
}
}
}
Variables
{"question": "xyz789"}
Response
{
"data": {
"askSparky": {
"id": "4",
"query": "abc123",
"stepBackPrompt": "abc123",
"stepBackResponse": "abc123",
"hydePrompt": "xyz789",
"hydeResponse": "abc123",
"step": "query",
"candidateIds": ["abc123"],
"rankedCandidateIds": ["abc123"],
"prompt": "abc123",
"tokens": 123,
"draftResponse": "xyz789",
"finalResponse": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"completedAt": "10:15:30Z",
"user": User,
"references": [PubmedArticle]
}
}
}
blockUser
Description
Blocks the specified user for the current user. Blocking a user will hide their posts from the current user's feed. Blocked users won't be able to follow, view or interact with the current user.
Response
Returns a UserBlock!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation blockUser($id: ID!) {
blockUser(id: $id) {
id
createdAt
blockedUser {
...UserFragment
}
owner {
...UserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"blockUser": {
"id": "4",
"createdAt": "10:15:30Z",
"blockedUser": User,
"owner": User
}
}
}
bookmarkPost
Description
Creates a Bookmark for the specified post and current user
Response
Returns a Bookmark!
Arguments
| Name | Description |
|---|---|
input - BookmarkPostInput!
|
The fields to use when creating the bookmark |
Example
Query
mutation bookmarkPost($input: BookmarkPostInput!) {
bookmarkPost(input: $input) {
id
bookmarkedAt
userID
postID
user {
...UserFragment
}
post {
...PostFragment
}
}
}
Variables
{"input": BookmarkPostInput}
Response
{
"data": {
"bookmarkPost": {
"id": "4",
"bookmarkedAt": "10:15:30Z",
"userID": "4",
"postID": "4",
"user": User,
"post": Post
}
}
}
createAudience
Response
Returns an Audience!
Arguments
| Name | Description |
|---|---|
input - CreateAudienceInput!
|
Example
Query
mutation createAudience($input: CreateAudienceInput!) {
createAudience(input: $input) {
id
name
designationtemplate
createdAt
updatedAt
npiTaxonomies {
...NpiTaxonomyFragment
}
posts {
...PostFragment
}
tenant {
...TenantFragment
}
designation
}
}
Variables
{"input": CreateAudienceInput}
Response
{
"data": {
"createAudience": {
"id": "4",
"name": "xyz789",
"designationtemplate": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"npiTaxonomies": [NpiTaxonomy],
"posts": [Post],
"tenant": Tenant,
"designation": "abc123"
}
}
}
createCertificate
Response
Returns a Certificate!
Arguments
| Name | Description |
|---|---|
input - CreateCertificateInput!
|
Example
Query
mutation createCertificate($input: CreateCertificateInput!) {
createCertificate(input: $input) {
id
createdAt
updatedAt
url
user {
...UserFragment
}
educationCredits {
...EducationCreditFragment
}
certificateSurveyAnswers {
...CertificateSurveyAnswerFragment
}
}
}
Variables
{"input": CreateCertificateInput}
Response
{
"data": {
"createCertificate": {
"id": 4,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"url": "xyz789",
"user": User,
"educationCredits": [EducationCredit],
"certificateSurveyAnswers": [
CertificateSurveyAnswer
]
}
}
}
createCertificateForReflections
Response
Returns a Certificate!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
Example
Query
mutation createCertificateForReflections($ids: [ID!]!) {
createCertificateForReflections(ids: $ids) {
id
createdAt
updatedAt
url
user {
...UserFragment
}
educationCredits {
...EducationCreditFragment
}
certificateSurveyAnswers {
...CertificateSurveyAnswerFragment
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"createCertificateForReflections": {
"id": "4",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"url": "abc123",
"user": User,
"educationCredits": [EducationCredit],
"certificateSurveyAnswers": [
CertificateSurveyAnswer
]
}
}
}
createCertificateSurveyQuestion
Response
Returns a CertificateSurveyQuestion!
Arguments
| Name | Description |
|---|---|
input - CreateCertificateSurveyQuestionInput!
|
Example
Query
mutation createCertificateSurveyQuestion($input: CreateCertificateSurveyQuestionInput!) {
createCertificateSurveyQuestion(input: $input) {
id
question
createdAt
updatedAt
learningObjective {
...LearningObjectiveFragment
}
choices {
...CertificateSurveyQuestionChoiceFragment
}
}
}
Variables
{"input": CreateCertificateSurveyQuestionInput}
Response
{
"data": {
"createCertificateSurveyQuestion": {
"id": "4",
"question": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"learningObjective": LearningObjective,
"choices": [CertificateSurveyQuestionChoice]
}
}
}
createCertificateSurveyQuestionChoice
Response
Returns a CertificateSurveyQuestionChoice!
Arguments
| Name | Description |
|---|---|
input - CreateCertificateSurveyQuestionChoiceInput!
|
Example
Query
mutation createCertificateSurveyQuestionChoice($input: CreateCertificateSurveyQuestionChoiceInput!) {
createCertificateSurveyQuestionChoice(input: $input) {
id
label
emoji
question {
...CertificateSurveyQuestionFragment
}
}
}
Variables
{"input": CreateCertificateSurveyQuestionChoiceInput}
Response
{
"data": {
"createCertificateSurveyQuestionChoice": {
"id": 4,
"label": "abc123",
"emoji": "xyz789",
"question": CertificateSurveyQuestion
}
}
}
createCollection
Response
Returns a Collection!
Arguments
| Name | Description |
|---|---|
input - CreateCollectionInput!
|
Example
Query
mutation createCollection($input: CreateCollectionInput!) {
createCollection(input: $input) {
id
name
description
totalDuration
totalPosts
tenant {
...TenantFragment
}
postcollections {
...PostCollectionFragment
}
cover {
...ImageFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
posts {
...PostFragment
}
educationCredit {
...EducationCreditFragment
}
userCompletion {
...UserCollectionCompletionFragment
}
}
}
Variables
{"input": CreateCollectionInput}
Response
{
"data": {
"createCollection": {
"id": 4,
"name": "xyz789",
"description": "abc123",
"totalDuration": 123,
"totalPosts": 987,
"tenant": Tenant,
"postcollections": [PostCollection],
"cover": Image,
"userCompletions": [UserCollectionCompletion],
"posts": [Post],
"educationCredit": EducationCredit,
"userCompletion": UserCollectionCompletion
}
}
}
createComment
Description
Create a new comment. Comments are owned by the currently authenticated user, the authorID field can only be set by admins
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
input - CreateCommentInput!
|
Example
Query
mutation createComment($input: CreateCommentInput!) {
createComment(input: $input) {
id
body
reflectionPrompt
namedEntities {
...NamedEntityFragment
}
sentiment {
...SentimentFragment
}
totalLikes
createdAt
reflectionAnalysisResults {
...ReflectionResultFragment
}
updatedAt
shouldEarnCredits
didEarnCredits
creditWasApproved
author {
...UserFragment
}
post {
...PostFragment
}
parent {
...CommentFragment
}
replies {
...CommentFragment
}
educationCredit {
...EducationCreditFragment
}
commentNamedEntities {
...CommentNamedEntityFragment
}
reviewedBy {
...UserFragment
}
sparkyConversations {
...SparkyConversationFragment
}
likedUsers {
...UserFragment
}
commentLikes {
...CommentLikeFragment
}
}
}
Variables
{"input": CreateCommentInput}
Response
{
"data": {
"createComment": {
"id": "4",
"body": "abc123",
"reflectionPrompt": "xyz789",
"namedEntities": [NamedEntity],
"sentiment": Sentiment,
"totalLikes": 987,
"createdAt": "10:15:30Z",
"reflectionAnalysisResults": ReflectionResult,
"updatedAt": "10:15:30Z",
"shouldEarnCredits": false,
"didEarnCredits": true,
"creditWasApproved": false,
"author": User,
"post": Post,
"parent": Comment,
"replies": [Comment],
"educationCredit": EducationCredit,
"commentNamedEntities": [CommentNamedEntity],
"reviewedBy": User,
"sparkyConversations": [SparkyConversation],
"likedUsers": [User],
"commentLikes": [CommentLike]
}
}
}
createConversationFromComment
Description
Creates a new sparky conversation using the given comment id (and parent post0 for context.
Response
Returns a SparkyConversation!
Arguments
| Name | Description |
|---|---|
commentId - ID!
|
Example
Query
mutation createConversationFromComment($commentId: ID!) {
createConversationFromComment(commentId: $commentId) {
id
demo
createdAt
updatedAt
startedFrom
config {
...SparkyChatConfigFragment
}
tenant {
...TenantFragment
}
user {
...UserFragment
}
comment {
...CommentFragment
}
post {
...PostFragment
}
collection {
...CollectionFragment
}
video {
...VideoFragment
}
messages {
...SparkyMessageFragment
}
educationCredit {
...EducationCreditFragment
}
}
}
Variables
{"commentId": 4}
Response
{
"data": {
"createConversationFromComment": {
"id": "4",
"demo": false,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"startedFrom": "post",
"config": SparkyChatConfig,
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"collection": [Collection],
"video": Video,
"messages": [SparkyMessage],
"educationCredit": EducationCredit
}
}
}
createConversationFromPost
Description
Creates a new sparky conversation using the given post id for context.
Response
Returns a SparkyConversation!
Arguments
| Name | Description |
|---|---|
postId - ID!
|
Example
Query
mutation createConversationFromPost($postId: ID!) {
createConversationFromPost(postId: $postId) {
id
demo
createdAt
updatedAt
startedFrom
config {
...SparkyChatConfigFragment
}
tenant {
...TenantFragment
}
user {
...UserFragment
}
comment {
...CommentFragment
}
post {
...PostFragment
}
collection {
...CollectionFragment
}
video {
...VideoFragment
}
messages {
...SparkyMessageFragment
}
educationCredit {
...EducationCreditFragment
}
}
}
Variables
{"postId": 4}
Response
{
"data": {
"createConversationFromPost": {
"id": 4,
"demo": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"startedFrom": "post",
"config": SparkyChatConfig,
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"collection": [Collection],
"video": Video,
"messages": [SparkyMessage],
"educationCredit": EducationCredit
}
}
}
createConversationFromVideo
Response
Returns a SparkyConversation!
Arguments
| Name | Description |
|---|---|
videoId - ID!
|
Example
Query
mutation createConversationFromVideo($videoId: ID!) {
createConversationFromVideo(videoId: $videoId) {
id
demo
createdAt
updatedAt
startedFrom
config {
...SparkyChatConfigFragment
}
tenant {
...TenantFragment
}
user {
...UserFragment
}
comment {
...CommentFragment
}
post {
...PostFragment
}
collection {
...CollectionFragment
}
video {
...VideoFragment
}
messages {
...SparkyMessageFragment
}
educationCredit {
...EducationCreditFragment
}
}
}
Variables
{"videoId": "4"}
Response
{
"data": {
"createConversationFromVideo": {
"id": 4,
"demo": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"startedFrom": "post",
"config": SparkyChatConfig,
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"collection": [Collection],
"video": Video,
"messages": [SparkyMessage],
"educationCredit": EducationCredit
}
}
}
createCourse
Response
Returns a Course!
Arguments
| Name | Description |
|---|---|
input - CreateCourseInput!
|
Example
Query
mutation createCourse($input: CreateCourseInput!) {
createCourse(input: $input) {
id
name
description
disclosure
startDate
creditHours
price
website
isRaceApproved
type
createdAt
status
reviewedAt
author {
...UserFragment
}
faculty {
...UserFragment
}
reviewedBy {
...UserFragment
}
tenant {
...TenantFragment
}
video {
...VideoFragment
}
}
}
Variables
{"input": CreateCourseInput}
Response
{
"data": {
"createCourse": {
"id": 4,
"name": "xyz789",
"description": "xyz789",
"disclosure": "abc123",
"startDate": "10:15:30Z",
"creditHours": 123.45,
"price": 123.45,
"website": "xyz789",
"isRaceApproved": true,
"type": "ondemand",
"createdAt": "10:15:30Z",
"status": "pending",
"reviewedAt": "10:15:30Z",
"author": User,
"faculty": [User],
"reviewedBy": User,
"tenant": Tenant,
"video": Video
}
}
}
createEducationHistory
Description
Creates a new EducationHistory entry for the current user
Response
Returns an EducationHistory!
Arguments
| Name | Description |
|---|---|
input - CreateEducationHistoryInput!
|
Example
Query
mutation createEducationHistory($input: CreateEducationHistoryInput!) {
createEducationHistory(input: $input) {
id
institution
degree
major
startDate
endDate
type
user {
...UserFragment
}
}
}
Variables
{"input": CreateEducationHistoryInput}
Response
{
"data": {
"createEducationHistory": {
"id": "4",
"institution": "xyz789",
"degree": "abc123",
"major": "xyz789",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"type": "education",
"user": User
}
}
}
createFinancialDisclosureStatement
Description
Creates a new financial disclosure statement for the current user. If a statement already exists, and error will be returned.
Response
Returns a FinancialDisclosureStatement!
Arguments
| Name | Description |
|---|---|
input - CreateFinancialDisclosureStatementInput!
|
Example
Query
mutation createFinancialDisclosureStatement($input: CreateFinancialDisclosureStatementInput!) {
createFinancialDisclosureStatement(input: $input) {
id
deletedAt
approvedAt
deniedAt
status
requiresApproval
hasFinancialRelationships
agreesToDisclose
doesAttest
initials
signatureDate
createdAt
updatedAt
user {
...UserFragment
}
relationships {
...FinancialDisclosureFragment
}
}
}
Variables
{"input": CreateFinancialDisclosureStatementInput}
Response
{
"data": {
"createFinancialDisclosureStatement": {
"id": "4",
"deletedAt": "10:15:30Z",
"approvedAt": "10:15:30Z",
"deniedAt": "10:15:30Z",
"status": "approved",
"requiresApproval": true,
"hasFinancialRelationships": true,
"agreesToDisclose": true,
"doesAttest": true,
"initials": "abc123",
"signatureDate": "10:15:30Z",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"relationships": [FinancialDisclosure]
}
}
}
createImportSocialLoginURL
Response
Returns a String!
Example
Query
mutation createImportSocialLoginURL {
createImportSocialLoginURL
}
Response
{"data": {"createImportSocialLoginURL": {}}}
createInstagramConnection
Response
Returns an AccountConnection
Arguments
| Name | Description |
|---|---|
username - String!
|
Example
Query
mutation createInstagramConnection($username: String!) {
createInstagramConnection(username: $username) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"username": "xyz789"}
Response
{
"data": {
"createInstagramConnection": {
"id": "4",
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "abc123",
"userID": "4",
"username": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
createLearningObjective
Response
Returns a LearningObjective!
Arguments
| Name | Description |
|---|---|
input - CreateLearningObjectiveInput!
|
Example
Query
mutation createLearningObjective($input: CreateLearningObjectiveInput!) {
createLearningObjective(input: $input) {
id
name
surveyQuestion
tenant {
...TenantFragment
}
posts {
...PostFragment
}
educationCredits {
...EducationCreditFragment
}
certificateSurveyQuestions {
...CertificateSurveyQuestionFragment
}
videos {
...VideoFragment
}
postlearningobjectives {
...PostLearningObjectiveFragment
}
}
}
Variables
{"input": CreateLearningObjectiveInput}
Response
{
"data": {
"createLearningObjective": {
"id": "4",
"name": "xyz789",
"surveyQuestion": "abc123",
"tenant": Tenant,
"posts": [Post],
"educationCredits": [EducationCredit],
"certificateSurveyQuestions": [
CertificateSurveyQuestion
],
"videos": [Video],
"postlearningobjectives": [PostLearningObjective]
}
}
}
createLicenseHistory
Description
Creates a new LicenseHistory entry for the current user
Response
Returns a LicenseHistory!
Arguments
| Name | Description |
|---|---|
input - CreateLicenseHistoryInput!
|
Example
Query
mutation createLicenseHistory($input: CreateLicenseHistoryInput!) {
createLicenseHistory(input: $input) {
id
institution
title
startDate
endDate
user {
...UserFragment
}
}
}
Variables
{"input": CreateLicenseHistoryInput}
Response
{
"data": {
"createLicenseHistory": {
"id": 4,
"institution": "xyz789",
"title": "xyz789",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"user": User
}
}
}
createMedia
Description
Creates a MediaItem entry representing a file store in Cloudinary
Response
Returns a MediaItem!
Arguments
| Name | Description |
|---|---|
input - CreateMediaItemInput!
|
The fields to use when creating the media item |
Example
Query
mutation createMedia($input: CreateMediaItemInput!) {
createMedia(input: $input) {
id
publicID
width
height
bytes
format
mediaType
url
originalFilename
ordinal
duration
post {
...PostFragment
}
}
}
Variables
{"input": CreateMediaItemInput}
Response
{
"data": {
"createMedia": {
"id": "4",
"publicID": "xyz789",
"width": 987,
"height": 987,
"bytes": 987,
"format": "abc123",
"mediaType": "xyz789",
"url": "abc123",
"originalFilename": "abc123",
"ordinal": 987,
"duration": 987,
"post": Post
}
}
}
createOffice
Response
Returns an Office!
Arguments
| Name | Description |
|---|---|
input - CreateOfficeInput!
|
Example
Query
mutation createOffice($input: CreateOfficeInput!) {
createOffice(input: $input) {
id
primary
address1
address2
city
stateCode
zip
countryCode
phone
fax
email
user {
...UserFragment
}
}
}
Variables
{"input": CreateOfficeInput}
Response
{
"data": {
"createOffice": {
"id": "4",
"primary": true,
"address1": "xyz789",
"address2": "xyz789",
"city": "abc123",
"stateCode": "xyz789",
"zip": "xyz789",
"countryCode": "xyz789",
"phone": "abc123",
"fax": "xyz789",
"email": "abc123",
"user": User
}
}
}
createPost
Description
Creates a post for the current user
Response
Returns a Post!
Arguments
| Name | Description |
|---|---|
input - CreatePostInput!
|
The fields to use when creating the post |
Example
Query
mutation createPost($input: CreatePostInput!) {
createPost(input: $input) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"input": CreatePostInput}
Response
{
"data": {
"createPost": {
"id": "4",
"title": "xyz789",
"suggestedTitle": "abc123",
"creditHours": 987.65,
"status": "draft",
"body": "xyz789",
"suggestedBody": "abc123",
"totalVideos": 123,
"totalImages": 123,
"totalDuration": 123,
"totalLikes": 987,
"totalComments": 123,
"totalReactions": 987,
"totalBookmarks": 987,
"speakMediaID": "abc123",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 987,
"termsPerMinute": 987.65,
"terms": ["abc123"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": false,
"topicClassifications": [TopicClassification]
}
}
}
createPostFromImportedVideo
Example
Query
mutation createPostFromImportedVideo(
$videoID: String!,
$title: String,
$body: String
) {
createPostFromImportedVideo(
videoID: $videoID,
title: $title,
body: $body
) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{
"videoID": "abc123",
"title": "xyz789",
"body": "abc123"
}
Response
{
"data": {
"createPostFromImportedVideo": {
"id": 4,
"title": "xyz789",
"suggestedTitle": "abc123",
"creditHours": 123.45,
"status": "draft",
"body": "abc123",
"suggestedBody": "xyz789",
"totalVideos": 123,
"totalImages": 987,
"totalDuration": 123,
"totalLikes": 123,
"totalComments": 987,
"totalReactions": 987,
"totalBookmarks": 123,
"speakMediaID": "abc123",
"featured": true,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 987,
"termsPerMinute": 987.65,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
createPostReaction
Description
Creates a PostReaction for the specified post and current user
Response
Returns a PostReaction!
Arguments
| Name | Description |
|---|---|
input - PostReactionInput!
|
The fields to use when creating the post reaction |
Example
Query
mutation createPostReaction($input: PostReactionInput!) {
createPostReaction(input: $input) {
id
reactedAt
value
userID
postID
user {
...UserFragment
}
post {
...PostFragment
}
}
}
Variables
{"input": PostReactionInput}
Response
{
"data": {
"createPostReaction": {
"id": "4",
"reactedAt": "10:15:30Z",
"value": "abc123",
"userID": "4",
"postID": 4,
"user": User,
"post": Post
}
}
}
createPostsFromConnection
createPubmedTopicCluster
Response
Returns a PubmedTopicCluster
Arguments
| Name | Description |
|---|---|
input - CreatePubmedTopicClusterInput!
|
Example
Query
mutation createPubmedTopicCluster($input: CreatePubmedTopicClusterInput!) {
createPubmedTopicCluster(input: $input) {
id
clusterID
clusterLabel
label
clusterWords
pubmedArticles {
...PubmedArticleFragment
}
topics {
...TopicFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"input": CreatePubmedTopicClusterInput}
Response
{
"data": {
"createPubmedTopicCluster": {
"id": "4",
"clusterID": 987,
"clusterLabel": "abc123",
"label": "xyz789",
"clusterWords": ["abc123"],
"pubmedArticles": [PubmedArticle],
"topics": [Topic],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
createReply
Response
Returns a SparkyMessage!
Example
Query
mutation createReply(
$conversationId: ID!,
$content: String!
) {
createReply(
conversationId: $conversationId,
content: $content
) {
id
body
sentBySparky
invalidMessage
shouldEarnCredits
reflectionAnalysisResultsV1 {
...ReflectionResultFragment
}
createdAt
updatedAt
promptValue
conversation {
...SparkyConversationFragment
}
addendum {
...SparkyMessageAddendumFragment
}
}
}
Variables
{
"conversationId": "4",
"content": "xyz789"
}
Response
{
"data": {
"createReply": {
"id": "4",
"body": "abc123",
"sentBySparky": false,
"invalidMessage": true,
"shouldEarnCredits": true,
"reflectionAnalysisResultsV1": ReflectionResult,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"promptValue": "abc123",
"conversation": SparkyConversation,
"addendum": [SparkyMessageAddendum]
}
}
}
createSearchConversion
Description
Creates a SearchConversion for a SearchResult. This is used to track when a user clicks on a search result.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - SearchConversionInput!
|
Example
Query
mutation createSearchConversion($input: SearchConversionInput!) {
createSearchConversion(input: $input)
}
Variables
{"input": SearchConversionInput}
Response
{"data": {"createSearchConversion": {}}}
createShortcode
Example
Query
mutation createShortcode($url: String!) {
createShortcode(url: $url) {
id
url
code
title
body
summary
discussionPoints
status
createdAt
updatedAt
}
}
Variables
{"url": "abc123"}
Response
{
"data": {
"createShortcode": {
"id": "4",
"url": "abc123",
"code": "abc123",
"title": "xyz789",
"body": "abc123",
"summary": "xyz789",
"discussionPoints": ["abc123"],
"status": "generating",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
createTopic
Response
Returns a Topic!
Arguments
| Name | Description |
|---|---|
input - CreateTopicInput!
|
Example
Query
mutation createTopic($input: CreateTopicInput!) {
createTopic(input: $input) {
id
name
ordinal
type
modelID
modelVersion
totalPosts
words
wordFrequencies
generatedLabel
clusterID
clusterLabel
tenant {
...TenantFragment
}
cover {
...MediaItemFragment
}
coverImage {
...ImageFragment
}
users {
...UserFragment
}
classifications {
...TopicClassificationFragment
}
posts {
...PostFragment
}
pubmedArticles {
...PubmedArticleFragment
}
npiTaxonomies {
...NpiTaxonomyFragment
}
parent {
...TopicFragment
}
children {
...TopicFragment
}
pubmedTopicClusters {
...PubmedTopicClusterFragment
}
topicNpiTaxonomies {
...TopicNpiTaxonomyFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"input": CreateTopicInput}
Response
{
"data": {
"createTopic": {
"id": "4",
"name": "abc123",
"ordinal": 987,
"type": "specialty",
"modelID": "xyz789",
"modelVersion": "xyz789",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "xyz789",
"clusterID": 987,
"clusterLabel": "xyz789",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
createUser
Description
Creates a new user. Can be an admin or a regular user
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - CreateUserInput!
|
Example
Query
mutation createUser($input: CreateUserInput!) {
createUser(input: $input) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"input": CreateUserInput}
Response
{
"data": {
"createUser": {
"id": 4,
"firstName": "xyz789",
"lastName": "abc123",
"disabled": false,
"status": "active",
"phone": "xyz789",
"email": "xyz789",
"username": "abc123",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": false,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
createUserLink
Description
Creates a new link for the current users bio
Response
Returns a UserLink!
Arguments
| Name | Description |
|---|---|
input - CreateUserLinkInput!
|
Example
Query
mutation createUserLink($input: CreateUserLinkInput!) {
createUserLink(input: $input) {
id
title
url
ordinal
user {
...UserFragment
}
}
}
Variables
{"input": CreateUserLinkInput}
Response
{
"data": {
"createUserLink": {
"id": "4",
"title": "abc123",
"url": "xyz789",
"ordinal": 123,
"user": User
}
}
}
createVerificationRequest
Description
Create a pending verification request for the current user. Returns an upload URL to upload the verification document to, and a VerificationRequest object in a waiting state.
Response
Returns a VerificationRequestResult!
Example
Query
mutation createVerificationRequest {
createVerificationRequest {
url
verificationRequest {
...VerificationRequestFragment
}
}
}
Response
{
"data": {
"createVerificationRequest": {
"url": "abc123",
"verificationRequest": VerificationRequest
}
}
}
createVideoCompletion
Response
Returns an EducationCredit!
Arguments
| Name | Description |
|---|---|
postID - ID!
|
Example
Query
mutation createVideoCompletion($postID: ID!) {
createVideoCompletion(postID: $postID) {
id
value
deletedAt
redeemedAt
deletedReason
createdAt
updatedAt
survey
userID
sparkyConversationID
postID
commentID
type
tenant {
...TenantFragment
}
user {
...UserFragment
}
comment {
...CommentFragment
}
post {
...PostFragment
}
sparkyConversation {
...SparkyConversationFragment
}
learningObjective {
...LearningObjectiveFragment
}
deletedBy {
...UserFragment
}
userCollectionCompletions {
...UserCollectionCompletionFragment
}
certificate {
...CertificateFragment
}
}
}
Variables
{"postID": "4"}
Response
{
"data": {
"createVideoCompletion": {
"id": 4,
"value": 123.45,
"deletedAt": "10:15:30Z",
"redeemedAt": "10:15:30Z",
"deletedReason": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"survey": Map,
"userID": "4",
"sparkyConversationID": 4,
"postID": "4",
"commentID": 4,
"type": "reflection",
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"sparkyConversation": SparkyConversation,
"learningObjective": LearningObjective,
"deletedBy": User,
"userCollectionCompletions": [
UserCollectionCompletion
],
"certificate": Certificate
}
}
}
createVideoEvent
Description
Send START and END events for tracking video completions to earn CE credits.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
videoId - ID!
|
|
type - VideoEventType!
|
Example
Query
mutation createVideoEvent(
$videoId: ID!,
$type: VideoEventType!
) {
createVideoEvent(
videoId: $videoId,
type: $type
)
}
Variables
{"videoId": "4", "type": "PLAY"}
Response
{"data": {"createVideoEvent": {}}}
createWorkExperience
Description
Creates a new WorkExperience entry for the current user
Response
Returns a WorkExperience!
Arguments
| Name | Description |
|---|---|
input - CreateWorkExperienceInput!
|
Example
Query
mutation createWorkExperience($input: CreateWorkExperienceInput!) {
createWorkExperience(input: $input) {
id
institution
specialty
title
employment
startDate
endDate
city
state
user {
...UserFragment
}
}
}
Variables
{"input": CreateWorkExperienceInput}
Response
{
"data": {
"createWorkExperience": {
"id": "4",
"institution": "abc123",
"specialty": "abc123",
"title": "abc123",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "abc123",
"state": "abc123",
"user": User
}
}
}
createYoutubeConnection
Response
Returns an AccountConnection
Arguments
| Name | Description |
|---|---|
username - String!
|
Example
Query
mutation createYoutubeConnection($username: String!) {
createYoutubeConnection(username: $username) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"username": "abc123"}
Response
{
"data": {
"createYoutubeConnection": {
"id": "4",
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "abc123",
"userID": "4",
"username": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
deleteCertificateSurveyQuestionChoice
deleteCollection
deleteComment
Description
Delete a comment by ID. Admins can delete any comment, users can only delete their own comments
deleteCourse
deleteEducationHistory
Description
Deletes a EducationHistory entry for the current user
Response
Returns an EducationHistory!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteEducationHistory($id: ID!) {
deleteEducationHistory(id: $id) {
id
institution
degree
major
startDate
endDate
type
user {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteEducationHistory": {
"id": "4",
"institution": "xyz789",
"degree": "abc123",
"major": "abc123",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"type": "education",
"user": User
}
}
}
deleteFinancialDisclosureStatement
deleteInstagramConnection
Response
Returns an AccountConnection
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation deleteInstagramConnection($id: Int!) {
deleteInstagramConnection(id: $id) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"deleteInstagramConnection": {
"id": 4,
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "xyz789",
"profilePictureURL": "xyz789",
"userID": "4",
"username": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
deleteLicenseHistory
Description
Deletes a LicenseHistory entry for the current user
Response
Returns a LicenseHistory!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteLicenseHistory($id: ID!) {
deleteLicenseHistory(id: $id) {
id
institution
title
startDate
endDate
user {
...UserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteLicenseHistory": {
"id": 4,
"institution": "xyz789",
"title": "abc123",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"user": User
}
}
}
deletePost
deletePubmedTopicCluster
Response
Returns a PubmedTopicCluster
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deletePubmedTopicCluster($id: ID!) {
deletePubmedTopicCluster(id: $id) {
id
clusterID
clusterLabel
label
clusterWords
pubmedArticles {
...PubmedArticleFragment
}
topics {
...TopicFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"deletePubmedTopicCluster": {
"id": "4",
"clusterID": 123,
"clusterLabel": "abc123",
"label": "xyz789",
"clusterWords": ["xyz789"],
"pubmedArticles": [PubmedArticle],
"topics": [Topic],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
deleteTopic
deleteUserLink
Description
Deletes a link for the current users bio
Example
Query
mutation deleteUserLink($id: ID!) {
deleteUserLink(id: $id) {
id
title
url
ordinal
user {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteUserLink": {
"id": 4,
"title": "xyz789",
"url": "xyz789",
"ordinal": 987,
"user": User
}
}
}
deleteWorkExperience
Description
Deletes a WorkExperience entry for the current user
Response
Returns a WorkExperience!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteWorkExperience($id: ID!) {
deleteWorkExperience(id: $id) {
id
institution
specialty
title
employment
startDate
endDate
city
state
user {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deleteWorkExperience": {
"id": 4,
"institution": "xyz789",
"specialty": "xyz789",
"title": "abc123",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "abc123",
"state": "abc123",
"user": User
}
}
}
deleteYoutubeConnection
Response
Returns an AccountConnection
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation deleteYoutubeConnection($id: Int!) {
deleteYoutubeConnection(id: $id) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"deleteYoutubeConnection": {
"id": 4,
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "abc123",
"userID": "4",
"username": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
followTopic
Description
Follow a single Topic
Example
Query
mutation followTopic($id: ID!) {
followTopic(id: $id) {
id
name
ordinal
type
modelID
modelVersion
totalPosts
words
wordFrequencies
generatedLabel
clusterID
clusterLabel
tenant {
...TenantFragment
}
cover {
...MediaItemFragment
}
coverImage {
...ImageFragment
}
users {
...UserFragment
}
classifications {
...TopicClassificationFragment
}
posts {
...PostFragment
}
pubmedArticles {
...PubmedArticleFragment
}
npiTaxonomies {
...NpiTaxonomyFragment
}
parent {
...TopicFragment
}
children {
...TopicFragment
}
pubmedTopicClusters {
...PubmedTopicClusterFragment
}
topicNpiTaxonomies {
...TopicNpiTaxonomyFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"followTopic": {
"id": 4,
"name": "abc123",
"ordinal": 123,
"type": "specialty",
"modelID": "abc123",
"modelVersion": "abc123",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "abc123",
"clusterID": 123,
"clusterLabel": "xyz789",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
followTopics
Description
Follow multiple topics
Example
Query
mutation followTopics($ids: [ID!]) {
followTopics(ids: $ids) {
id
name
ordinal
type
modelID
modelVersion
totalPosts
words
wordFrequencies
generatedLabel
clusterID
clusterLabel
tenant {
...TenantFragment
}
cover {
...MediaItemFragment
}
coverImage {
...ImageFragment
}
users {
...UserFragment
}
classifications {
...TopicClassificationFragment
}
posts {
...PostFragment
}
pubmedArticles {
...PubmedArticleFragment
}
npiTaxonomies {
...NpiTaxonomyFragment
}
parent {
...TopicFragment
}
children {
...TopicFragment
}
pubmedTopicClusters {
...PubmedTopicClusterFragment
}
topicNpiTaxonomies {
...TopicNpiTaxonomyFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"followTopics": [
{
"id": 4,
"name": "xyz789",
"ordinal": 987,
"type": "specialty",
"modelID": "xyz789",
"modelVersion": "xyz789",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "xyz789",
"clusterID": 987,
"clusterLabel": "xyz789",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [
TopicPubmedTopicCluster
]
}
]
}
}
followUser
Description
Follows a user
Example
Query
mutation followUser($id: ID!) {
followUser(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"followUser": {
"id": "4",
"firstName": "abc123",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "abc123",
"email": "xyz789",
"username": "abc123",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "xyz789",
"isStudent": false,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 123,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
generateFileReplaceURL
Response
Returns a FileUploadResponse!
Example
Query
mutation generateFileReplaceURL(
$id: ID!,
$contentType: String!
) {
generateFileReplaceURL(
id: $id,
contentType: $contentType
) {
url
file {
...UploadFragment
}
}
}
Variables
{"id": 4, "contentType": "abc123"}
Response
{
"data": {
"generateFileReplaceURL": {
"url": "abc123",
"file": Upload
}
}
}
generateFileUploadURL
Description
Generate a URL that can be used to upload a file to S3, for admins only.
Response
Returns a FileUploadResponse!
Example
Query
mutation generateFileUploadURL(
$fileName: String!,
$contentType: String!
) {
generateFileUploadURL(
fileName: $fileName,
contentType: $contentType
) {
url
file {
...UploadFragment
}
}
}
Variables
{
"fileName": "xyz789",
"contentType": "abc123"
}
Response
{
"data": {
"generateFileUploadURL": {
"url": "abc123",
"file": Upload
}
}
}
generateImageUploadURL
Description
Generates a URL that can be used to upload an image to Cloudflare
Response
Returns an ImageUploadResponse!
Example
Query
mutation generateImageUploadURL {
generateImageUploadURL {
url
image {
...ImageFragment
}
}
}
Response
{
"data": {
"generateImageUploadURL": {
"url": "xyz789",
"image": Image
}
}
}
generateVideoUploadURL
Description
Generates a URL that can be used to upload a video to Cloudflare (https://developers.cloudflare.com/stream/uploading-videos/direct-creator-uploads#basic-upload-flow-for-small-videos) Also returns a draft Video object with a status of "waiting". After the video has been uploaded and ready to stream, the status will change to "ready".
Response
Returns a VideoUploadResponse!
Example
Query
mutation generateVideoUploadURL {
generateVideoUploadURL {
url
video {
...VideoFragment
}
}
}
Response
{
"data": {
"generateVideoUploadURL": {
"url": "abc123",
"video": Video
}
}
}
likeComment
Description
Creates a Like for the specified comment and current user. If the user has already liked the comment, this will return the existing like.
Response
Returns a CommentLike!
Arguments
| Name | Description |
|---|---|
input - LikeCommentInput!
|
The fields to use when creating the like |
Example
Query
mutation likeComment($input: LikeCommentInput!) {
likeComment(input: $input) {
id
likedAt
userID
commentID
user {
...UserFragment
}
comment {
...CommentFragment
}
}
}
Variables
{"input": LikeCommentInput}
Response
{
"data": {
"likeComment": {
"id": "4",
"likedAt": "10:15:30Z",
"userID": "4",
"commentID": "4",
"user": User,
"comment": Comment
}
}
}
likePost
Description
Creates a Like for the specified post and current user. If the user has already liked the post, this will return the existing like.
Response
Returns a Like!
Arguments
| Name | Description |
|---|---|
input - LikePostInput!
|
The fields to use when creating the like |
Example
Query
mutation likePost($input: LikePostInput!) {
likePost(input: $input) {
id
likedAt
userID
postID
user {
...UserFragment
}
post {
...PostFragment
}
}
}
Variables
{"input": LikePostInput}
Response
{
"data": {
"likePost": {
"id": 4,
"likedAt": "10:15:30Z",
"userID": 4,
"postID": "4",
"user": User,
"post": Post
}
}
}
login
Description
Returns an Auth token and the current user for the given phone verification token
Response
Returns a LoginResponse!
Arguments
| Name | Description |
|---|---|
phoneVerificationToken - String!
|
Example
Query
mutation login($phoneVerificationToken: String!) {
login(phoneVerificationToken: $phoneVerificationToken) {
token
expiresAt
user {
...UserFragment
}
}
}
Variables
{"phoneVerificationToken": "abc123"}
Response
{
"data": {
"login": {
"token": "xyz789",
"expiresAt": "10:15:30Z",
"user": User
}
}
}
loginWithOTP
Description
Return an Auth token and the current user for the given phone number and OTP
Response
Returns a LoginResponse!
Example
Query
mutation loginWithOTP(
$phone: String!,
$otp: String!
) {
loginWithOTP(
phone: $phone,
otp: $otp
) {
token
expiresAt
user {
...UserFragment
}
}
}
Variables
{
"phone": "xyz789",
"otp": "abc123"
}
Response
{
"data": {
"loginWithOTP": {
"token": "xyz789",
"expiresAt": "10:15:30Z",
"user": User
}
}
}
markAllNotificationsAsRead
Description
Marks all Notifications as read, for the current user
Response
Returns a Boolean!
Example
Query
mutation markAllNotificationsAsRead {
markAllNotificationsAsRead
}
Response
{"data": {"markAllNotificationsAsRead": {}}}
markNotificationsAsRead
Description
Marks a Notification as read, for the current user
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - MarkNotificationsAsRead!
|
Example
Query
mutation markNotificationsAsRead($input: MarkNotificationsAsRead!) {
markNotificationsAsRead(input: $input)
}
Variables
{"input": MarkNotificationsAsRead}
Response
{"data": {"markNotificationsAsRead": {}}}
muteUser
Description
Mutes the specified user for the current user. Muting a user will hide their posts from the current user's feed. Muted users won't know they are muted.
Example
Query
mutation muteUser($id: ID!) {
muteUser(id: $id) {
id
createdAt
mutedUser {
...UserFragment
}
owner {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"muteUser": {
"id": "4",
"createdAt": "10:15:30Z",
"mutedUser": User,
"owner": User
}
}
}
refreshInstagramConnection
Response
Returns an AccountConnection
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation refreshInstagramConnection($id: Int!) {
refreshInstagramConnection(id: $id) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"refreshInstagramConnection": {
"id": "4",
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "xyz789",
"userID": 4,
"username": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
refreshYoutubeConnection
Response
Returns an AccountConnection
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation refreshYoutubeConnection($id: Int!) {
refreshYoutubeConnection(id: $id) {
id
connectionStatus
importStatus
exportStatus
type
accountID
profilePictureURL
userID
username
createdAt
updatedAt
user {
...UserFragment
}
importedVideos {
...ImportedVideoFragment
}
instagramScrapeLogs {
...InstagramScrapeLogFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"refreshYoutubeConnection": {
"id": "4",
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "xyz789",
"userID": 4,
"username": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
}
}
registerNotificationToken
Description
Registers a device token for push notifications for the current user
Example
Query
mutation registerNotificationToken(
$token: String!,
$platform: String!
) {
registerNotificationToken(
token: $token,
platform: $platform
)
}
Variables
{
"token": "abc123",
"platform": "abc123"
}
Response
{"data": {"registerNotificationToken": {}}}
removeAudience
removeBookmark
Description
Removes a Bookmark for the specified post and current user
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - BookmarkPostInput!
|
Example
Query
mutation removeBookmark($input: BookmarkPostInput!) {
removeBookmark(input: $input)
}
Variables
{"input": BookmarkPostInput}
Response
{"data": {"removeBookmark": {}}}
removeOffice
removePostFromCollection
Response
Returns a Collection!
Example
Query
mutation removePostFromCollection(
$collectionId: ID!,
$postId: ID!
) {
removePostFromCollection(
collectionId: $collectionId,
postId: $postId
) {
id
name
description
totalDuration
totalPosts
tenant {
...TenantFragment
}
postcollections {
...PostCollectionFragment
}
cover {
...ImageFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
posts {
...PostFragment
}
educationCredit {
...EducationCreditFragment
}
userCompletion {
...UserCollectionCompletionFragment
}
}
}
Variables
{
"collectionId": "4",
"postId": "4"
}
Response
{
"data": {
"removePostFromCollection": {
"id": "4",
"name": "xyz789",
"description": "xyz789",
"totalDuration": 123,
"totalPosts": 123,
"tenant": Tenant,
"postcollections": [PostCollection],
"cover": Image,
"userCompletions": [UserCollectionCompletion],
"posts": [Post],
"educationCredit": EducationCredit,
"userCompletion": UserCollectionCompletion
}
}
}
reportPost
Description
Reports a post specified by ID
Response
Returns a PostReport!
Example
Query
mutation reportPost(
$id: ID!,
$reasonID: ID!,
$description: String
) {
reportPost(
id: $id,
reasonID: $reasonID,
description: $description
) {
id
description
createdAt
reviewedAt
reportReason {
...ReportReasonFragment
}
author {
...UserFragment
}
reportedPost {
...PostFragment
}
reviewedBy {
...UserFragment
}
}
}
Variables
{
"id": "4",
"reasonID": "4",
"description": "xyz789"
}
Response
{
"data": {
"reportPost": {
"id": "4",
"description": "abc123",
"createdAt": "10:15:30Z",
"reviewedAt": "10:15:30Z",
"reportReason": ReportReason,
"author": User,
"reportedPost": Post,
"reviewedBy": User
}
}
}
reportUser
Description
Reports a user specified by ID
Response
Returns a UserReport!
Example
Query
mutation reportUser(
$id: ID!,
$reasonID: ID!,
$description: String
) {
reportUser(
id: $id,
reasonID: $reasonID,
description: $description
) {
id
description
createdAt
reviewedAt
reportReason {
...ReportReasonFragment
}
author {
...UserFragment
}
reportedUser {
...UserFragment
}
reviewedBy {
...UserFragment
}
}
}
Variables
{
"id": 4,
"reasonID": 4,
"description": "xyz789"
}
Response
{
"data": {
"reportUser": {
"id": "4",
"description": "abc123",
"createdAt": "10:15:30Z",
"reviewedAt": "10:15:30Z",
"reportReason": ReportReason,
"author": User,
"reportedUser": User,
"reviewedBy": User
}
}
}
sendPhoneOTP
Description
Sends a phone OTP to the given phone number. Exchange the OTP for a JWT auth token
signup
Description
Creates a new user with the User role
Response
Returns a LoginResponse
Arguments
| Name | Description |
|---|---|
input - SignupInput!
|
Example
Query
mutation signup($input: SignupInput!) {
signup(input: $input) {
token
expiresAt
user {
...UserFragment
}
}
}
Variables
{"input": SignupInput}
Response
{
"data": {
"signup": {
"token": "abc123",
"expiresAt": "10:15:30Z",
"user": User
}
}
}
signupWithoutNPI
Description
Creates a new user with the User role, with a status of 'pending'. Users created with this method will not be able to login until they are approved by an admin.
Response
Returns a LoginResponse
Arguments
| Name | Description |
|---|---|
input - SignupWithoutNPIInput!
|
Example
Query
mutation signupWithoutNPI($input: SignupWithoutNPIInput!) {
signupWithoutNPI(input: $input) {
token
expiresAt
user {
...UserFragment
}
}
}
Variables
{"input": SignupWithoutNPIInput}
Response
{
"data": {
"signupWithoutNPI": {
"token": "abc123",
"expiresAt": "10:15:30Z",
"user": User
}
}
}
submitCollectonSurvey
Example
Query
mutation submitCollectonSurvey(
$collectionId: ID!,
$data: Any!
) {
submitCollectonSurvey(
collectionId: $collectionId,
data: $data
)
}
Variables
{"collectionId": 4, "data": Any}
Response
{"data": {"submitCollectonSurvey": {}}}
submitVerificationRequest
Description
Submits a verification request for the current user. The verification document must be uploaded to the URL returned by generateVerificationRequest first.
Response
Returns a VerificationRequest!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - SubmitVerificationRequestInput!
|
Example
Query
mutation submitVerificationRequest(
$id: ID!,
$input: SubmitVerificationRequestInput!
) {
submitVerificationRequest(
id: $id,
input: $input
) {
id
dob
zip
storageKey
url
status
createdAt
updatedAt
user {
...UserFragment
}
}
}
Variables
{
"id": "4",
"input": SubmitVerificationRequestInput
}
Response
{
"data": {
"submitVerificationRequest": {
"id": 4,
"dob": "xyz789",
"zip": "xyz789",
"storageKey": "abc123",
"url": "abc123",
"status": "waiting",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User
}
}
}
unLikeComment
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - LikeCommentInput!
|
Example
Query
mutation unLikeComment($input: LikeCommentInput!) {
unLikeComment(input: $input)
}
Variables
{"input": LikeCommentInput}
Response
{"data": {"unLikeComment": {}}}
unLikePost
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - LikePostInput!
|
Example
Query
mutation unLikePost($input: LikePostInput!) {
unLikePost(input: $input)
}
Variables
{"input": LikePostInput}
Response
{"data": {"unLikePost": {}}}
unblockUser
Description
Unblocks the specified user for the current user.
Example
Query
mutation unblockUser($id: ID!) {
unblockUser(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"unblockUser": {
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "xyz789",
"email": "abc123",
"username": "xyz789",
"credential": "xyz789",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": false,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 123,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
unfollowUser
Description
Unfollows a user
unmuteUser
Description
Unmute the specified user for the current user.
Example
Query
mutation unmuteUser($id: ID!) {
unmuteUser(id: $id) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"unmuteUser": {
"id": 4,
"firstName": "xyz789",
"lastName": "abc123",
"disabled": true,
"status": "active",
"phone": "abc123",
"email": "xyz789",
"username": "xyz789",
"credential": "xyz789",
"npiNumber": "xyz789",
"npiTaxonomyCode": "abc123",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": true,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
unregisterNotificationToken
Description
Unregisters a device token for push notifications for the current user
Example
Query
mutation unregisterNotificationToken(
$token: String!,
$platform: String!
) {
unregisterNotificationToken(
token: $token,
platform: $platform
)
}
Variables
{
"token": "xyz789",
"platform": "xyz789"
}
Response
{"data": {"unregisterNotificationToken": {}}}
updateAudience
Response
Returns an Audience!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateAudienceInput!
|
Example
Query
mutation updateAudience(
$id: ID!,
$input: UpdateAudienceInput!
) {
updateAudience(
id: $id,
input: $input
) {
id
name
designationtemplate
createdAt
updatedAt
npiTaxonomies {
...NpiTaxonomyFragment
}
posts {
...PostFragment
}
tenant {
...TenantFragment
}
designation
}
}
Variables
{
"id": "4",
"input": UpdateAudienceInput
}
Response
{
"data": {
"updateAudience": {
"id": 4,
"name": "xyz789",
"designationtemplate": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"npiTaxonomies": [NpiTaxonomy],
"posts": [Post],
"tenant": Tenant,
"designation": "abc123"
}
}
}
updateCertificateSurveyQuestion
Response
Returns a CertificateSurveyQuestion!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateCertificateSurveyQuestionInput!
|
Example
Query
mutation updateCertificateSurveyQuestion(
$id: ID!,
$input: UpdateCertificateSurveyQuestionInput!
) {
updateCertificateSurveyQuestion(
id: $id,
input: $input
) {
id
question
createdAt
updatedAt
learningObjective {
...LearningObjectiveFragment
}
choices {
...CertificateSurveyQuestionChoiceFragment
}
}
}
Variables
{"id": 4, "input": UpdateCertificateSurveyQuestionInput}
Response
{
"data": {
"updateCertificateSurveyQuestion": {
"id": "4",
"question": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"learningObjective": LearningObjective,
"choices": [CertificateSurveyQuestionChoice]
}
}
}
updateCertificateSurveyQuestionChoice
Response
Returns a CertificateSurveyQuestionChoice!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateCertificateSurveyQuestionChoiceInput!
|
Example
Query
mutation updateCertificateSurveyQuestionChoice(
$id: ID!,
$input: UpdateCertificateSurveyQuestionChoiceInput!
) {
updateCertificateSurveyQuestionChoice(
id: $id,
input: $input
) {
id
label
emoji
question {
...CertificateSurveyQuestionFragment
}
}
}
Variables
{
"id": 4,
"input": UpdateCertificateSurveyQuestionChoiceInput
}
Response
{
"data": {
"updateCertificateSurveyQuestionChoice": {
"id": 4,
"label": "xyz789",
"emoji": "xyz789",
"question": CertificateSurveyQuestion
}
}
}
updateCollection
Response
Returns a Collection!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateCollectionInput!
|
Example
Query
mutation updateCollection(
$id: ID!,
$input: UpdateCollectionInput!
) {
updateCollection(
id: $id,
input: $input
) {
id
name
description
totalDuration
totalPosts
tenant {
...TenantFragment
}
postcollections {
...PostCollectionFragment
}
cover {
...ImageFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
posts {
...PostFragment
}
educationCredit {
...EducationCreditFragment
}
userCompletion {
...UserCollectionCompletionFragment
}
}
}
Variables
{"id": 4, "input": UpdateCollectionInput}
Response
{
"data": {
"updateCollection": {
"id": "4",
"name": "xyz789",
"description": "xyz789",
"totalDuration": 123,
"totalPosts": 987,
"tenant": Tenant,
"postcollections": [PostCollection],
"cover": Image,
"userCompletions": [UserCollectionCompletion],
"posts": [Post],
"educationCredit": EducationCredit,
"userCompletion": UserCollectionCompletion
}
}
}
updateCourse
Response
Returns a Course!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateCourseInput!
|
Example
Query
mutation updateCourse(
$id: ID!,
$input: UpdateCourseInput!
) {
updateCourse(
id: $id,
input: $input
) {
id
name
description
disclosure
startDate
creditHours
price
website
isRaceApproved
type
createdAt
status
reviewedAt
author {
...UserFragment
}
faculty {
...UserFragment
}
reviewedBy {
...UserFragment
}
tenant {
...TenantFragment
}
video {
...VideoFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateCourseInput
}
Response
{
"data": {
"updateCourse": {
"id": 4,
"name": "abc123",
"description": "abc123",
"disclosure": "xyz789",
"startDate": "10:15:30Z",
"creditHours": 123.45,
"price": 987.65,
"website": "abc123",
"isRaceApproved": false,
"type": "ondemand",
"createdAt": "10:15:30Z",
"status": "pending",
"reviewedAt": "10:15:30Z",
"author": User,
"faculty": [User],
"reviewedBy": User,
"tenant": Tenant,
"video": Video
}
}
}
updateEducationHistory
Description
Updates a EducationHistory entry for the current user
Response
Returns an EducationHistory!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateEducationHistoryInput!
|
Example
Query
mutation updateEducationHistory(
$id: ID!,
$input: UpdateEducationHistoryInput!
) {
updateEducationHistory(
id: $id,
input: $input
) {
id
institution
degree
major
startDate
endDate
type
user {
...UserFragment
}
}
}
Variables
{"id": 4, "input": UpdateEducationHistoryInput}
Response
{
"data": {
"updateEducationHistory": {
"id": 4,
"institution": "xyz789",
"degree": "abc123",
"major": "xyz789",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"type": "education",
"user": User
}
}
}
updateFileUpload
Response
Returns an Upload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateUploadInput!
|
Example
Query
mutation updateFileUpload(
$id: ID!,
$input: UpdateUploadInput!
) {
updateFileUpload(
id: $id,
input: $input
) {
id
name
bucket
key
url
contentType
createdAt
updatedAt
}
}
Variables
{"id": 4, "input": UpdateUploadInput}
Response
{
"data": {
"updateFileUpload": {
"id": "4",
"name": "xyz789",
"bucket": "xyz789",
"key": "xyz789",
"url": "xyz789",
"contentType": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
}
}
updateFinancialDisclosureStatement
Description
Updates an existing financial disclosure statement for the current user.
Response
Returns a FinancialDisclosureStatement!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateFinancialDisclosureStatementInput!
|
Example
Query
mutation updateFinancialDisclosureStatement(
$id: ID!,
$input: UpdateFinancialDisclosureStatementInput!
) {
updateFinancialDisclosureStatement(
id: $id,
input: $input
) {
id
deletedAt
approvedAt
deniedAt
status
requiresApproval
hasFinancialRelationships
agreesToDisclose
doesAttest
initials
signatureDate
createdAt
updatedAt
user {
...UserFragment
}
relationships {
...FinancialDisclosureFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateFinancialDisclosureStatementInput
}
Response
{
"data": {
"updateFinancialDisclosureStatement": {
"id": "4",
"deletedAt": "10:15:30Z",
"approvedAt": "10:15:30Z",
"deniedAt": "10:15:30Z",
"status": "approved",
"requiresApproval": true,
"hasFinancialRelationships": false,
"agreesToDisclose": true,
"doesAttest": false,
"initials": "abc123",
"signatureDate": "10:15:30Z",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"relationships": [FinancialDisclosure]
}
}
}
updateLearningObjective
Response
Returns a LearningObjective!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateLearningObjectiveInput!
|
Example
Query
mutation updateLearningObjective(
$id: ID!,
$input: UpdateLearningObjectiveInput!
) {
updateLearningObjective(
id: $id,
input: $input
) {
id
name
surveyQuestion
tenant {
...TenantFragment
}
posts {
...PostFragment
}
educationCredits {
...EducationCreditFragment
}
certificateSurveyQuestions {
...CertificateSurveyQuestionFragment
}
videos {
...VideoFragment
}
postlearningobjectives {
...PostLearningObjectiveFragment
}
}
}
Variables
{"id": 4, "input": UpdateLearningObjectiveInput}
Response
{
"data": {
"updateLearningObjective": {
"id": "4",
"name": "abc123",
"surveyQuestion": "abc123",
"tenant": Tenant,
"posts": [Post],
"educationCredits": [EducationCredit],
"certificateSurveyQuestions": [
CertificateSurveyQuestion
],
"videos": [Video],
"postlearningobjectives": [PostLearningObjective]
}
}
}
updateLicenseHistory
Description
Updates a LicenseHistory entry for the current user
Response
Returns a LicenseHistory!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateLicenseHistoryInput!
|
Example
Query
mutation updateLicenseHistory(
$id: ID!,
$input: UpdateLicenseHistoryInput!
) {
updateLicenseHistory(
id: $id,
input: $input
) {
id
institution
title
startDate
endDate
user {
...UserFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateLicenseHistoryInput
}
Response
{
"data": {
"updateLicenseHistory": {
"id": "4",
"institution": "abc123",
"title": "abc123",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"user": User
}
}
}
updateOffice
Response
Returns an Office!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateOfficeInput!
|
Example
Query
mutation updateOffice(
$id: ID!,
$input: UpdateOfficeInput!
) {
updateOffice(
id: $id,
input: $input
) {
id
primary
address1
address2
city
stateCode
zip
countryCode
phone
fax
email
user {
...UserFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateOfficeInput
}
Response
{
"data": {
"updateOffice": {
"id": "4",
"primary": true,
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"stateCode": "abc123",
"zip": "abc123",
"countryCode": "xyz789",
"phone": "abc123",
"fax": "xyz789",
"email": "xyz789",
"user": User
}
}
}
updatePositionsInCollection
Response
Returns a Collection!
Example
Query
mutation updatePositionsInCollection(
$collectionId: ID!,
$postIds: [ID!]
) {
updatePositionsInCollection(
collectionId: $collectionId,
postIds: $postIds
) {
id
name
description
totalDuration
totalPosts
tenant {
...TenantFragment
}
postcollections {
...PostCollectionFragment
}
cover {
...ImageFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
posts {
...PostFragment
}
educationCredit {
...EducationCreditFragment
}
userCompletion {
...UserCollectionCompletionFragment
}
}
}
Variables
{"collectionId": 4, "postIds": [4]}
Response
{
"data": {
"updatePositionsInCollection": {
"id": 4,
"name": "xyz789",
"description": "abc123",
"totalDuration": 123,
"totalPosts": 987,
"tenant": Tenant,
"postcollections": [PostCollection],
"cover": Image,
"userCompletions": [UserCollectionCompletion],
"posts": [Post],
"educationCredit": EducationCredit,
"userCompletion": UserCollectionCompletion
}
}
}
updatePost
Description
Updates the post for the specified id. The post must belong to the current user
Response
Returns a Post!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The id of the post to update |
input - UpdatePostInput!
|
The fields to use when updating the post |
Example
Query
mutation updatePost(
$id: ID!,
$input: UpdatePostInput!
) {
updatePost(
id: $id,
input: $input
) {
id
title
suggestedTitle
creditHours
status
body
suggestedBody
totalVideos
totalImages
totalDuration
totalLikes
totalComments
totalReactions
totalBookmarks
speakMediaID
featured
transcription {
...SpeakInsightResultFragment
}
discussionPoints
topLearningObjectives
createdAt
updatedAt
transcriptionStartedAt
transcriptionCompletedAt
insightsGeneratedAt
sortKey
termsPerMinute
terms
termFrequencies
wordcloud
type
author {
...UserFragment
}
topics {
...TopicFragment
}
citations {
...PostCitationFragment
}
tenant {
...TenantFragment
}
accreditedLearningObjective {
...LearningObjectiveFragment
}
comments {
...CommentFragment
}
mediaItems {
...MediaItemFragment
}
videos {
...VideoFragment
}
coverImage {
...ImageFragment
}
images {
...ImageFragment
}
postCollections {
...PostCollectionFragment
}
educationCredits {
...EducationCreditFragment
}
audiences {
...AudienceFragment
}
tags {
...TagFragment
}
likedUsers {
...UserFragment
}
bookmarkedUsers {
...UserFragment
}
learningObjectives {
...LearningObjectiveFragment
}
postReports {
...PostReportFragment
}
poll {
...PollFragment
}
embeddings {
...PostEmbeddingFragment
}
likes {
...LikeFragment
}
bookmarks {
...BookmarkFragment
}
postlearningobectives {
...PostLearningObjectiveFragment
}
likedAt
bookmarkedAt
commentsDisabled
topicClassifications {
...TopicClassificationFragment
}
}
}
Variables
{"id": 4, "input": UpdatePostInput}
Response
{
"data": {
"updatePost": {
"id": "4",
"title": "xyz789",
"suggestedTitle": "abc123",
"creditHours": 987.65,
"status": "draft",
"body": "abc123",
"suggestedBody": "xyz789",
"totalVideos": 123,
"totalImages": 987,
"totalDuration": 987,
"totalLikes": 123,
"totalComments": 987,
"totalReactions": 987,
"totalBookmarks": 987,
"speakMediaID": "abc123",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 123,
"termsPerMinute": 123.45,
"terms": ["abc123"],
"termFrequencies": Map,
"wordcloud": "xyz789",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
}
}
updateProfile
Description
Updates the profile for the current user
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Example
Query
mutation updateProfile($input: UpdateUserInput!) {
updateProfile(input: $input) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateProfile": {
"id": 4,
"firstName": "abc123",
"lastName": "xyz789",
"disabled": true,
"status": "active",
"phone": "abc123",
"email": "xyz789",
"username": "abc123",
"credential": "abc123",
"npiNumber": "xyz789",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "abc123",
"bio": "xyz789",
"isStudent": true,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": false,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": true,
"financialDisclosures": "abc123",
"isStaff": false,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "abc123",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
updatePubmedTopicCluster
Response
Returns a PubmedTopicCluster
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdatePubmedTopicClusterInput!
|
Example
Query
mutation updatePubmedTopicCluster(
$id: ID!,
$input: UpdatePubmedTopicClusterInput!
) {
updatePubmedTopicCluster(
id: $id,
input: $input
) {
id
clusterID
clusterLabel
label
clusterWords
pubmedArticles {
...PubmedArticleFragment
}
topics {
...TopicFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{
"id": "4",
"input": UpdatePubmedTopicClusterInput
}
Response
{
"data": {
"updatePubmedTopicCluster": {
"id": "4",
"clusterID": 987,
"clusterLabel": "xyz789",
"label": "xyz789",
"clusterWords": ["xyz789"],
"pubmedArticles": [PubmedArticle],
"topics": [Topic],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
updateTopic
Response
Returns a Topic!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateTopicInput!
|
Example
Query
mutation updateTopic(
$id: ID!,
$input: UpdateTopicInput!
) {
updateTopic(
id: $id,
input: $input
) {
id
name
ordinal
type
modelID
modelVersion
totalPosts
words
wordFrequencies
generatedLabel
clusterID
clusterLabel
tenant {
...TenantFragment
}
cover {
...MediaItemFragment
}
coverImage {
...ImageFragment
}
users {
...UserFragment
}
classifications {
...TopicClassificationFragment
}
posts {
...PostFragment
}
pubmedArticles {
...PubmedArticleFragment
}
npiTaxonomies {
...NpiTaxonomyFragment
}
parent {
...TopicFragment
}
children {
...TopicFragment
}
pubmedTopicClusters {
...PubmedTopicClusterFragment
}
topicNpiTaxonomies {
...TopicNpiTaxonomyFragment
}
topicPubmedTopicCluster {
...TopicPubmedTopicClusterFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateTopicInput
}
Response
{
"data": {
"updateTopic": {
"id": "4",
"name": "abc123",
"ordinal": 123,
"type": "specialty",
"modelID": "xyz789",
"modelVersion": "abc123",
"totalPosts": 123,
"words": ["abc123"],
"wordFrequencies": Map,
"generatedLabel": "abc123",
"clusterID": 987,
"clusterLabel": "xyz789",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
}
}
updateUser
Description
Update a user profile
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateUserInput!
|
Example
Query
mutation updateUser(
$id: ID!,
$input: UpdateUserInput!
) {
updateUser(
id: $id,
input: $input
) {
id
firstName
lastName
disabled
status
phone
email
username
credential
npiNumber
npiTaxonomyCode
npiTaxonomyDescription
bio
isStudent
hasSubmittedDisclosure
hasDisclosuresNeedingReview
reflectionsOnAuthoredPostsDisabled
role
limitedRoles
createdAt
updatedAt
lastLoginAt
cmeGoalValue
cmeGoalDate
totalCmeEarned
suggested
financialDisclosures
isStaff
totalFollowers
totalFollowing
tenants {
...TenantFragment
}
topics {
...TopicFragment
}
followers {
...UserFragment
}
following {
...UserFragment
}
posts {
...PostFragment
}
links {
...UserLinkFragment
}
offices {
...OfficeFragment
}
comments {
...CommentFragment
}
likedPosts {
...PostFragment
}
likedComments {
...CommentFragment
}
bookmarkedPosts {
...PostFragment
}
avatar {
...MediaItemFragment
}
profileImage {
...ImageFragment
}
specialty {
...NpiTaxonomyFragment
}
workHistory {
...WorkExperienceFragment
}
educationHistory {
...EducationHistoryFragment
}
licenseHistory {
...LicenseHistoryFragment
}
educationCredits {
...EducationCreditFragment
}
notificationTokens {
...UserNotificationTokenFragment
}
notifications {
...NotificationFragment
}
outgoingNotifications {
...NotificationFragment
}
searches {
...SearchFragment
}
apiTokens {
...ApiTokenFragment
}
userCompletions {
...UserCollectionCompletionFragment
}
financialDisclosureStatement {
...FinancialDisclosureStatementFragment
}
coursesCreated {
...CourseFragment
}
coursesReviewed {
...CourseFragment
}
coursesFaculty {
...CourseFragment
}
userReports {
...UserReportFragment
}
reportedBy {
...UserReportFragment
}
postReports {
...PostReportFragment
}
mutedUsers {
...UserMuteFragment
}
blockedUsers {
...UserBlockFragment
}
accountConnections {
...AccountConnectionFragment
}
importedVideos {
...ImportedVideoFragment
}
userTenants {
...UserTenantFragment
}
likes {
...LikeFragment
}
commentLikes {
...CommentLikeFragment
}
bookmarks {
...BookmarkFragment
}
streamToken
currentTenant {
...TenantFragment
}
npiTaxonomy {
...NpiTaxonomyFragment
}
}
}
Variables
{"id": 4, "input": UpdateUserInput}
Response
{
"data": {
"updateUser": {
"id": 4,
"firstName": "abc123",
"lastName": "abc123",
"disabled": false,
"status": "active",
"phone": "abc123",
"email": "xyz789",
"username": "abc123",
"credential": "xyz789",
"npiNumber": "xyz789",
"npiTaxonomyCode": "abc123",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": false,
"hasSubmittedDisclosure": false,
"hasDisclosuresNeedingReview": false,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "xyz789",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 123.45,
"suggested": false,
"financialDisclosures": "abc123",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 123,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
}
}
updateUserLink
Description
Updates a link for the current users bio
Response
Returns a UserLink!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateUserLinkInput!
|
Example
Query
mutation updateUserLink(
$id: ID!,
$input: UpdateUserLinkInput!
) {
updateUserLink(
id: $id,
input: $input
) {
id
title
url
ordinal
user {
...UserFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateUserLinkInput
}
Response
{
"data": {
"updateUserLink": {
"id": 4,
"title": "abc123",
"url": "abc123",
"ordinal": 123,
"user": User
}
}
}
updateWorkExperience
Description
Updates a WorkExperience entry for the current user
Response
Returns a WorkExperience!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - UpdateWorkExperienceInput!
|
Example
Query
mutation updateWorkExperience(
$id: ID!,
$input: UpdateWorkExperienceInput!
) {
updateWorkExperience(
id: $id,
input: $input
) {
id
institution
specialty
title
employment
startDate
endDate
city
state
user {
...UserFragment
}
}
}
Variables
{
"id": "4",
"input": UpdateWorkExperienceInput
}
Response
{
"data": {
"updateWorkExperience": {
"id": 4,
"institution": "abc123",
"specialty": "xyz789",
"title": "abc123",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "xyz789",
"state": "abc123",
"user": User
}
}
}
verifyPhoneOTP
Description
Verify's the phone number and OTP match
Response
Returns a PhoneVerificationResponse!
Example
Query
mutation verifyPhoneOTP(
$phone: String!,
$otp: String!
) {
verifyPhoneOTP(
phone: $phone,
otp: $otp
) {
token
}
}
Variables
{
"phone": "abc123",
"otp": "abc123"
}
Response
{
"data": {
"verifyPhoneOTP": {"token": "abc123"}
}
}
vote
Example
Query
mutation vote(
$pollID: ID!,
$pollQuestionID: ID!
) {
vote(
pollID: $pollID,
pollQuestionID: $pollQuestionID
) {
id
totalVotes
createdAt
post {
...PostFragment
}
questions {
...PollQuestionFragment
}
}
}
Variables
{"pollID": 4, "pollQuestionID": 4}
Response
{
"data": {
"vote": {
"id": 4,
"totalVotes": 123,
"createdAt": "10:15:30Z",
"post": Post,
"questions": [PollQuestion]
}
}
}
All Types
Abstract
AccountConnection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
connectionStatus - AccountConnectionConnectionStatus!
|
|
importStatus - AccountConnectionImportStatus!
|
|
exportStatus - AccountConnectionExportStatus!
|
|
type - AccountConnectionType!
|
The type of account connection |
accountID - String
|
|
profilePictureURL - String
|
|
userID - ID!
|
|
username - String
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
user - User!
|
The user that owns the account connection |
importedVideos - [ImportedVideo!]
|
The imported videos for this account connection |
instagramScrapeLogs - [InstagramScrapeLog!]
|
The scrape logs for this account connection |
Example
{
"id": "4",
"connectionStatus": "pending",
"importStatus": "complete",
"exportStatus": "idle",
"type": "instagram",
"accountID": "abc123",
"profilePictureURL": "abc123",
"userID": "4",
"username": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"importedVideos": [ImportedVideo],
"instagramScrapeLogs": [InstagramScrapeLog]
}
AccountConnectionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [AccountConnectionEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [AccountConnectionEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AccountConnectionConnectionStatus
Description
AccountConnectionConnectionStatus is enum for the field connection_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
AccountConnectionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - AccountConnection
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": AccountConnection,
"cursor": Cursor
}
AccountConnectionExportStatus
Description
AccountConnectionExportStatus is enum for the field export_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
AccountConnectionImportStatus
Description
AccountConnectionImportStatus is enum for the field import_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
AccountConnectionOrder
Description
Ordering options for AccountConnection connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - AccountConnectionOrderField!
|
The field by which to order AccountConnections. |
Example
{}
AccountConnectionOrderField
Description
Properties by which AccountConnection connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
AccountConnectionType
Description
AccountConnectionType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
AccountConnectionWhereInput
Description
AccountConnectionWhereInput is used for filtering AccountConnection objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - AccountConnectionWhereInput
|
|
and - [AccountConnectionWhereInput!]
|
|
or - [AccountConnectionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
connectionStatus - AccountConnectionConnectionStatus
|
connection_status field predicates |
connectionStatusNEQ - AccountConnectionConnectionStatus
|
|
connectionStatusIn - [AccountConnectionConnectionStatus!]
|
|
connectionStatusNotIn - [AccountConnectionConnectionStatus!]
|
|
importStatus - AccountConnectionImportStatus
|
import_status field predicates |
importStatusNEQ - AccountConnectionImportStatus
|
|
importStatusIn - [AccountConnectionImportStatus!]
|
|
importStatusNotIn - [AccountConnectionImportStatus!]
|
|
exportStatus - AccountConnectionExportStatus
|
export_status field predicates |
exportStatusNEQ - AccountConnectionExportStatus
|
|
exportStatusIn - [AccountConnectionExportStatus!]
|
|
exportStatusNotIn - [AccountConnectionExportStatus!]
|
|
type - AccountConnectionType
|
type field predicates |
typeNEQ - AccountConnectionType
|
|
typeIn - [AccountConnectionType!]
|
|
typeNotIn - [AccountConnectionType!]
|
|
accountID - String
|
account_id field predicates |
accountIDNEQ - String
|
|
accountIDIn - [String!]
|
|
accountIDNotIn - [String!]
|
|
accountIDGT - String
|
|
accountIDGTE - String
|
|
accountIDLT - String
|
|
accountIDLTE - String
|
|
accountIDContains - String
|
|
accountIDHasPrefix - String
|
|
accountIDHasSuffix - String
|
|
accountIDIsNil - Boolean
|
|
accountIDNotNil - Boolean
|
|
accountIDEqualFold - String
|
|
accountIDContainsFold - String
|
|
profilePictureURL - String
|
profile_picture_url field predicates |
profilePictureURLNEQ - String
|
|
profilePictureURLIn - [String!]
|
|
profilePictureURLNotIn - [String!]
|
|
profilePictureURLGT - String
|
|
profilePictureURLGTE - String
|
|
profilePictureURLLT - String
|
|
profilePictureURLLTE - String
|
|
profilePictureURLContains - String
|
|
profilePictureURLHasPrefix - String
|
|
profilePictureURLHasSuffix - String
|
|
profilePictureURLIsNil - Boolean
|
|
profilePictureURLNotNil - Boolean
|
|
profilePictureURLEqualFold - String
|
|
profilePictureURLContainsFold - String
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
username - String
|
username field predicates |
usernameNEQ - String
|
|
usernameIn - [String!]
|
|
usernameNotIn - [String!]
|
|
usernameGT - String
|
|
usernameGTE - String
|
|
usernameLT - String
|
|
usernameLTE - String
|
|
usernameContains - String
|
|
usernameHasPrefix - String
|
|
usernameHasSuffix - String
|
|
usernameIsNil - Boolean
|
|
usernameNotNil - Boolean
|
|
usernameEqualFold - String
|
|
usernameContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasImportedVideos - Boolean
|
imported_videos edge predicates |
hasImportedVideosWith - [ImportedVideoWhereInput!]
|
|
hasInstagramScrapeLogs - Boolean
|
instagram_scrape_logs edge predicates |
hasInstagramScrapeLogsWith - [InstagramScrapeLogWhereInput!]
|
Example
{}
AdminLoginInput
AdminReflectionStatValue
AdminReflectionStats
Fields
| Field Name | Description |
|---|---|
isInquisitive - [AdminReflectionStatValue!]
|
|
isReflective - [AdminReflectionStatValue!]
|
|
isLinguisticallyAcceptable - [AdminReflectionStatValue!]
|
|
isToxic - [AdminReflectionStatValue!]
|
|
containsMedicalTerms - [AdminReflectionStatValue!]
|
|
topEntityGroups - [NamedEntityStat!]
|
Example
{
"isInquisitive": [AdminReflectionStatValue],
"isReflective": [AdminReflectionStatValue],
"isLinguisticallyAcceptable": [
AdminReflectionStatValue
],
"isToxic": [AdminReflectionStatValue],
"containsMedicalTerms": [AdminReflectionStatValue],
"topEntityGroups": [NamedEntityStat]
}
AdminVideoCompletion
AlternatePlaylist
AnatomicalModel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String
|
A description of the model. |
keywords - [String!]
|
Keywords for the model. These are used to help users find the model. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
video - Video
|
|
renderedImage - Image
|
The image for the 3d model. Images are hosted using Cloudflare images. Please see https://developers.cloudflare.com/images/cloudflare-images/serve-images/ for details on how to serve images. |
Example
{
"id": "4",
"name": "xyz789",
"description": "xyz789",
"keywords": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"video": Video,
"renderedImage": Image
}
AnatomicalModelConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [AnatomicalModelEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [AnatomicalModelEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AnatomicalModelEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - AnatomicalModel
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": AnatomicalModel,
"cursor": Cursor
}
AnatomicalModelWhereInput
Description
AnatomicalModelWhereInput is used for filtering AnatomicalModel objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - AnatomicalModelWhereInput
|
|
and - [AnatomicalModelWhereInput!]
|
|
or - [AnatomicalModelWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
description - String
|
description field predicates |
descriptionNEQ - String
|
|
descriptionIn - [String!]
|
|
descriptionNotIn - [String!]
|
|
descriptionGT - String
|
|
descriptionGTE - String
|
|
descriptionLT - String
|
|
descriptionLTE - String
|
|
descriptionContains - String
|
|
descriptionHasPrefix - String
|
|
descriptionHasSuffix - String
|
|
descriptionIsNil - Boolean
|
|
descriptionNotNil - Boolean
|
|
descriptionEqualFold - String
|
|
descriptionContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
|
hasRenderedImage - Boolean
|
rendered_image edge predicates |
hasRenderedImageWith - [ImageWhereInput!]
|
|
hasKeywords - [String!]
|
Example
{}
Any
Example
{}
ApiQueryLog
Example
{
"id": "4",
"operationName": "xyz789",
"query": "abc123",
"variables": Map,
"createdAt": "10:15:30Z",
"userID": 4,
"user": User
}
ApiQueryLogConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ApiQueryLogEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [ApiQueryLogEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ApiQueryLogEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ApiQueryLog
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": ApiQueryLog,
"cursor": Cursor
}
ApiQueryLogOrder
Description
Ordering options for ApiQueryLog connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - ApiQueryLogOrderField!
|
The field by which to order ApiQueryLogs. |
Example
{}
ApiQueryLogOrderField
Description
Properties by which ApiQueryLog connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
ApiQueryLogWhereInput
Description
ApiQueryLogWhereInput is used for filtering ApiQueryLog objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ApiQueryLogWhereInput
|
|
and - [ApiQueryLogWhereInput!]
|
|
or - [ApiQueryLogWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
operationName - String
|
operation_name field predicates |
operationNameNEQ - String
|
|
operationNameIn - [String!]
|
|
operationNameNotIn - [String!]
|
|
operationNameGT - String
|
|
operationNameGTE - String
|
|
operationNameLT - String
|
|
operationNameLTE - String
|
|
operationNameContains - String
|
|
operationNameHasPrefix - String
|
|
operationNameHasSuffix - String
|
|
operationNameIsNil - Boolean
|
|
operationNameNotNil - Boolean
|
|
operationNameEqualFold - String
|
|
operationNameContainsFold - String
|
|
query - String
|
query field predicates |
queryNEQ - String
|
|
queryIn - [String!]
|
|
queryNotIn - [String!]
|
|
queryGT - String
|
|
queryGTE - String
|
|
queryLT - String
|
|
queryLTE - String
|
|
queryContains - String
|
|
queryHasPrefix - String
|
|
queryHasSuffix - String
|
|
queryIsNil - Boolean
|
|
queryNotNil - Boolean
|
|
queryEqualFold - String
|
|
queryContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
userIDIsNil - Boolean
|
|
userIDNotNil - Boolean
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
ApiToken
Example
{
"id": "4",
"name": "xyz789",
"token": "abc123",
"lastUsedAt": "10:15:30Z",
"createdAt": "10:15:30Z",
"expiresAt": "10:15:30Z",
"user": User
}
ApiTokenWhereInput
Description
ApiTokenWhereInput is used for filtering ApiToken objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ApiTokenWhereInput
|
|
and - [ApiTokenWhereInput!]
|
|
or - [ApiTokenWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
token - String
|
token field predicates |
tokenNEQ - String
|
|
tokenIn - [String!]
|
|
tokenNotIn - [String!]
|
|
tokenGT - String
|
|
tokenGTE - String
|
|
tokenLT - String
|
|
tokenLTE - String
|
|
tokenContains - String
|
|
tokenHasPrefix - String
|
|
tokenHasSuffix - String
|
|
tokenEqualFold - String
|
|
tokenContainsFold - String
|
|
lastUsedAt - Time
|
last_used_at field predicates |
lastUsedAtNEQ - Time
|
|
lastUsedAtIn - [Time!]
|
|
lastUsedAtNotIn - [Time!]
|
|
lastUsedAtGT - Time
|
|
lastUsedAtGTE - Time
|
|
lastUsedAtLT - Time
|
|
lastUsedAtLTE - Time
|
|
lastUsedAtIsNil - Boolean
|
|
lastUsedAtNotNil - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
expiresAt - Time
|
expires_at field predicates |
expiresAtNEQ - Time
|
|
expiresAtIn - [Time!]
|
|
expiresAtNotIn - [Time!]
|
|
expiresAtGT - Time
|
|
expiresAtGTE - Time
|
|
expiresAtLT - Time
|
|
expiresAtLTE - Time
|
|
expiresAtIsNil - Boolean
|
|
expiresAtNotNil - Boolean
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
Article
Example
{
"id": 4,
"url": "abc123",
"code": "xyz789",
"title": "abc123",
"body": "abc123",
"summary": "abc123",
"discussionPoints": ["abc123"],
"status": "generating",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
ArticleConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ArticleEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [ArticleEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ArticleEdge
ArticleId
ArticleOrder
Description
Ordering options for Article connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - ArticleOrderField!
|
The field by which to order Articles. |
Example
{}
ArticleOrderField
Description
Properties by which Article connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
ArticleStatus
Description
ArticleStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
ArticleWhereInput
Description
ArticleWhereInput is used for filtering Article objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ArticleWhereInput
|
|
and - [ArticleWhereInput!]
|
|
or - [ArticleWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
code - String
|
code field predicates |
codeNEQ - String
|
|
codeIn - [String!]
|
|
codeNotIn - [String!]
|
|
codeGT - String
|
|
codeGTE - String
|
|
codeLT - String
|
|
codeLTE - String
|
|
codeContains - String
|
|
codeHasPrefix - String
|
|
codeHasSuffix - String
|
|
codeEqualFold - String
|
|
codeContainsFold - String
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleIsNil - Boolean
|
|
titleNotNil - Boolean
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
body - String
|
body field predicates |
bodyNEQ - String
|
|
bodyIn - [String!]
|
|
bodyNotIn - [String!]
|
|
bodyGT - String
|
|
bodyGTE - String
|
|
bodyLT - String
|
|
bodyLTE - String
|
|
bodyContains - String
|
|
bodyHasPrefix - String
|
|
bodyHasSuffix - String
|
|
bodyIsNil - Boolean
|
|
bodyNotNil - Boolean
|
|
bodyEqualFold - String
|
|
bodyContainsFold - String
|
|
summary - String
|
summary field predicates |
summaryNEQ - String
|
|
summaryIn - [String!]
|
|
summaryNotIn - [String!]
|
|
summaryGT - String
|
|
summaryGTE - String
|
|
summaryLT - String
|
|
summaryLTE - String
|
|
summaryContains - String
|
|
summaryHasPrefix - String
|
|
summaryHasSuffix - String
|
|
summaryIsNil - Boolean
|
|
summaryNotNil - Boolean
|
|
summaryEqualFold - String
|
|
summaryContainsFold - String
|
|
status - ArticleStatus
|
status field predicates |
statusNEQ - ArticleStatus
|
|
statusIn - [ArticleStatus!]
|
|
statusNotIn - [ArticleStatus!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
Audience
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
designationtemplate - String!
|
The raw text template for the designation text that will be displayed on the certificate. Use the designation field to get the rendered text. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
npiTaxonomies - [NpiTaxonomy!]
|
|
posts - [Post!]
|
|
tenant - Tenant
|
The tenant that the topic belongs to. |
designation - String!
|
The rendered text designation for the audience / credit hours. Can only be used when nested inside a post. |
Example
{
"id": "4",
"name": "abc123",
"designationtemplate": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"npiTaxonomies": [NpiTaxonomy],
"posts": [Post],
"tenant": Tenant,
"designation": "abc123"
}
AudienceConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [AudienceEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [AudienceEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
AudienceEdge
AudienceOrder
Description
Ordering options for Audience connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - AudienceOrderField!
|
The field by which to order Audiences. |
Example
{}
AudienceOrderField
Description
Properties by which Audience connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
AudienceWhereInput
Description
AudienceWhereInput is used for filtering Audience objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - AudienceWhereInput
|
|
and - [AudienceWhereInput!]
|
|
or - [AudienceWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
designationtemplate - String
|
designationTemplate field predicates |
designationtemplateNEQ - String
|
|
designationtemplateIn - [String!]
|
|
designationtemplateNotIn - [String!]
|
|
designationtemplateGT - String
|
|
designationtemplateGTE - String
|
|
designationtemplateLT - String
|
|
designationtemplateLTE - String
|
|
designationtemplateContains - String
|
|
designationtemplateHasPrefix - String
|
|
designationtemplateHasSuffix - String
|
|
designationtemplateEqualFold - String
|
|
designationtemplateContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasNpiTaxonomies - Boolean
|
npi_taxonomies edge predicates |
hasNpiTaxonomiesWith - [NpiTaxonomyWhereInput!]
|
|
hasPosts - Boolean
|
posts edge predicates |
hasPostsWith - [PostWhereInput!]
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
Example
{}
AuditLog
Example
{
"id": 4,
"entityID": "abc123",
"entityType": "abc123",
"action": "xyz789",
"changes": Map,
"remoteAddr": "xyz789",
"createdAt": "10:15:30Z",
"user": User
}
AuditLogConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [AuditLogEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [AuditLogEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
AuditLogEdge
AuditLogOrder
Description
Ordering options for AuditLog connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - AuditLogOrderField!
|
The field by which to order AuditLogs. |
Example
{}
AuditLogOrderField
Description
Properties by which AuditLog connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
AuditLogWhereInput
Description
AuditLogWhereInput is used for filtering AuditLog objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - AuditLogWhereInput
|
|
and - [AuditLogWhereInput!]
|
|
or - [AuditLogWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
entityID - String
|
entity_id field predicates |
entityIDNEQ - String
|
|
entityIDIn - [String!]
|
|
entityIDNotIn - [String!]
|
|
entityIDGT - String
|
|
entityIDGTE - String
|
|
entityIDLT - String
|
|
entityIDLTE - String
|
|
entityIDContains - String
|
|
entityIDHasPrefix - String
|
|
entityIDHasSuffix - String
|
|
entityIDEqualFold - String
|
|
entityIDContainsFold - String
|
|
entityType - String
|
entity_type field predicates |
entityTypeNEQ - String
|
|
entityTypeIn - [String!]
|
|
entityTypeNotIn - [String!]
|
|
entityTypeGT - String
|
|
entityTypeGTE - String
|
|
entityTypeLT - String
|
|
entityTypeLTE - String
|
|
entityTypeContains - String
|
|
entityTypeHasPrefix - String
|
|
entityTypeHasSuffix - String
|
|
entityTypeEqualFold - String
|
|
entityTypeContainsFold - String
|
|
action - String
|
action field predicates |
actionNEQ - String
|
|
actionIn - [String!]
|
|
actionNotIn - [String!]
|
|
actionGT - String
|
|
actionGTE - String
|
|
actionLT - String
|
|
actionLTE - String
|
|
actionContains - String
|
|
actionHasPrefix - String
|
|
actionHasSuffix - String
|
|
actionEqualFold - String
|
|
actionContainsFold - String
|
|
remoteAddr - String
|
remote_addr field predicates |
remoteAddrNEQ - String
|
|
remoteAddrIn - [String!]
|
|
remoteAddrNotIn - [String!]
|
|
remoteAddrGT - String
|
|
remoteAddrGTE - String
|
|
remoteAddrLT - String
|
|
remoteAddrLTE - String
|
|
remoteAddrContains - String
|
|
remoteAddrHasPrefix - String
|
|
remoteAddrHasSuffix - String
|
|
remoteAddrIsNil - Boolean
|
|
remoteAddrNotNil - Boolean
|
|
remoteAddrEqualFold - String
|
|
remoteAddrContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
Author
BioCDocument
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
passage - [BioCPassage]
|
Example
{"id": 4, "passage": [BioCPassage]}
BioCInfon
BioCPassage
Fields
| Field Name | Description |
|---|---|
offset - Int
|
|
text - String
|
|
infon - [BioCInfon]
|
Example
{
"offset": 987,
"text": "abc123",
"infon": [BioCInfon]
}
Bookmark
Example
{
"id": 4,
"bookmarkedAt": "10:15:30Z",
"userID": 4,
"postID": "4",
"user": User,
"post": Post
}
BookmarkConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [BookmarkEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [BookmarkEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
BookmarkEdge
BookmarkOrder
Description
Ordering options for Bookmark connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - BookmarkOrderField!
|
The field by which to order Bookmarks. |
Example
{}
BookmarkOrderField
Description
Properties by which Bookmark connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
BookmarkPostInput
Fields
| Input Field | Description |
|---|---|
postId - ID!
|
Example
{}
BookmarkWhereInput
Description
BookmarkWhereInput is used for filtering Bookmark objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - BookmarkWhereInput
|
|
and - [BookmarkWhereInput!]
|
|
or - [BookmarkWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
bookmarkedAt - Time
|
bookmarked_at field predicates |
bookmarkedAtNEQ - Time
|
|
bookmarkedAtIn - [Time!]
|
|
bookmarkedAtNotIn - [Time!]
|
|
bookmarkedAtGT - Time
|
|
bookmarkedAtGTE - Time
|
|
bookmarkedAtLT - Time
|
|
bookmarkedAtLTE - Time
|
|
hasPostWith - [PostWhereInput!]
|
Example
{}
Boolean
Description
The Boolean scalar type represents true or false.
Example
{}
Certificate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
url - String
|
The url of the certificate for download. |
user - User
|
The user that the certificate belongs to. |
educationCredits - [EducationCredit!]
|
The credits that the certificate was redeemed for. |
certificateSurveyAnswers - [CertificateSurveyAnswer!]
|
The survey answers that the certificate was redeemed for. |
Example
{
"id": 4,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"url": "xyz789",
"user": User,
"educationCredits": [EducationCredit],
"certificateSurveyAnswers": [CertificateSurveyAnswer]
}
CertificateConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CertificateEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CertificateEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CertificateEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - Certificate
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": Certificate,
"cursor": Cursor
}
CertificateSurveyAnswer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
answer - String!
|
The answer to the question. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
certificateSurveyQuestion - CertificateSurveyQuestion
|
The question that the answer is for. |
user - User
|
The user that answered the question. |
certificate - Certificate
|
The certificate that the answer is for. |
choice - CertificateSurveyQuestionChoice
|
Example
{
"id": "4",
"answer": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"certificateSurveyQuestion": CertificateSurveyQuestion,
"user": User,
"certificate": Certificate,
"choice": CertificateSurveyQuestionChoice
}
CertificateSurveyAnswerConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CertificateSurveyAnswerEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CertificateSurveyAnswerEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CertificateSurveyAnswerEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CertificateSurveyAnswer
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": CertificateSurveyAnswer,
"cursor": Cursor
}
CertificateSurveyAnswerWhereInput
Description
CertificateSurveyAnswerWhereInput is used for filtering CertificateSurveyAnswer objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CertificateSurveyAnswerWhereInput
|
|
and - [CertificateSurveyAnswerWhereInput!]
|
|
or - [CertificateSurveyAnswerWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
answer - String
|
answer field predicates |
answerNEQ - String
|
|
answerIn - [String!]
|
|
answerNotIn - [String!]
|
|
answerGT - String
|
|
answerGTE - String
|
|
answerLT - String
|
|
answerLTE - String
|
|
answerContains - String
|
|
answerHasPrefix - String
|
|
answerHasSuffix - String
|
|
answerEqualFold - String
|
|
answerContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasCertificateSurveyQuestion - Boolean
|
certificate_survey_question edge predicates |
hasCertificateSurveyQuestionWith - [CertificateSurveyQuestionWhereInput!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasCertificate - Boolean
|
certificate edge predicates |
hasCertificateWith - [CertificateWhereInput!]
|
|
hasChoice - Boolean
|
choice edge predicates |
hasChoiceWith - [CertificateSurveyQuestionChoiceWhereInput!]
|
Example
{}
CertificateSurveyQuestion
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
question - String!
|
The question to ask the user. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
learningObjective - LearningObjective
|
The learning objective that the question is for. |
choices - [CertificateSurveyQuestionChoice!]
|
The choices for the question. |
Example
{
"id": "4",
"question": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"learningObjective": LearningObjective,
"choices": [CertificateSurveyQuestionChoice]
}
CertificateSurveyQuestionChoice
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
label - String!
|
The label for the choice. |
emoji - String!
|
The emoji for the choice. |
question - CertificateSurveyQuestion
|
The question that the choice is for. |
Example
{
"id": 4,
"label": "xyz789",
"emoji": "xyz789",
"question": CertificateSurveyQuestion
}
CertificateSurveyQuestionChoiceConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CertificateSurveyQuestionChoiceEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CertificateSurveyQuestionChoiceEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CertificateSurveyQuestionChoiceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CertificateSurveyQuestionChoice
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": CertificateSurveyQuestionChoice,
"cursor": Cursor
}
CertificateSurveyQuestionChoiceWhereInput
Description
CertificateSurveyQuestionChoiceWhereInput is used for filtering CertificateSurveyQuestionChoice objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CertificateSurveyQuestionChoiceWhereInput
|
|
and - [CertificateSurveyQuestionChoiceWhereInput!]
|
|
or - [CertificateSurveyQuestionChoiceWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
label - String
|
label field predicates |
labelNEQ - String
|
|
labelIn - [String!]
|
|
labelNotIn - [String!]
|
|
labelGT - String
|
|
labelGTE - String
|
|
labelLT - String
|
|
labelLTE - String
|
|
labelContains - String
|
|
labelHasPrefix - String
|
|
labelHasSuffix - String
|
|
labelEqualFold - String
|
|
labelContainsFold - String
|
|
emoji - String
|
emoji field predicates |
emojiNEQ - String
|
|
emojiIn - [String!]
|
|
emojiNotIn - [String!]
|
|
emojiGT - String
|
|
emojiGTE - String
|
|
emojiLT - String
|
|
emojiLTE - String
|
|
emojiContains - String
|
|
emojiHasPrefix - String
|
|
emojiHasSuffix - String
|
|
emojiEqualFold - String
|
|
emojiContainsFold - String
|
|
hasQuestion - Boolean
|
question edge predicates |
hasQuestionWith - [CertificateSurveyQuestionWhereInput!]
|
Example
{}
CertificateSurveyQuestionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CertificateSurveyQuestionEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CertificateSurveyQuestionEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CertificateSurveyQuestionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CertificateSurveyQuestion
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": CertificateSurveyQuestion,
"cursor": Cursor
}
CertificateSurveyQuestionWhereInput
Description
CertificateSurveyQuestionWhereInput is used for filtering CertificateSurveyQuestion objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CertificateSurveyQuestionWhereInput
|
|
and - [CertificateSurveyQuestionWhereInput!]
|
|
or - [CertificateSurveyQuestionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
question - String
|
question field predicates |
questionNEQ - String
|
|
questionIn - [String!]
|
|
questionNotIn - [String!]
|
|
questionGT - String
|
|
questionGTE - String
|
|
questionLT - String
|
|
questionLTE - String
|
|
questionContains - String
|
|
questionHasPrefix - String
|
|
questionHasSuffix - String
|
|
questionEqualFold - String
|
|
questionContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasLearningObjective - Boolean
|
learning_objective edge predicates |
hasLearningObjectiveWith - [LearningObjectiveWhereInput!]
|
|
hasChoices - Boolean
|
choices edge predicates |
hasChoicesWith - [CertificateSurveyQuestionChoiceWhereInput!]
|
Example
{}
CertificateWhereInput
Description
CertificateWhereInput is used for filtering Certificate objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CertificateWhereInput
|
|
and - [CertificateWhereInput!]
|
|
or - [CertificateWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlIsNil - Boolean
|
|
urlNotNil - Boolean
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasEducationCredits - Boolean
|
education_credits edge predicates |
hasEducationCreditsWith - [EducationCreditWhereInput!]
|
|
hasCertificateSurveyAnswers - Boolean
|
certificate_survey_answers edge predicates |
hasCertificateSurveyAnswersWith - [CertificateSurveyAnswerWhereInput!]
|
Example
{}
ClinicalTrial
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
nctID - String!
|
|
title - String!
|
|
status - String!
|
|
description - String!
|
|
summary - String!
|
|
keywords - [String!]!
|
|
conditions - [String!]!
|
|
startDate - Time
|
|
completionDate - Time
|
|
contacts - [ClinicalTrialContact!]!
|
|
locations - [ClinicalTrialLocation!]!
|
Example
{
"id": 4,
"nctID": "abc123",
"title": "xyz789",
"status": "xyz789",
"description": "abc123",
"summary": "abc123",
"keywords": ["abc123"],
"conditions": ["xyz789"],
"startDate": "10:15:30Z",
"completionDate": "10:15:30Z",
"contacts": [ClinicalTrialContact],
"locations": [ClinicalTrialLocation]
}
ClinicalTrialConditionCount
ClinicalTrialConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ClinicalTrialEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [ClinicalTrialEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ClinicalTrialContact
ClinicalTrialDocument
ClinicalTrialDocumentWhereInput
Description
ClinicalTrialDocumentWhereInput is used for filtering ClinicalTrialDocument objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ClinicalTrialDocumentWhereInput
|
|
and - [ClinicalTrialDocumentWhereInput!]
|
|
or - [ClinicalTrialDocumentWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
nctID - String
|
nct_id field predicates |
nctIDNEQ - String
|
|
nctIDIn - [String!]
|
|
nctIDNotIn - [String!]
|
|
nctIDGT - String
|
|
nctIDGTE - String
|
|
nctIDLT - String
|
|
nctIDLTE - String
|
|
nctIDContains - String
|
|
nctIDHasPrefix - String
|
|
nctIDHasSuffix - String
|
|
nctIDEqualFold - String
|
|
nctIDContainsFold - String
|
|
rawBody - String
|
raw_body field predicates |
rawBodyNEQ - String
|
|
rawBodyIn - [String!]
|
|
rawBodyNotIn - [String!]
|
|
rawBodyGT - String
|
|
rawBodyGTE - String
|
|
rawBodyLT - String
|
|
rawBodyLTE - String
|
|
rawBodyContains - String
|
|
rawBodyHasPrefix - String
|
|
rawBodyHasSuffix - String
|
|
rawBodyIsNil - Boolean
|
|
rawBodyNotNil - Boolean
|
|
rawBodyEqualFold - String
|
|
rawBodyContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
processedAt - Time
|
processed_at field predicates |
processedAtNEQ - Time
|
|
processedAtIn - [Time!]
|
|
processedAtNotIn - [Time!]
|
|
processedAtGT - Time
|
|
processedAtGTE - Time
|
|
processedAtLT - Time
|
|
processedAtLTE - Time
|
|
processedAtIsNil - Boolean
|
|
processedAtNotNil - Boolean
|
Example
{}
ClinicalTrialEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ClinicalTrial
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": ClinicalTrial,
"cursor": Cursor
}
ClinicalTrialLocation
Example
{
"facility": "abc123",
"city": "abc123",
"state": "abc123",
"zip": "abc123",
"country": "abc123",
"status": "abc123",
"contacts": [ClinicalTrialContact],
"latitude": 987.65,
"longitude": 987.65
}
ClinicalTrialMapPoint
ClinicalTrialOrder
Description
Ordering options for ClinicalTrial connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - ClinicalTrialOrderField!
|
The field by which to order ClinicalTrials. |
Example
{}
ClinicalTrialOrderField
Description
Properties by which ClinicalTrial connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
ClinicalTrialStatusCount
ClinicalTrialWhereInput
Description
ClinicalTrialWhereInput is used for filtering ClinicalTrial objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ClinicalTrialWhereInput
|
|
and - [ClinicalTrialWhereInput!]
|
|
or - [ClinicalTrialWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
nctID - String
|
nct_id field predicates |
nctIDNEQ - String
|
|
nctIDIn - [String!]
|
|
nctIDNotIn - [String!]
|
|
nctIDGT - String
|
|
nctIDGTE - String
|
|
nctIDLT - String
|
|
nctIDLTE - String
|
|
nctIDContains - String
|
|
nctIDHasPrefix - String
|
|
nctIDHasSuffix - String
|
|
nctIDEqualFold - String
|
|
nctIDContainsFold - String
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
status - String
|
status field predicates |
statusNEQ - String
|
|
statusIn - [String!]
|
|
statusNotIn - [String!]
|
|
statusGT - String
|
|
statusGTE - String
|
|
statusLT - String
|
|
statusLTE - String
|
|
statusContains - String
|
|
statusHasPrefix - String
|
|
statusHasSuffix - String
|
|
statusEqualFold - String
|
|
statusContainsFold - String
|
|
description - String
|
description field predicates |
descriptionNEQ - String
|
|
descriptionIn - [String!]
|
|
descriptionNotIn - [String!]
|
|
descriptionGT - String
|
|
descriptionGTE - String
|
|
descriptionLT - String
|
|
descriptionLTE - String
|
|
descriptionContains - String
|
|
descriptionHasPrefix - String
|
|
descriptionHasSuffix - String
|
|
descriptionEqualFold - String
|
|
descriptionContainsFold - String
|
|
summary - String
|
summary field predicates |
summaryNEQ - String
|
|
summaryIn - [String!]
|
|
summaryNotIn - [String!]
|
|
summaryGT - String
|
|
summaryGTE - String
|
|
summaryLT - String
|
|
summaryLTE - String
|
|
summaryContains - String
|
|
summaryHasPrefix - String
|
|
summaryHasSuffix - String
|
|
summaryEqualFold - String
|
|
summaryContainsFold - String
|
|
startDate - Time
|
start_date field predicates |
startDateNEQ - Time
|
|
startDateIn - [Time!]
|
|
startDateNotIn - [Time!]
|
|
startDateGT - Time
|
|
startDateGTE - Time
|
|
startDateLT - Time
|
|
startDateLTE - Time
|
|
startDateIsNil - Boolean
|
|
startDateNotNil - Boolean
|
|
completionDate - Time
|
completion_date field predicates |
completionDateNEQ - Time
|
|
completionDateIn - [Time!]
|
|
completionDateNotIn - [Time!]
|
|
completionDateGT - Time
|
|
completionDateGTE - Time
|
|
completionDateLT - Time
|
|
completionDateLTE - Time
|
|
completionDateIsNil - Boolean
|
|
completionDateNotNil - Boolean
|
Example
{}
CloudflareUpload
Example
{
"id": 4,
"storageKey": "abc123",
"uid": "xyz789",
"signedURL": "abc123",
"status": "pending",
"createdAt": "10:15:30Z",
"completedAt": "10:15:30Z"
}
CloudflareUploadStatus
Description
CloudflareUploadStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
CloudflareUploadWhereInput
Description
CloudflareUploadWhereInput is used for filtering CloudflareUpload objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CloudflareUploadWhereInput
|
|
and - [CloudflareUploadWhereInput!]
|
|
or - [CloudflareUploadWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyIsNil - Boolean
|
|
storageKeyNotNil - Boolean
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
uid - String
|
uid field predicates |
uidNEQ - String
|
|
uidIn - [String!]
|
|
uidNotIn - [String!]
|
|
uidGT - String
|
|
uidGTE - String
|
|
uidLT - String
|
|
uidLTE - String
|
|
uidContains - String
|
|
uidHasPrefix - String
|
|
uidHasSuffix - String
|
|
uidIsNil - Boolean
|
|
uidNotNil - Boolean
|
|
uidEqualFold - String
|
|
uidContainsFold - String
|
|
signedURL - String
|
signed_url field predicates |
signedURLNEQ - String
|
|
signedURLIn - [String!]
|
|
signedURLNotIn - [String!]
|
|
signedURLGT - String
|
|
signedURLGTE - String
|
|
signedURLLT - String
|
|
signedURLLTE - String
|
|
signedURLContains - String
|
|
signedURLHasPrefix - String
|
|
signedURLHasSuffix - String
|
|
signedURLIsNil - Boolean
|
|
signedURLNotNil - Boolean
|
|
signedURLEqualFold - String
|
|
signedURLContainsFold - String
|
|
status - CloudflareUploadStatus
|
status field predicates |
statusNEQ - CloudflareUploadStatus
|
|
statusIn - [CloudflareUploadStatus!]
|
|
statusNotIn - [CloudflareUploadStatus!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
completedAt - Time
|
completed_at field predicates |
completedAtNEQ - Time
|
|
completedAtIn - [Time!]
|
|
completedAtNotIn - [Time!]
|
|
completedAtGT - Time
|
|
completedAtGTE - Time
|
|
completedAtLT - Time
|
|
completedAtLTE - Time
|
|
completedAtIsNil - Boolean
|
|
completedAtNotNil - Boolean
|
Example
{}
Collection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
The name of the collection. |
description - String
|
The description of the collection. |
totalDuration - Int!
|
The total duration of all the posts in the collection. |
totalPosts - Int!
|
The total number of posts in the collection. |
tenant - Tenant
|
The tenant that the topic belongs to. |
postcollections - [PostCollection!]
|
The posts in the collection. |
cover - Image
|
The cover image of the collection. |
userCompletions - [UserCollectionCompletion!]
|
The users that have completed the collection. |
posts - [Post!]!
|
|
educationCredit - EducationCredit
|
|
userCompletion - UserCollectionCompletion
|
Example
{
"id": "4",
"name": "abc123",
"description": "abc123",
"totalDuration": 123,
"totalPosts": 987,
"tenant": Tenant,
"postcollections": [PostCollection],
"cover": Image,
"userCompletions": [UserCollectionCompletion],
"posts": [Post],
"educationCredit": EducationCredit,
"userCompletion": UserCollectionCompletion
}
CollectionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CollectionEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CollectionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CollectionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - Collection
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": Collection,
"cursor": Cursor
}
CollectionWhereInput
Description
CollectionWhereInput is used for filtering Collection objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CollectionWhereInput
|
|
and - [CollectionWhereInput!]
|
|
or - [CollectionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
description - String
|
description field predicates |
descriptionNEQ - String
|
|
descriptionIn - [String!]
|
|
descriptionNotIn - [String!]
|
|
descriptionGT - String
|
|
descriptionGTE - String
|
|
descriptionLT - String
|
|
descriptionLTE - String
|
|
descriptionContains - String
|
|
descriptionHasPrefix - String
|
|
descriptionHasSuffix - String
|
|
descriptionIsNil - Boolean
|
|
descriptionNotNil - Boolean
|
|
descriptionEqualFold - String
|
|
descriptionContainsFold - String
|
|
totalDuration - Int
|
total_duration field predicates |
totalDurationNEQ - Int
|
|
totalDurationIn - [Int!]
|
|
totalDurationNotIn - [Int!]
|
|
totalDurationGT - Int
|
|
totalDurationGTE - Int
|
|
totalDurationLT - Int
|
|
totalDurationLTE - Int
|
|
totalPosts - Int
|
total_posts field predicates |
totalPostsNEQ - Int
|
|
totalPostsIn - [Int!]
|
|
totalPostsNotIn - [Int!]
|
|
totalPostsGT - Int
|
|
totalPostsGTE - Int
|
|
totalPostsLT - Int
|
|
totalPostsLTE - Int
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasPostcollections - Boolean
|
postcollections edge predicates |
hasPostcollectionsWith - [PostCollectionWhereInput!]
|
|
hasCover - Boolean
|
cover edge predicates |
hasCoverWith - [ImageWhereInput!]
|
|
hasUserCompletions - Boolean
|
user_completions edge predicates |
hasUserCompletionsWith - [UserCollectionCompletionWhereInput!]
|
Example
{}
Comment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
body - String!
|
Body of the comment |
reflectionPrompt - String
|
The reflection prompt the user chose for this comment |
namedEntities - [NamedEntity!]
|
|
sentiment - Sentiment
|
|
totalLikes - Int!
|
The total number of likes this comment has |
createdAt - Time!
|
|
reflectionAnalysisResults - ReflectionResult
|
The results of the reflection analysis |
updatedAt - Time!
|
|
shouldEarnCredits - Boolean!
|
Whether or not the user should earn credits for this comment |
didEarnCredits - Boolean!
|
Whether or not the user earned credits for this comment |
creditWasApproved - Boolean
|
Whether or not the credit was approved |
author - User
|
The author of the comment |
post - Post
|
The post this comment belongs to |
parent - Comment
|
The replies to this comment |
replies - [Comment!]
|
|
educationCredit - EducationCredit
|
The education credit this comment earned |
commentNamedEntities - [CommentNamedEntity!]
|
|
reviewedBy - User
|
The user who reviewed this comment |
sparkyConversations - [SparkyConversation!]
|
|
likedUsers - [User!]
|
The users who liked this comment |
commentLikes - [CommentLike!]
|
Example
{
"id": "4",
"body": "xyz789",
"reflectionPrompt": "xyz789",
"namedEntities": [NamedEntity],
"sentiment": Sentiment,
"totalLikes": 987,
"createdAt": "10:15:30Z",
"reflectionAnalysisResults": ReflectionResult,
"updatedAt": "10:15:30Z",
"shouldEarnCredits": true,
"didEarnCredits": true,
"creditWasApproved": true,
"author": User,
"post": Post,
"parent": Comment,
"replies": [Comment],
"educationCredit": EducationCredit,
"commentNamedEntities": [CommentNamedEntity],
"reviewedBy": User,
"sparkyConversations": [SparkyConversation],
"likedUsers": [User],
"commentLikes": [CommentLike]
}
CommentConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CommentEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CommentEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
CommentEdge
CommentLike
Example
{
"id": 4,
"likedAt": "10:15:30Z",
"userID": 4,
"commentID": "4",
"user": User,
"comment": Comment
}
CommentLikeConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CommentLikeEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CommentLikeEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CommentLikeEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CommentLike
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": CommentLike,
"cursor": Cursor
}
CommentLikeOrder
Description
Ordering options for CommentLike connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - CommentLikeOrderField!
|
The field by which to order CommentLikes. |
Example
{}
CommentLikeOrderField
Description
Properties by which CommentLike connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
CommentLikeWhereInput
Description
CommentLikeWhereInput is used for filtering CommentLike objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CommentLikeWhereInput
|
|
and - [CommentLikeWhereInput!]
|
|
or - [CommentLikeWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
likedAt - Time
|
liked_at field predicates |
likedAtNEQ - Time
|
|
likedAtIn - [Time!]
|
|
likedAtNotIn - [Time!]
|
|
likedAtGT - Time
|
|
likedAtGTE - Time
|
|
likedAtLT - Time
|
|
likedAtLTE - Time
|
Example
{}
CommentNamedEntity
CommentNamedEntityWhereInput
Description
CommentNamedEntityWhereInput is used for filtering CommentNamedEntity objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CommentNamedEntityWhereInput
|
|
and - [CommentNamedEntityWhereInput!]
|
|
or - [CommentNamedEntityWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
score - Float
|
score field predicates |
scoreNEQ - Float
|
|
scoreIn - [Float!]
|
|
scoreNotIn - [Float!]
|
|
scoreGT - Float
|
|
scoreGTE - Float
|
|
scoreLT - Float
|
|
scoreLTE - Float
|
|
word - String
|
word field predicates |
wordNEQ - String
|
|
wordIn - [String!]
|
|
wordNotIn - [String!]
|
|
wordGT - String
|
|
wordGTE - String
|
|
wordLT - String
|
|
wordLTE - String
|
|
wordContains - String
|
|
wordHasPrefix - String
|
|
wordHasSuffix - String
|
|
wordEqualFold - String
|
|
wordContainsFold - String
|
|
start - Int
|
start field predicates |
startNEQ - Int
|
|
startIn - [Int!]
|
|
startNotIn - [Int!]
|
|
startGT - Int
|
|
startGTE - Int
|
|
startLT - Int
|
|
startLTE - Int
|
|
end - Int
|
end field predicates |
endNEQ - Int
|
|
endIn - [Int!]
|
|
endNotIn - [Int!]
|
|
endGT - Int
|
|
endGTE - Int
|
|
endLT - Int
|
|
endLTE - Int
|
|
entityGroup - String
|
entity_group field predicates |
entityGroupNEQ - String
|
|
entityGroupIn - [String!]
|
|
entityGroupNotIn - [String!]
|
|
entityGroupGT - String
|
|
entityGroupGTE - String
|
|
entityGroupLT - String
|
|
entityGroupLTE - String
|
|
entityGroupContains - String
|
|
entityGroupHasPrefix - String
|
|
entityGroupHasSuffix - String
|
|
entityGroupEqualFold - String
|
|
entityGroupContainsFold - String
|
|
hasComment - Boolean
|
comment edge predicates |
hasCommentWith - [CommentWhereInput!]
|
Example
{}
CommentOrder
Description
Ordering options for Comment connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - CommentOrderField!
|
The field by which to order Comments. |
Example
{}
CommentOrderField
Description
Properties by which Comment connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
CommentWhereInput
Description
CommentWhereInput is used for filtering Comment objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CommentWhereInput
|
|
and - [CommentWhereInput!]
|
|
or - [CommentWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
body - String
|
body field predicates |
bodyNEQ - String
|
|
bodyIn - [String!]
|
|
bodyNotIn - [String!]
|
|
bodyGT - String
|
|
bodyGTE - String
|
|
bodyLT - String
|
|
bodyLTE - String
|
|
bodyContains - String
|
|
bodyHasPrefix - String
|
|
bodyHasSuffix - String
|
|
bodyEqualFold - String
|
|
bodyContainsFold - String
|
|
reflectionPrompt - String
|
reflection_prompt field predicates |
reflectionPromptNEQ - String
|
|
reflectionPromptIn - [String!]
|
|
reflectionPromptNotIn - [String!]
|
|
reflectionPromptGT - String
|
|
reflectionPromptGTE - String
|
|
reflectionPromptLT - String
|
|
reflectionPromptLTE - String
|
|
reflectionPromptContains - String
|
|
reflectionPromptHasPrefix - String
|
|
reflectionPromptHasSuffix - String
|
|
reflectionPromptIsNil - Boolean
|
|
reflectionPromptNotNil - Boolean
|
|
reflectionPromptEqualFold - String
|
|
reflectionPromptContainsFold - String
|
|
totalLikes - Int
|
total_likes field predicates |
totalLikesNEQ - Int
|
|
totalLikesIn - [Int!]
|
|
totalLikesNotIn - [Int!]
|
|
totalLikesGT - Int
|
|
totalLikesGTE - Int
|
|
totalLikesLT - Int
|
|
totalLikesLTE - Int
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
shouldEarnCredits - Boolean
|
should_earn_credits field predicates |
shouldEarnCreditsNEQ - Boolean
|
|
didEarnCredits - Boolean
|
did_earn_credits field predicates |
didEarnCreditsNEQ - Boolean
|
|
creditWasApproved - Boolean
|
credit_was_approved field predicates |
creditWasApprovedNEQ - Boolean
|
|
creditWasApprovedIsNil - Boolean
|
|
creditWasApprovedNotNil - Boolean
|
|
hasAuthor - Boolean
|
author edge predicates |
hasAuthorWith - [UserWhereInput!]
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
|
hasParent - Boolean
|
parent edge predicates |
hasParentWith - [CommentWhereInput!]
|
|
hasReplies - Boolean
|
replies edge predicates |
hasRepliesWith - [CommentWhereInput!]
|
|
hasEducationCredit - Boolean
|
education_credit edge predicates |
hasEducationCreditWith - [EducationCreditWhereInput!]
|
|
hasCommentNamedEntities - Boolean
|
comment_named_entities edge predicates |
hasCommentNamedEntitiesWith - [CommentNamedEntityWhereInput!]
|
|
hasReviewedBy - Boolean
|
reviewed_by edge predicates |
hasReviewedByWith - [UserWhereInput!]
|
|
hasSparkyConversations - Boolean
|
sparky_conversations edge predicates |
hasSparkyConversationsWith - [SparkyConversationWhereInput!]
|
|
hasLikedUsers - Boolean
|
liked_users edge predicates |
hasLikedUsersWith - [UserWhereInput!]
|
|
hasCommentLikes - Boolean
|
comment_likes edge predicates |
hasCommentLikesWith - [CommentLikeWhereInput!]
|
Example
{}
Course
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String
|
|
disclosure - String
|
|
startDate - Time
|
|
creditHours - Float!
|
|
price - Float!
|
|
website - String
|
|
isRaceApproved - Boolean!
|
|
type - CourseType!
|
|
createdAt - Time!
|
|
status - CourseStatus!
|
|
reviewedAt - Time
|
|
author - User
|
|
faculty - [User!]
|
|
reviewedBy - User
|
|
tenant - Tenant
|
|
video - Video
|
Example
{
"id": 4,
"name": "xyz789",
"description": "xyz789",
"disclosure": "abc123",
"startDate": "10:15:30Z",
"creditHours": 123.45,
"price": 987.65,
"website": "abc123",
"isRaceApproved": true,
"type": "ondemand",
"createdAt": "10:15:30Z",
"status": "pending",
"reviewedAt": "10:15:30Z",
"author": User,
"faculty": [User],
"reviewedBy": User,
"tenant": Tenant,
"video": Video
}
CourseConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [CourseEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [CourseEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
CourseEdge
CourseStatus
Description
CourseStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
CourseType
Description
CourseType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
CourseWhereInput
Description
CourseWhereInput is used for filtering Course objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - CourseWhereInput
|
|
and - [CourseWhereInput!]
|
|
or - [CourseWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
description - String
|
description field predicates |
descriptionNEQ - String
|
|
descriptionIn - [String!]
|
|
descriptionNotIn - [String!]
|
|
descriptionGT - String
|
|
descriptionGTE - String
|
|
descriptionLT - String
|
|
descriptionLTE - String
|
|
descriptionContains - String
|
|
descriptionHasPrefix - String
|
|
descriptionHasSuffix - String
|
|
descriptionIsNil - Boolean
|
|
descriptionNotNil - Boolean
|
|
descriptionEqualFold - String
|
|
descriptionContainsFold - String
|
|
disclosure - String
|
disclosure field predicates |
disclosureNEQ - String
|
|
disclosureIn - [String!]
|
|
disclosureNotIn - [String!]
|
|
disclosureGT - String
|
|
disclosureGTE - String
|
|
disclosureLT - String
|
|
disclosureLTE - String
|
|
disclosureContains - String
|
|
disclosureHasPrefix - String
|
|
disclosureHasSuffix - String
|
|
disclosureIsNil - Boolean
|
|
disclosureNotNil - Boolean
|
|
disclosureEqualFold - String
|
|
disclosureContainsFold - String
|
|
startDate - Time
|
start_date field predicates |
startDateNEQ - Time
|
|
startDateIn - [Time!]
|
|
startDateNotIn - [Time!]
|
|
startDateGT - Time
|
|
startDateGTE - Time
|
|
startDateLT - Time
|
|
startDateLTE - Time
|
|
startDateIsNil - Boolean
|
|
startDateNotNil - Boolean
|
|
creditHours - Float
|
credit_hours field predicates |
creditHoursNEQ - Float
|
|
creditHoursIn - [Float!]
|
|
creditHoursNotIn - [Float!]
|
|
creditHoursGT - Float
|
|
creditHoursGTE - Float
|
|
creditHoursLT - Float
|
|
creditHoursLTE - Float
|
|
price - Float
|
price field predicates |
priceNEQ - Float
|
|
priceIn - [Float!]
|
|
priceNotIn - [Float!]
|
|
priceGT - Float
|
|
priceGTE - Float
|
|
priceLT - Float
|
|
priceLTE - Float
|
|
website - String
|
website field predicates |
websiteNEQ - String
|
|
websiteIn - [String!]
|
|
websiteNotIn - [String!]
|
|
websiteGT - String
|
|
websiteGTE - String
|
|
websiteLT - String
|
|
websiteLTE - String
|
|
websiteContains - String
|
|
websiteHasPrefix - String
|
|
websiteHasSuffix - String
|
|
websiteIsNil - Boolean
|
|
websiteNotNil - Boolean
|
|
websiteEqualFold - String
|
|
websiteContainsFold - String
|
|
isRaceApproved - Boolean
|
is_race_approved field predicates |
isRaceApprovedNEQ - Boolean
|
|
type - CourseType
|
type field predicates |
typeNEQ - CourseType
|
|
typeIn - [CourseType!]
|
|
typeNotIn - [CourseType!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
status - CourseStatus
|
status field predicates |
statusNEQ - CourseStatus
|
|
statusIn - [CourseStatus!]
|
|
statusNotIn - [CourseStatus!]
|
|
reviewedAt - Time
|
reviewed_at field predicates |
reviewedAtNEQ - Time
|
|
reviewedAtIn - [Time!]
|
|
reviewedAtNotIn - [Time!]
|
|
reviewedAtGT - Time
|
|
reviewedAtGTE - Time
|
|
reviewedAtLT - Time
|
|
reviewedAtLTE - Time
|
|
reviewedAtIsNil - Boolean
|
|
reviewedAtNotNil - Boolean
|
|
hasAuthor - Boolean
|
author edge predicates |
hasAuthorWith - [UserWhereInput!]
|
|
hasFaculty - Boolean
|
faculty edge predicates |
hasFacultyWith - [UserWhereInput!]
|
|
hasReviewedBy - Boolean
|
reviewed_by edge predicates |
hasReviewedByWith - [UserWhereInput!]
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
CreateAnatomicalModelInput
Description
CreateAnatomicalModelInput is used for create AnatomicalModel object. Input was generated by ent.
Example
{}
CreateAudienceInput
Description
CreateAudienceInput is used for create Audience object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
designationtemplate - String!
|
The raw text template for the designation text that will be displayed on the certificate. Use the designation field to get the rendered text. |
createdAt - Time
|
|
updatedAt - Time
|
|
npiTaxonomyIDs - [ID!]
|
|
postIDs - [ID!]
|
|
tenantID - ID
|
Example
{}
CreateCertificateInput
Fields
| Input Field | Description |
|---|---|
educationCreditIDs - [ID!]!
|
|
surveyAnswers - [CreateCertificateSurveyAnswerInput!]!
|
Example
{}
CreateCertificateSurveyAnswerInput
Description
CreateCertificateSurveyAnswerInput is used for create CertificateSurveyAnswer object. Input was generated by ent.
Example
{}
CreateCertificateSurveyQuestionChoiceInput
CreateCertificateSurveyQuestionInput
CreateCollectionInput
Description
CreateCollectionInput is used for create Collection object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the collection. |
description - String
|
The description of the collection. |
totalDuration - Int
|
The total duration of all the posts in the collection. |
totalPosts - Int
|
The total number of posts in the collection. |
tenantID - ID
|
|
postcollectionIDs - [ID!]
|
|
coverID - ID
|
|
userCompletionIDs - [ID!]
|
Example
{}
CreateCommentInput
Description
CreateCommentInput is used for create Comment object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
body - String!
|
Body of the comment |
reflectionPrompt - String
|
The reflection prompt the user chose for this comment |
totalLikes - Int
|
The total number of likes this comment has |
createdAt - Time
|
|
updatedAt - Time
|
|
shouldEarnCredits - Boolean
|
Whether or not the user should earn credits for this comment |
didEarnCredits - Boolean
|
Whether or not the user earned credits for this comment |
creditWasApproved - Boolean
|
Whether or not the credit was approved |
authorID - ID
|
|
postID - ID
|
|
parentID - ID
|
|
replyIDs - [ID!]
|
|
educationCreditID - ID
|
|
commentNamedEntityIDs - [ID!]
|
|
reviewedByID - ID
|
|
sparkyConversationIDs - [ID!]
|
|
likedUserIDs - [ID!]
|
Example
{}
CreateCourseInput
Description
CreateCourseInput is used for create Course object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
description - String
|
|
disclosure - String
|
|
startDate - Time
|
|
creditHours - Float
|
|
price - Float
|
|
website - String
|
|
isRaceApproved - Boolean
|
|
type - CourseType
|
|
createdAt - Time
|
|
status - CourseStatus
|
|
reviewedAt - Time
|
|
authorID - ID
|
|
facultyIDs - [ID!]
|
|
reviewedByID - ID
|
|
tenantID - ID
|
|
videoID - ID
|
Example
{}
CreateEducationHistoryInput
Description
CreateEducationHistoryInput is used for create EducationHistory object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
institution - String!
|
The institution/school name for this education history entry. |
degree - String
|
The degree attained for this education history entry. |
major - String
|
The major for this education history entry. |
startDate - Time
|
|
endDate - Time
|
|
type - EducationHistoryType
|
|
userID - ID
|
Example
{}
CreateFinancialDisclosureRoleInput
Description
CreateFinancialDisclosureRoleInput is used for create FinancialDisclosureRole object. Input was generated by ent.
Example
{}
CreateFinancialDisclosureStatementInput
Description
CreateFinancialDisclosureStatementInput is used for create FinancialDisclosureStatement object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
deletedAt - Time
|
|
approvedAt - Time
|
The date the financial disclosure statement was approved (Admin Only) |
deniedAt - Time
|
The date the financial disclosure statement was denied (Admin Only) |
status - FinancialDisclosureStatementStatus
|
The status of the financial disclosure statement (Admin Only) |
requiresApproval - Boolean
|
If true, at least one of the relationships has a role requiring approval (Admin Only) |
hasFinancialRelationships - Boolean
|
If true, the user has financial relationships |
agreesToDisclose - Boolean
|
If true, the user agrees to disclose unlabeled/unapproved users of drugs or products |
doesAttest - Boolean
|
If true, the user attests that the information provided is true and accurate |
initials - String!
|
The initials of the user |
signatureDate - Time!
|
The date the user signed the financial disclosure statement |
createdAt - Time
|
|
updatedAt - Time
|
|
userID - ID
|
|
relationshipIDs - [ID!]
|
|
relationships - [FinancialDisclosureInput!]
|
Input for creating a relationship with a company. |
Example
{}
CreateLearningObjectiveInput
Description
CreateLearningObjectiveInput is used for create LearningObjective object. Input was generated by ent.
Example
{}
CreateLicenseHistoryInput
CreateMediaItemInput
Description
CreateMediaItemInput is used for create MediaItem object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
publicID - String!
|
[Deprecated] The public ID in Cloudinary of the media item. |
width - Int!
|
The width of the media item in pixels. |
height - Int!
|
The height of the media item in pixels. |
bytes - Int!
|
The size of the media item in bytes. |
format - String!
|
The format of the media item. ie jpg, png, gif, etc. |
mediaType - String!
|
The type of media item. Will be image or video |
url - String!
|
The URL of the media item. |
originalFilename - String!
|
The original filename of the media item. |
ordinal - Int
|
|
duration - Int
|
The duration of the media item in seconds. |
postID - ID
|
Example
{}
CreateOfficeInput
Description
CreateOfficeInput is used for create Office object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
primary - Boolean
|
Whether the office is the primary office location. |
address1 - String!
|
The first line of the address. Typically the street address or PO Box number. |
address2 - String
|
The second line of the address. Typically the number of the apartment, suite, or unit. |
city - String!
|
The city of the office |
stateCode - String!
|
The two-letter code for the region. For example CA for California. |
zip - String!
|
The zip or postal code of the address. |
countryCode - String
|
The two-letter code for the country of the address. For example US for United States. |
phone - String
|
The phone number of the office, Formatted using E.164 standard. |
fax - String
|
The fax number of the office. Formatted using E.164 standard. |
email - String
|
The email address for the office |
userID - ID
|
Example
{}
CreatePollQuestionInput
CreatePostCitationInput
CreatePostInput
Description
The field used to create a new Post.
Fields
| Input Field | Description |
|---|---|
title - String!
|
Title of the post |
creditHours - Float
|
The number of CE credits this post is accredited for |
status - PostStatus
|
Status of the post |
body - String!
|
Body of the post. Tags (starting with a #) and Mentions (starting with an @) are allowed |
featured - Boolean
|
Whether this post is featured |
discussionPoints - [String!]
|
The main discussion points for this post |
createdAt - Time
|
|
updatedAt - Time
|
|
sortKey - Int
|
|
terms - [String!]
|
|
termFrequencies - Map
|
|
wordcloud - String
|
|
type - PostType
|
The type of the post |
authorID - ID
|
|
topicIDs - [ID!]
|
|
citationIDs - [ID!]
|
|
tenantID - ID
|
|
accreditedLearningObjectiveID - ID
|
|
commentIDs - [ID!]
|
|
mediaItemIDs - [ID!]
|
|
videoIDs - [ID!]
|
|
coverImageID - ID
|
|
imageIDs - [ID!]
|
|
postCollectionIDs - [ID!]
|
|
educationCreditIDs - [ID!]
|
|
audienceIDs - [ID!]
|
|
postTagIDs - [ID!]
|
|
likedUserIDs - [ID!]
|
|
bookmarkedUserIDs - [ID!]
|
|
learningObjectiveIDs - [ID!]
|
|
postReportIDs - [ID!]
|
|
pollID - ID
|
|
embeddingIDs - [ID!]
|
|
createCitations - [CreatePostCitationInput!]
|
Create a Citation for the post |
createPollQuestions - [CreatePollQuestionInput!]
|
Create a Poll for the post |
Example
{}
CreatePubmedTopicClusterInput
CreateReportReasonInput
Description
CreateReportReasonInput is used for create ReportReason object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{}
CreateSparkyChatConfigInput
Description
CreateSparkyChatConfigInput is used for create SparkyChatConfig object. Input was generated by ent.
Example
{}
CreateTopicInput
Description
CreateTopicInput is used for create Topic object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
The name of the topic. |
ordinal - Int
|
The ordinal of the topic. |
type - TopicType
|
The type of the topic. |
modelID - String
|
|
modelVersion - String
|
|
totalPosts - Int
|
The total number of posts that are tagged with the topic. |
words - [String!]
|
|
wordFrequencies - Map
|
|
generatedLabel - String
|
|
clusterID - Int
|
|
clusterLabel - String
|
|
tenantID - ID
|
|
coverID - ID
|
|
coverImageID - ID
|
|
userIDs - [ID!]
|
|
classificationIDs - [ID!]
|
|
postIDs - [ID!]
|
|
pubmedArticleIDs - [ID!]
|
|
npiTaxonomyIDs - [ID!]
|
|
parentID - ID
|
|
childIDs - [ID!]
|
|
pubmedTopicClusterIDs - [ID!]
|
Example
{}
CreateUserInput
Description
CreateUserInput is used for create User object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
firstName - String
|
The first name of the user |
lastName - String
|
The last name of the user |
disabled - Boolean
|
(Deprecated, use status instead) Whether the user is disabled |
status - UserStatus
|
The status of the user |
phone - String
|
The phone number of the user, stored in E.164 format |
email - String
|
The email address of the user |
password - String
|
The password of the user, stored as a bcrypt hash |
username - String
|
The username of the user |
credential - String
|
The credential of the user, ie MD, DO, PA, NP, etc. Note: Credentials are normalized to uppercase and any periods are removed. |
npiNumber - String
|
The NPI number of the user |
npiTaxonomyCode - String
|
The NPI taxonomy code of the user |
npiTaxonomyDescription - String
|
The NPI taxonomy description of the user |
bio - String
|
The bio of the user |
isStudent - Boolean
|
Whether the user is a student |
hasSubmittedDisclosure - Boolean
|
Whether the user has submitted a disclosure |
hasDisclosuresNeedingReview - Boolean
|
Whether the user has disclosures needing review |
reflectionsOnAuthoredPostsDisabled - Boolean
|
Whether reflections are disabled on posts authored by this user |
role - UserRole
|
The role of the user |
limitedRoles - [String!]
|
The limited roles of the user. Null or Empty array means no limited roles. |
createdAt - Time
|
|
updatedAt - Time
|
|
lastLoginAt - Time
|
The last time the user logged in |
cmeGoalValue - String
|
The CME goal value of the user |
cmeGoalDate - Time
|
The CME goal date of the user |
totalCmeEarned - Float
|
The total CME earned by the user |
suggested - Boolean
|
Whether the user has should appear in the suggested users list |
financialDisclosures - String
|
The financial disclosures for the user |
isStaff - Boolean
|
Whether the user is an oog staff user |
totalFollowers - Int
|
The total number of followers the user has |
totalFollowing - Int
|
The total number of users the user is following |
tenantIDs - [ID!]
|
|
topicIDs - [ID!]
|
|
followerIDs - [ID!]
|
|
followingIDs - [ID!]
|
|
postIDs - [ID!]
|
|
linkIDs - [ID!]
|
|
officeIDs - [ID!]
|
|
commentIDs - [ID!]
|
|
likedPostIDs - [ID!]
|
|
likedCommentIDs - [ID!]
|
|
bookmarkedPostIDs - [ID!]
|
|
avatarID - ID
|
|
profileImageID - ID
|
|
specialtyID - ID
|
|
workHistoryIDs - [ID!]
|
|
educationHistoryIDs - [ID!]
|
|
licenseHistoryIDs - [ID!]
|
|
educationCreditIDs - [ID!]
|
|
notificationTokenIDs - [ID!]
|
|
notificationIDs - [ID!]
|
|
outgoingNotificationIDs - [ID!]
|
|
searchIDs - [ID!]
|
|
apiTokenIDs - [ID!]
|
|
userCompletionIDs - [ID!]
|
|
financialDisclosureStatementID - ID
|
|
coursesCreatedIDs - [ID!]
|
|
coursesReviewedIDs - [ID!]
|
|
coursesFacultyIDs - [ID!]
|
|
userReportIDs - [ID!]
|
|
reportedByIDs - [ID!]
|
|
postReportIDs - [ID!]
|
|
mutedUserIDs - [ID!]
|
|
blockedUserIDs - [ID!]
|
|
accountConnectionIDs - [ID!]
|
|
importedVideoIDs - [ID!]
|
Example
{}
CreateUserLinkInput
CreateWorkExperienceInput
Description
CreateWorkExperienceInput is used for create WorkExperience object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
institution - String!
|
The institution of the work experience. |
specialty - String!
|
The specialty of the work experience. |
title - String
|
The title of the work experience. |
employment - WorkExperienceEmployment
|
The employment type of the work experience. |
startDate - Time
|
The start date of the work experience. |
endDate - Time
|
The end date of the work experience. |
city - String!
|
The city of the work experience. |
state - String!
|
The state of the work experience. |
userID - ID
|
Example
{}
Cursor
Description
Define a Relay Cursor type: https://relay.dev/graphql/connections.htm#sec-Cursor
Example
{}
Dashboard
Example
{
"id": 4,
"name": "xyz789",
"query": "xyz789",
"defaultOrderBy": "abc123",
"defaultOrderDirection": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
DashboardConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [DashboardEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [DashboardEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
DashboardEdge
DashboardWhereInput
Description
DashboardWhereInput is used for filtering Dashboard objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - DashboardWhereInput
|
|
and - [DashboardWhereInput!]
|
|
or - [DashboardWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
query - String
|
query field predicates |
queryNEQ - String
|
|
queryIn - [String!]
|
|
queryNotIn - [String!]
|
|
queryGT - String
|
|
queryGTE - String
|
|
queryLT - String
|
|
queryLTE - String
|
|
queryContains - String
|
|
queryHasPrefix - String
|
|
queryHasSuffix - String
|
|
queryEqualFold - String
|
|
queryContainsFold - String
|
|
defaultOrderBy - String
|
default_order_by field predicates |
defaultOrderByNEQ - String
|
|
defaultOrderByIn - [String!]
|
|
defaultOrderByNotIn - [String!]
|
|
defaultOrderByGT - String
|
|
defaultOrderByGTE - String
|
|
defaultOrderByLT - String
|
|
defaultOrderByLTE - String
|
|
defaultOrderByContains - String
|
|
defaultOrderByHasPrefix - String
|
|
defaultOrderByHasSuffix - String
|
|
defaultOrderByIsNil - Boolean
|
|
defaultOrderByNotNil - Boolean
|
|
defaultOrderByEqualFold - String
|
|
defaultOrderByContainsFold - String
|
|
defaultOrderDirection - String
|
default_order_direction field predicates |
defaultOrderDirectionNEQ - String
|
|
defaultOrderDirectionIn - [String!]
|
|
defaultOrderDirectionNotIn - [String!]
|
|
defaultOrderDirectionGT - String
|
|
defaultOrderDirectionGTE - String
|
|
defaultOrderDirectionLT - String
|
|
defaultOrderDirectionLTE - String
|
|
defaultOrderDirectionContains - String
|
|
defaultOrderDirectionHasPrefix - String
|
|
defaultOrderDirectionHasSuffix - String
|
|
defaultOrderDirectionIsNil - Boolean
|
|
defaultOrderDirectionNotNil - Boolean
|
|
defaultOrderDirectionEqualFold - String
|
|
defaultOrderDirectionContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
DownloadFinancialDisclosureStatement
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "xyz789"}
EducationCredit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
value - Float!
|
The value of the credit. |
deletedAt - Time
|
The time that the credit was deleted. |
redeemedAt - Time
|
The time that the credit was redeemed. |
deletedReason - String
|
The reason that the credit was deleted. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
survey - Map
|
The survey for the credit. |
userID - ID!
|
|
sparkyConversationID - ID
|
|
postID - ID
|
|
commentID - ID
|
|
type - EducationCreditType!
|
The type of the credit. |
tenant - Tenant
|
The tenant that the topic belongs to. |
user - User!
|
The user that created/earned the credit. |
comment - Comment
|
The comment that the credit was created on. |
post - Post
|
The post that the credit was created on. |
sparkyConversation - SparkyConversation
|
|
learningObjective - LearningObjective
|
The learning objective that the credit was for. |
deletedBy - User
|
The user that deleted the credit. |
userCollectionCompletions - [UserCollectionCompletion!]
|
The collections the user redeemed for this credit |
certificate - Certificate
|
The certificate that the credit was redeemed for. |
Example
{
"id": 4,
"value": 123.45,
"deletedAt": "10:15:30Z",
"redeemedAt": "10:15:30Z",
"deletedReason": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"survey": Map,
"userID": "4",
"sparkyConversationID": "4",
"postID": 4,
"commentID": 4,
"type": "reflection",
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"sparkyConversation": SparkyConversation,
"learningObjective": LearningObjective,
"deletedBy": User,
"userCollectionCompletions": [UserCollectionCompletion],
"certificate": Certificate
}
EducationCreditConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [EducationCreditEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [EducationCreditEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
EducationCreditEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - EducationCredit
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": EducationCredit,
"cursor": Cursor
}
EducationCreditOrder
Description
Ordering options for EducationCredit connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - EducationCreditOrderField!
|
The field by which to order EducationCredits. |
Example
{}
EducationCreditOrderField
Description
Properties by which EducationCredit connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
EducationCreditType
Description
EducationCreditType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EducationCreditWhereInput
Description
EducationCreditWhereInput is used for filtering EducationCredit objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - EducationCreditWhereInput
|
|
and - [EducationCreditWhereInput!]
|
|
or - [EducationCreditWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
value - Float
|
value field predicates |
valueNEQ - Float
|
|
valueIn - [Float!]
|
|
valueNotIn - [Float!]
|
|
valueGT - Float
|
|
valueGTE - Float
|
|
valueLT - Float
|
|
valueLTE - Float
|
|
deletedAt - Time
|
deleted_at field predicates |
deletedAtNEQ - Time
|
|
deletedAtIn - [Time!]
|
|
deletedAtNotIn - [Time!]
|
|
deletedAtGT - Time
|
|
deletedAtGTE - Time
|
|
deletedAtLT - Time
|
|
deletedAtLTE - Time
|
|
deletedAtIsNil - Boolean
|
|
deletedAtNotNil - Boolean
|
|
redeemedAt - Time
|
redeemed_at field predicates |
redeemedAtNEQ - Time
|
|
redeemedAtIn - [Time!]
|
|
redeemedAtNotIn - [Time!]
|
|
redeemedAtGT - Time
|
|
redeemedAtGTE - Time
|
|
redeemedAtLT - Time
|
|
redeemedAtLTE - Time
|
|
redeemedAtIsNil - Boolean
|
|
redeemedAtNotNil - Boolean
|
|
deletedReason - String
|
deleted_reason field predicates |
deletedReasonNEQ - String
|
|
deletedReasonIn - [String!]
|
|
deletedReasonNotIn - [String!]
|
|
deletedReasonGT - String
|
|
deletedReasonGTE - String
|
|
deletedReasonLT - String
|
|
deletedReasonLTE - String
|
|
deletedReasonContains - String
|
|
deletedReasonHasPrefix - String
|
|
deletedReasonHasSuffix - String
|
|
deletedReasonIsNil - Boolean
|
|
deletedReasonNotNil - Boolean
|
|
deletedReasonEqualFold - String
|
|
deletedReasonContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
sparkyConversationID - ID
|
sparky_conversation_id field predicates |
sparkyConversationIDNEQ - ID
|
|
sparkyConversationIDIn - [ID!]
|
|
sparkyConversationIDNotIn - [ID!]
|
|
sparkyConversationIDIsNil - Boolean
|
|
sparkyConversationIDNotNil - Boolean
|
|
postID - ID
|
post_id field predicates |
postIDNEQ - ID
|
|
postIDIn - [ID!]
|
|
postIDNotIn - [ID!]
|
|
postIDIsNil - Boolean
|
|
postIDNotNil - Boolean
|
|
commentID - ID
|
comment_id field predicates |
commentIDNEQ - ID
|
|
commentIDIn - [ID!]
|
|
commentIDNotIn - [ID!]
|
|
commentIDIsNil - Boolean
|
|
commentIDNotNil - Boolean
|
|
type - EducationCreditType
|
type field predicates |
typeNEQ - EducationCreditType
|
|
typeIn - [EducationCreditType!]
|
|
typeNotIn - [EducationCreditType!]
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasComment - Boolean
|
comment edge predicates |
hasCommentWith - [CommentWhereInput!]
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
|
hasSparkyConversation - Boolean
|
sparky_conversation edge predicates |
hasSparkyConversationWith - [SparkyConversationWhereInput!]
|
|
hasLearningObjective - Boolean
|
learning_objective edge predicates |
hasLearningObjectiveWith - [LearningObjectiveWhereInput!]
|
|
hasDeletedBy - Boolean
|
deleted_by edge predicates |
hasDeletedByWith - [UserWhereInput!]
|
|
hasUserCollectionCompletions - Boolean
|
user_collection_completions edge predicates |
hasUserCollectionCompletionsWith - [UserCollectionCompletionWhereInput!]
|
|
hasCertificate - Boolean
|
certificate edge predicates |
hasCertificateWith - [CertificateWhereInput!]
|
Example
{}
EducationHistory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
institution - String!
|
The institution/school name for this education history entry. |
degree - String
|
The degree attained for this education history entry. |
major - String
|
The major for this education history entry. |
startDate - Time
|
|
endDate - Time
|
|
type - EducationHistoryType!
|
|
user - User
|
Education history for a user. |
Example
{
"id": 4,
"institution": "xyz789",
"degree": "abc123",
"major": "xyz789",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"type": "education",
"user": User
}
EducationHistoryConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [EducationHistoryEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [EducationHistoryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
EducationHistoryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - EducationHistory
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": EducationHistory,
"cursor": Cursor
}
EducationHistoryType
Description
EducationHistoryType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
EducationHistoryWhereInput
Description
EducationHistoryWhereInput is used for filtering EducationHistory objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - EducationHistoryWhereInput
|
|
and - [EducationHistoryWhereInput!]
|
|
or - [EducationHistoryWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
institution - String
|
institution field predicates |
institutionNEQ - String
|
|
institutionIn - [String!]
|
|
institutionNotIn - [String!]
|
|
institutionGT - String
|
|
institutionGTE - String
|
|
institutionLT - String
|
|
institutionLTE - String
|
|
institutionContains - String
|
|
institutionHasPrefix - String
|
|
institutionHasSuffix - String
|
|
institutionEqualFold - String
|
|
institutionContainsFold - String
|
|
degree - String
|
degree field predicates |
degreeNEQ - String
|
|
degreeIn - [String!]
|
|
degreeNotIn - [String!]
|
|
degreeGT - String
|
|
degreeGTE - String
|
|
degreeLT - String
|
|
degreeLTE - String
|
|
degreeContains - String
|
|
degreeHasPrefix - String
|
|
degreeHasSuffix - String
|
|
degreeIsNil - Boolean
|
|
degreeNotNil - Boolean
|
|
degreeEqualFold - String
|
|
degreeContainsFold - String
|
|
major - String
|
major field predicates |
majorNEQ - String
|
|
majorIn - [String!]
|
|
majorNotIn - [String!]
|
|
majorGT - String
|
|
majorGTE - String
|
|
majorLT - String
|
|
majorLTE - String
|
|
majorContains - String
|
|
majorHasPrefix - String
|
|
majorHasSuffix - String
|
|
majorIsNil - Boolean
|
|
majorNotNil - Boolean
|
|
majorEqualFold - String
|
|
majorContainsFold - String
|
|
startDate - Time
|
start_date field predicates |
startDateNEQ - Time
|
|
startDateIn - [Time!]
|
|
startDateNotIn - [Time!]
|
|
startDateGT - Time
|
|
startDateGTE - Time
|
|
startDateLT - Time
|
|
startDateLTE - Time
|
|
startDateIsNil - Boolean
|
|
startDateNotNil - Boolean
|
|
endDate - Time
|
end_date field predicates |
endDateNEQ - Time
|
|
endDateIn - [Time!]
|
|
endDateNotIn - [Time!]
|
|
endDateGT - Time
|
|
endDateGTE - Time
|
|
endDateLT - Time
|
|
endDateLTE - Time
|
|
endDateIsNil - Boolean
|
|
endDateNotNil - Boolean
|
|
type - EducationHistoryType
|
type field predicates |
typeNEQ - EducationHistoryType
|
|
typeIn - [EducationHistoryType!]
|
|
typeNotIn - [EducationHistoryType!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
FaceDetectRequest
FaceDetectRequestWhereInput
Description
FaceDetectRequestWhereInput is used for filtering FaceDetectRequest objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - FaceDetectRequestWhereInput
|
|
and - [FaceDetectRequestWhereInput!]
|
|
or - [FaceDetectRequestWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
jobID - String
|
job_id field predicates |
jobIDNEQ - String
|
|
jobIDIn - [String!]
|
|
jobIDNotIn - [String!]
|
|
jobIDGT - String
|
|
jobIDGTE - String
|
|
jobIDLT - String
|
|
jobIDLTE - String
|
|
jobIDContains - String
|
|
jobIDHasPrefix - String
|
|
jobIDHasSuffix - String
|
|
jobIDEqualFold - String
|
|
jobIDContainsFold - String
|
|
status - String
|
status field predicates |
statusNEQ - String
|
|
statusIn - [String!]
|
|
statusNotIn - [String!]
|
|
statusGT - String
|
|
statusGTE - String
|
|
statusLT - String
|
|
statusLTE - String
|
|
statusContains - String
|
|
statusHasPrefix - String
|
|
statusHasSuffix - String
|
|
statusEqualFold - String
|
|
statusContainsFold - String
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
FeedConnection
Fields
| Field Name | Description |
|---|---|
edges - [PostEdge!]!
|
|
pageInfo - FeedPageInfo!
|
Example
{
"edges": [PostEdge],
"pageInfo": FeedPageInfo
}
FeedPageInfo
Example
{
"hasNextPage": true,
"startCursor": "abc123",
"endCursor": "xyz789"
}
FeedType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
FileUploadResponse
FinancialDisclosure
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
deletedAt - Time
|
|
companyName - String!
|
The name of the company the user is declaring this financial disclosure for |
createdAt - Time!
|
|
hasEnded - Boolean!
|
If true, the relationship with the company has ended |
updatedAt - Time!
|
|
statement - FinancialDisclosureStatement
|
|
role - FinancialDisclosureRole!
|
The role the user has at the declared company |
Example
{
"id": 4,
"deletedAt": "10:15:30Z",
"companyName": "abc123",
"createdAt": "10:15:30Z",
"hasEnded": true,
"updatedAt": "10:15:30Z",
"statement": FinancialDisclosureStatement,
"role": FinancialDisclosureRole
}
FinancialDisclosureConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [FinancialDisclosureEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [FinancialDisclosureEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
FinancialDisclosureEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - FinancialDisclosure
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": FinancialDisclosure,
"cursor": Cursor
}
FinancialDisclosureInput
FinancialDisclosureOrder
Description
Ordering options for FinancialDisclosure connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - FinancialDisclosureOrderField!
|
The field by which to order FinancialDisclosures. |
Example
{}
FinancialDisclosureOrderField
Description
Properties by which FinancialDisclosure connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
FinancialDisclosurePrintTemplate
FinancialDisclosurePrintTemplateConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [FinancialDisclosurePrintTemplateEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [FinancialDisclosurePrintTemplateEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
FinancialDisclosurePrintTemplateEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - FinancialDisclosurePrintTemplate
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": FinancialDisclosurePrintTemplate,
"cursor": Cursor
}
FinancialDisclosurePrintTemplateOrder
Description
Ordering options for FinancialDisclosurePrintTemplate connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - FinancialDisclosurePrintTemplateOrderField!
|
The field by which to order FinancialDisclosurePrintTemplates. |
Example
{}
FinancialDisclosurePrintTemplateOrderField
Description
Properties by which FinancialDisclosurePrintTemplate connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
FinancialDisclosurePrintTemplateWhereInput
Description
FinancialDisclosurePrintTemplateWhereInput is used for filtering FinancialDisclosurePrintTemplate objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - FinancialDisclosurePrintTemplateWhereInput
|
|
and - [FinancialDisclosurePrintTemplateWhereInput!]
|
|
or - [FinancialDisclosurePrintTemplateWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
template - String
|
template field predicates |
templateNEQ - String
|
|
templateIn - [String!]
|
|
templateNotIn - [String!]
|
|
templateGT - String
|
|
templateGTE - String
|
|
templateLT - String
|
|
templateLTE - String
|
|
templateContains - String
|
|
templateHasPrefix - String
|
|
templateHasSuffix - String
|
|
templateIsNil - Boolean
|
|
templateNotNil - Boolean
|
|
templateEqualFold - String
|
|
templateContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
FinancialDisclosureRole
Example
{
"id": 4,
"deletedAt": "10:15:30Z",
"name": "abc123",
"requiresApproval": false,
"automaticallyReject": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
FinancialDisclosureRoleConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [FinancialDisclosureRoleEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [FinancialDisclosureRoleEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
FinancialDisclosureRoleEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - FinancialDisclosureRole
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": FinancialDisclosureRole,
"cursor": Cursor
}
FinancialDisclosureRoleOrder
Description
Ordering options for FinancialDisclosureRole connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - FinancialDisclosureRoleOrderField!
|
The field by which to order FinancialDisclosureRoles. |
Example
{}
FinancialDisclosureRoleOrderField
Description
Properties by which FinancialDisclosureRole connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
FinancialDisclosureRoleWhereInput
Description
FinancialDisclosureRoleWhereInput is used for filtering FinancialDisclosureRole objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - FinancialDisclosureRoleWhereInput
|
|
and - [FinancialDisclosureRoleWhereInput!]
|
|
or - [FinancialDisclosureRoleWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
deletedAt - Time
|
deleted_at field predicates |
deletedAtNEQ - Time
|
|
deletedAtIn - [Time!]
|
|
deletedAtNotIn - [Time!]
|
|
deletedAtGT - Time
|
|
deletedAtGTE - Time
|
|
deletedAtLT - Time
|
|
deletedAtLTE - Time
|
|
deletedAtIsNil - Boolean
|
|
deletedAtNotNil - Boolean
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
requiresApproval - Boolean
|
requires_approval field predicates |
requiresApprovalNEQ - Boolean
|
|
automaticallyReject - Boolean
|
automatically_reject field predicates |
automaticallyRejectNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
FinancialDisclosureStatement
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
deletedAt - Time
|
|
approvedAt - Time
|
The date the financial disclosure statement was approved (Admin Only) |
deniedAt - Time
|
The date the financial disclosure statement was denied (Admin Only) |
status - FinancialDisclosureStatementStatus!
|
The status of the financial disclosure statement (Admin Only) |
requiresApproval - Boolean!
|
If true, at least one of the relationships has a role requiring approval (Admin Only) |
hasFinancialRelationships - Boolean!
|
If true, the user has financial relationships |
agreesToDisclose - Boolean!
|
If true, the user agrees to disclose unlabeled/unapproved users of drugs or products |
doesAttest - Boolean!
|
If true, the user attests that the information provided is true and accurate |
initials - String!
|
The initials of the user |
signatureDate - Time!
|
The date the user signed the financial disclosure statement |
createdAt - Time!
|
|
updatedAt - Time!
|
|
user - User
|
|
relationships - [FinancialDisclosure!]
|
Example
{
"id": 4,
"deletedAt": "10:15:30Z",
"approvedAt": "10:15:30Z",
"deniedAt": "10:15:30Z",
"status": "approved",
"requiresApproval": false,
"hasFinancialRelationships": false,
"agreesToDisclose": true,
"doesAttest": false,
"initials": "xyz789",
"signatureDate": "10:15:30Z",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User,
"relationships": [FinancialDisclosure]
}
FinancialDisclosureStatementConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [FinancialDisclosureStatementEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [FinancialDisclosureStatementEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
FinancialDisclosureStatementEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - FinancialDisclosureStatement
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": FinancialDisclosureStatement,
"cursor": Cursor
}
FinancialDisclosureStatementOrder
Description
Ordering options for FinancialDisclosureStatement connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - FinancialDisclosureStatementOrderField!
|
The field by which to order FinancialDisclosureStatements. |
Example
{}
FinancialDisclosureStatementOrderField
Description
Properties by which FinancialDisclosureStatement connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
FinancialDisclosureStatementStatus
Description
FinancialDisclosureStatementStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
FinancialDisclosureStatementWhereInput
Description
FinancialDisclosureStatementWhereInput is used for filtering FinancialDisclosureStatement objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - FinancialDisclosureStatementWhereInput
|
|
and - [FinancialDisclosureStatementWhereInput!]
|
|
or - [FinancialDisclosureStatementWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
deletedAt - Time
|
deleted_at field predicates |
deletedAtNEQ - Time
|
|
deletedAtIn - [Time!]
|
|
deletedAtNotIn - [Time!]
|
|
deletedAtGT - Time
|
|
deletedAtGTE - Time
|
|
deletedAtLT - Time
|
|
deletedAtLTE - Time
|
|
deletedAtIsNil - Boolean
|
|
deletedAtNotNil - Boolean
|
|
approvedAt - Time
|
approved_at field predicates |
approvedAtNEQ - Time
|
|
approvedAtIn - [Time!]
|
|
approvedAtNotIn - [Time!]
|
|
approvedAtGT - Time
|
|
approvedAtGTE - Time
|
|
approvedAtLT - Time
|
|
approvedAtLTE - Time
|
|
approvedAtIsNil - Boolean
|
|
approvedAtNotNil - Boolean
|
|
deniedAt - Time
|
denied_at field predicates |
deniedAtNEQ - Time
|
|
deniedAtIn - [Time!]
|
|
deniedAtNotIn - [Time!]
|
|
deniedAtGT - Time
|
|
deniedAtGTE - Time
|
|
deniedAtLT - Time
|
|
deniedAtLTE - Time
|
|
deniedAtIsNil - Boolean
|
|
deniedAtNotNil - Boolean
|
|
status - FinancialDisclosureStatementStatus
|
status field predicates |
statusNEQ - FinancialDisclosureStatementStatus
|
|
statusIn - [FinancialDisclosureStatementStatus!]
|
|
statusNotIn - [FinancialDisclosureStatementStatus!]
|
|
requiresApproval - Boolean
|
requires_approval field predicates |
requiresApprovalNEQ - Boolean
|
|
hasFinancialRelationships - Boolean
|
has_financial_relationships field predicates |
hasFinancialRelationshipsNEQ - Boolean
|
|
agreesToDisclose - Boolean
|
agrees_to_disclose field predicates |
agreesToDiscloseNEQ - Boolean
|
|
doesAttest - Boolean
|
does_attest field predicates |
doesAttestNEQ - Boolean
|
|
initials - String
|
initials field predicates |
initialsNEQ - String
|
|
initialsIn - [String!]
|
|
initialsNotIn - [String!]
|
|
initialsGT - String
|
|
initialsGTE - String
|
|
initialsLT - String
|
|
initialsLTE - String
|
|
initialsContains - String
|
|
initialsHasPrefix - String
|
|
initialsHasSuffix - String
|
|
initialsEqualFold - String
|
|
initialsContainsFold - String
|
|
signatureDate - Time
|
signature_date field predicates |
signatureDateNEQ - Time
|
|
signatureDateIn - [Time!]
|
|
signatureDateNotIn - [Time!]
|
|
signatureDateGT - Time
|
|
signatureDateGTE - Time
|
|
signatureDateLT - Time
|
|
signatureDateLTE - Time
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasRelationships - Boolean
|
relationships edge predicates |
hasRelationshipsWith - [FinancialDisclosureWhereInput!]
|
Example
{}
FinancialDisclosureWhereInput
Description
FinancialDisclosureWhereInput is used for filtering FinancialDisclosure objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - FinancialDisclosureWhereInput
|
|
and - [FinancialDisclosureWhereInput!]
|
|
or - [FinancialDisclosureWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
deletedAt - Time
|
deleted_at field predicates |
deletedAtNEQ - Time
|
|
deletedAtIn - [Time!]
|
|
deletedAtNotIn - [Time!]
|
|
deletedAtGT - Time
|
|
deletedAtGTE - Time
|
|
deletedAtLT - Time
|
|
deletedAtLTE - Time
|
|
deletedAtIsNil - Boolean
|
|
deletedAtNotNil - Boolean
|
|
companyName - String
|
company_name field predicates |
companyNameNEQ - String
|
|
companyNameIn - [String!]
|
|
companyNameNotIn - [String!]
|
|
companyNameGT - String
|
|
companyNameGTE - String
|
|
companyNameLT - String
|
|
companyNameLTE - String
|
|
companyNameContains - String
|
|
companyNameHasPrefix - String
|
|
companyNameHasSuffix - String
|
|
companyNameEqualFold - String
|
|
companyNameContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasEnded - Boolean
|
has_ended field predicates |
hasEndedNEQ - Boolean
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasStatement - Boolean
|
statement edge predicates |
hasStatementWith - [FinancialDisclosureStatementWhereInput!]
|
|
hasRole - Boolean
|
role edge predicates |
hasRoleWith - [FinancialDisclosureRoleWhereInput!]
|
Example
{}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
{}
GoogleDriveFile
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fileID - String!
|
|
driveID - String!
|
|
originalFilename - String!
|
|
mimeType - String!
|
|
folder - String
|
|
parents - [String!]
|
|
durationMillis - Int
|
|
size - Int
|
|
createdTime - Time
|
|
copyStartedAt - Time
|
|
copyCompletedAt - Time
|
|
copyErrorMessage - String
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
video - Video
|
Example
{
"id": "4",
"fileID": "xyz789",
"driveID": "xyz789",
"originalFilename": "abc123",
"mimeType": "xyz789",
"folder": "xyz789",
"parents": ["abc123"],
"durationMillis": 987,
"size": 123,
"createdTime": "10:15:30Z",
"copyStartedAt": "10:15:30Z",
"copyCompletedAt": "10:15:30Z",
"copyErrorMessage": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"video": Video
}
GoogleDriveFileConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [GoogleDriveFileEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [GoogleDriveFileEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
GoogleDriveFileEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - GoogleDriveFile
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": GoogleDriveFile,
"cursor": Cursor
}
GoogleDriveFileOrder
Description
Ordering options for GoogleDriveFile connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - GoogleDriveFileOrderField!
|
The field by which to order GoogleDriveFiles. |
Example
{}
GoogleDriveFileOrderField
Description
Properties by which GoogleDriveFile connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
GoogleDriveFileWhereInput
Description
GoogleDriveFileWhereInput is used for filtering GoogleDriveFile objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - GoogleDriveFileWhereInput
|
|
and - [GoogleDriveFileWhereInput!]
|
|
or - [GoogleDriveFileWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
fileID - String
|
file_id field predicates |
fileIDNEQ - String
|
|
fileIDIn - [String!]
|
|
fileIDNotIn - [String!]
|
|
fileIDGT - String
|
|
fileIDGTE - String
|
|
fileIDLT - String
|
|
fileIDLTE - String
|
|
fileIDContains - String
|
|
fileIDHasPrefix - String
|
|
fileIDHasSuffix - String
|
|
fileIDEqualFold - String
|
|
fileIDContainsFold - String
|
|
driveID - String
|
drive_id field predicates |
driveIDNEQ - String
|
|
driveIDIn - [String!]
|
|
driveIDNotIn - [String!]
|
|
driveIDGT - String
|
|
driveIDGTE - String
|
|
driveIDLT - String
|
|
driveIDLTE - String
|
|
driveIDContains - String
|
|
driveIDHasPrefix - String
|
|
driveIDHasSuffix - String
|
|
driveIDEqualFold - String
|
|
driveIDContainsFold - String
|
|
originalFilename - String
|
original_filename field predicates |
originalFilenameNEQ - String
|
|
originalFilenameIn - [String!]
|
|
originalFilenameNotIn - [String!]
|
|
originalFilenameGT - String
|
|
originalFilenameGTE - String
|
|
originalFilenameLT - String
|
|
originalFilenameLTE - String
|
|
originalFilenameContains - String
|
|
originalFilenameHasPrefix - String
|
|
originalFilenameHasSuffix - String
|
|
originalFilenameEqualFold - String
|
|
originalFilenameContainsFold - String
|
|
mimeType - String
|
mime_type field predicates |
mimeTypeNEQ - String
|
|
mimeTypeIn - [String!]
|
|
mimeTypeNotIn - [String!]
|
|
mimeTypeGT - String
|
|
mimeTypeGTE - String
|
|
mimeTypeLT - String
|
|
mimeTypeLTE - String
|
|
mimeTypeContains - String
|
|
mimeTypeHasPrefix - String
|
|
mimeTypeHasSuffix - String
|
|
mimeTypeEqualFold - String
|
|
mimeTypeContainsFold - String
|
|
folder - String
|
folder field predicates |
folderNEQ - String
|
|
folderIn - [String!]
|
|
folderNotIn - [String!]
|
|
folderGT - String
|
|
folderGTE - String
|
|
folderLT - String
|
|
folderLTE - String
|
|
folderContains - String
|
|
folderHasPrefix - String
|
|
folderHasSuffix - String
|
|
folderIsNil - Boolean
|
|
folderNotNil - Boolean
|
|
folderEqualFold - String
|
|
folderContainsFold - String
|
|
durationMillis - Int
|
duration_millis field predicates |
durationMillisNEQ - Int
|
|
durationMillisIn - [Int!]
|
|
durationMillisNotIn - [Int!]
|
|
durationMillisGT - Int
|
|
durationMillisGTE - Int
|
|
durationMillisLT - Int
|
|
durationMillisLTE - Int
|
|
durationMillisIsNil - Boolean
|
|
durationMillisNotNil - Boolean
|
|
size - Int
|
size field predicates |
sizeNEQ - Int
|
|
sizeIn - [Int!]
|
|
sizeNotIn - [Int!]
|
|
sizeGT - Int
|
|
sizeGTE - Int
|
|
sizeLT - Int
|
|
sizeLTE - Int
|
|
sizeIsNil - Boolean
|
|
sizeNotNil - Boolean
|
|
createdTime - Time
|
created_time field predicates |
createdTimeNEQ - Time
|
|
createdTimeIn - [Time!]
|
|
createdTimeNotIn - [Time!]
|
|
createdTimeGT - Time
|
|
createdTimeGTE - Time
|
|
createdTimeLT - Time
|
|
createdTimeLTE - Time
|
|
createdTimeIsNil - Boolean
|
|
createdTimeNotNil - Boolean
|
|
copyStartedAt - Time
|
copy_started_at field predicates |
copyStartedAtNEQ - Time
|
|
copyStartedAtIn - [Time!]
|
|
copyStartedAtNotIn - [Time!]
|
|
copyStartedAtGT - Time
|
|
copyStartedAtGTE - Time
|
|
copyStartedAtLT - Time
|
|
copyStartedAtLTE - Time
|
|
copyStartedAtIsNil - Boolean
|
|
copyStartedAtNotNil - Boolean
|
|
copyCompletedAt - Time
|
copy_completed_at field predicates |
copyCompletedAtNEQ - Time
|
|
copyCompletedAtIn - [Time!]
|
|
copyCompletedAtNotIn - [Time!]
|
|
copyCompletedAtGT - Time
|
|
copyCompletedAtGTE - Time
|
|
copyCompletedAtLT - Time
|
|
copyCompletedAtLTE - Time
|
|
copyCompletedAtIsNil - Boolean
|
|
copyCompletedAtNotNil - Boolean
|
|
copyErrorMessage - String
|
copy_error_message field predicates |
copyErrorMessageNEQ - String
|
|
copyErrorMessageIn - [String!]
|
|
copyErrorMessageNotIn - [String!]
|
|
copyErrorMessageGT - String
|
|
copyErrorMessageGTE - String
|
|
copyErrorMessageLT - String
|
|
copyErrorMessageLTE - String
|
|
copyErrorMessageContains - String
|
|
copyErrorMessageHasPrefix - String
|
|
copyErrorMessageHasSuffix - String
|
|
copyErrorMessageIsNil - Boolean
|
|
copyErrorMessageNotNil - Boolean
|
|
copyErrorMessageEqualFold - String
|
|
copyErrorMessageContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
GptLog
GptLogWhereInput
Description
GptLogWhereInput is used for filtering GptLog objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - GptLogWhereInput
|
|
and - [GptLogWhereInput!]
|
|
or - [GptLogWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
prompt - String
|
prompt field predicates |
promptNEQ - String
|
|
promptIn - [String!]
|
|
promptNotIn - [String!]
|
|
promptGT - String
|
|
promptGTE - String
|
|
promptLT - String
|
|
promptLTE - String
|
|
promptContains - String
|
|
promptHasPrefix - String
|
|
promptHasSuffix - String
|
|
promptEqualFold - String
|
|
promptContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
Example
{}
Grant
HumanOntologyNode
HumanOntologyNodeWhereInput
Description
HumanOntologyNodeWhereInput is used for filtering HumanOntologyNode objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - HumanOntologyNodeWhereInput
|
|
and - [HumanOntologyNodeWhereInput!]
|
|
or - [HumanOntologyNodeWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
nodeID - String
|
node_id field predicates |
nodeIDNEQ - String
|
|
nodeIDIn - [String!]
|
|
nodeIDNotIn - [String!]
|
|
nodeIDGT - String
|
|
nodeIDGTE - String
|
|
nodeIDLT - String
|
|
nodeIDLTE - String
|
|
nodeIDContains - String
|
|
nodeIDHasPrefix - String
|
|
nodeIDHasSuffix - String
|
|
nodeIDEqualFold - String
|
|
nodeIDContainsFold - String
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
definition - String
|
definition field predicates |
definitionNEQ - String
|
|
definitionIn - [String!]
|
|
definitionNotIn - [String!]
|
|
definitionGT - String
|
|
definitionGTE - String
|
|
definitionLT - String
|
|
definitionLTE - String
|
|
definitionContains - String
|
|
definitionHasPrefix - String
|
|
definitionHasSuffix - String
|
|
definitionEqualFold - String
|
|
definitionContainsFold - String
|
|
type - String
|
type field predicates |
typeNEQ - String
|
|
typeIn - [String!]
|
|
typeNotIn - [String!]
|
|
typeGT - String
|
|
typeGTE - String
|
|
typeLT - String
|
|
typeLTE - String
|
|
typeContains - String
|
|
typeHasPrefix - String
|
|
typeHasSuffix - String
|
|
typeEqualFold - String
|
|
typeContainsFold - String
|
Example
{}
ID
Description
The ID scalar type represents a unique identifier, 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 "4") or integer (such as 4) input value will be accepted as an ID.
Example
{}
Image
Example
{
"id": 4,
"storageKey": "abc123",
"url": "abc123",
"variantKey": "xyz789",
"metadata": Map,
"video": Video
}
ImageUploadResponse
ImageWhereInput
Description
ImageWhereInput is used for filtering Image objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ImageWhereInput
|
|
and - [ImageWhereInput!]
|
|
or - [ImageWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyIsNil - Boolean
|
|
storageKeyNotNil - Boolean
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlIsNil - Boolean
|
|
urlNotNil - Boolean
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
variantKey - String
|
variant_key field predicates |
variantKeyNEQ - String
|
|
variantKeyIn - [String!]
|
|
variantKeyNotIn - [String!]
|
|
variantKeyGT - String
|
|
variantKeyGTE - String
|
|
variantKeyLT - String
|
|
variantKeyLTE - String
|
|
variantKeyContains - String
|
|
variantKeyHasPrefix - String
|
|
variantKeyHasSuffix - String
|
|
variantKeyIsNil - Boolean
|
|
variantKeyNotNil - Boolean
|
|
variantKeyEqualFold - String
|
|
variantKeyContainsFold - String
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
ImportedVideo
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - ImportedVideoType!
|
The source of the import |
importStatus - ImportedVideoImportStatus!
|
The status of the import |
exportStatus - ImportedVideoExportStatus
|
The status of the export |
bucket - String
|
The bucket of the video. |
storageKey - String
|
The storage key of the video. |
videoID - String
|
|
accountID - String
|
|
userID - ID!
|
|
accountConnectionID - ID!
|
|
title - String
|
The title of the video. |
body - String
|
The body/caption of the video. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
exportedAt - Time
|
The time the video was exported to a post |
sourceCreatedAt - Time
|
The time the video was created on the source platform |
workflowID - String
|
|
workflowRunID - String
|
|
user - User!
|
The user that owns the imported video |
accountConnection - AccountConnection!
|
The account connection that owns the imported video |
exportedVideo - Video
|
Example
{
"id": 4,
"type": "instagram",
"importStatus": "pending",
"exportStatus": "pending",
"bucket": "abc123",
"storageKey": "abc123",
"videoID": "xyz789",
"accountID": "xyz789",
"userID": 4,
"accountConnectionID": "4",
"title": "xyz789",
"body": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"exportedAt": "10:15:30Z",
"sourceCreatedAt": "10:15:30Z",
"workflowID": "abc123",
"workflowRunID": "abc123",
"user": User,
"accountConnection": AccountConnection,
"exportedVideo": Video
}
ImportedVideoConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ImportedVideoEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [ImportedVideoEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
ImportedVideoEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ImportedVideo
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": ImportedVideo,
"cursor": Cursor
}
ImportedVideoExportStatus
Description
ImportedVideoExportStatus is enum for the field export_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
ImportedVideoImportStatus
Description
ImportedVideoImportStatus is enum for the field import_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
ImportedVideoOrder
Description
Ordering options for ImportedVideo connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - ImportedVideoOrderField!
|
The field by which to order ImportedVideos. |
Example
{}
ImportedVideoOrderField
Description
Properties by which ImportedVideo connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
ImportedVideoType
Description
ImportedVideoType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
ImportedVideoWhereInput
Description
ImportedVideoWhereInput is used for filtering ImportedVideo objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ImportedVideoWhereInput
|
|
and - [ImportedVideoWhereInput!]
|
|
or - [ImportedVideoWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
type - ImportedVideoType
|
type field predicates |
typeNEQ - ImportedVideoType
|
|
typeIn - [ImportedVideoType!]
|
|
typeNotIn - [ImportedVideoType!]
|
|
importStatus - ImportedVideoImportStatus
|
import_status field predicates |
importStatusNEQ - ImportedVideoImportStatus
|
|
importStatusIn - [ImportedVideoImportStatus!]
|
|
importStatusNotIn - [ImportedVideoImportStatus!]
|
|
exportStatus - ImportedVideoExportStatus
|
export_status field predicates |
exportStatusNEQ - ImportedVideoExportStatus
|
|
exportStatusIn - [ImportedVideoExportStatus!]
|
|
exportStatusNotIn - [ImportedVideoExportStatus!]
|
|
exportStatusIsNil - Boolean
|
|
exportStatusNotNil - Boolean
|
|
bucket - String
|
bucket field predicates |
bucketNEQ - String
|
|
bucketIn - [String!]
|
|
bucketNotIn - [String!]
|
|
bucketGT - String
|
|
bucketGTE - String
|
|
bucketLT - String
|
|
bucketLTE - String
|
|
bucketContains - String
|
|
bucketHasPrefix - String
|
|
bucketHasSuffix - String
|
|
bucketIsNil - Boolean
|
|
bucketNotNil - Boolean
|
|
bucketEqualFold - String
|
|
bucketContainsFold - String
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyIsNil - Boolean
|
|
storageKeyNotNil - Boolean
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
videoID - String
|
video_id field predicates |
videoIDNEQ - String
|
|
videoIDIn - [String!]
|
|
videoIDNotIn - [String!]
|
|
videoIDGT - String
|
|
videoIDGTE - String
|
|
videoIDLT - String
|
|
videoIDLTE - String
|
|
videoIDContains - String
|
|
videoIDHasPrefix - String
|
|
videoIDHasSuffix - String
|
|
videoIDIsNil - Boolean
|
|
videoIDNotNil - Boolean
|
|
videoIDEqualFold - String
|
|
videoIDContainsFold - String
|
|
accountID - String
|
account_id field predicates |
accountIDNEQ - String
|
|
accountIDIn - [String!]
|
|
accountIDNotIn - [String!]
|
|
accountIDGT - String
|
|
accountIDGTE - String
|
|
accountIDLT - String
|
|
accountIDLTE - String
|
|
accountIDContains - String
|
|
accountIDHasPrefix - String
|
|
accountIDHasSuffix - String
|
|
accountIDIsNil - Boolean
|
|
accountIDNotNil - Boolean
|
|
accountIDEqualFold - String
|
|
accountIDContainsFold - String
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
accountConnectionID - ID
|
account_connection_id field predicates |
accountConnectionIDNEQ - ID
|
|
accountConnectionIDIn - [ID!]
|
|
accountConnectionIDNotIn - [ID!]
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleIsNil - Boolean
|
|
titleNotNil - Boolean
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
body - String
|
body field predicates |
bodyNEQ - String
|
|
bodyIn - [String!]
|
|
bodyNotIn - [String!]
|
|
bodyGT - String
|
|
bodyGTE - String
|
|
bodyLT - String
|
|
bodyLTE - String
|
|
bodyContains - String
|
|
bodyHasPrefix - String
|
|
bodyHasSuffix - String
|
|
bodyIsNil - Boolean
|
|
bodyNotNil - Boolean
|
|
bodyEqualFold - String
|
|
bodyContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
exportedAt - Time
|
exported_at field predicates |
exportedAtNEQ - Time
|
|
exportedAtIn - [Time!]
|
|
exportedAtNotIn - [Time!]
|
|
exportedAtGT - Time
|
|
exportedAtGTE - Time
|
|
exportedAtLT - Time
|
|
exportedAtLTE - Time
|
|
exportedAtIsNil - Boolean
|
|
exportedAtNotNil - Boolean
|
|
sourceCreatedAt - Time
|
source_created_at field predicates |
sourceCreatedAtNEQ - Time
|
|
sourceCreatedAtIn - [Time!]
|
|
sourceCreatedAtNotIn - [Time!]
|
|
sourceCreatedAtGT - Time
|
|
sourceCreatedAtGTE - Time
|
|
sourceCreatedAtLT - Time
|
|
sourceCreatedAtLTE - Time
|
|
sourceCreatedAtIsNil - Boolean
|
|
sourceCreatedAtNotNil - Boolean
|
|
workflowID - String
|
workflow_id field predicates |
workflowIDNEQ - String
|
|
workflowIDIn - [String!]
|
|
workflowIDNotIn - [String!]
|
|
workflowIDGT - String
|
|
workflowIDGTE - String
|
|
workflowIDLT - String
|
|
workflowIDLTE - String
|
|
workflowIDContains - String
|
|
workflowIDHasPrefix - String
|
|
workflowIDHasSuffix - String
|
|
workflowIDIsNil - Boolean
|
|
workflowIDNotNil - Boolean
|
|
workflowIDEqualFold - String
|
|
workflowIDContainsFold - String
|
|
workflowRunID - String
|
workflow_run_id field predicates |
workflowRunIDNEQ - String
|
|
workflowRunIDIn - [String!]
|
|
workflowRunIDNotIn - [String!]
|
|
workflowRunIDGT - String
|
|
workflowRunIDGTE - String
|
|
workflowRunIDLT - String
|
|
workflowRunIDLTE - String
|
|
workflowRunIDContains - String
|
|
workflowRunIDHasPrefix - String
|
|
workflowRunIDHasSuffix - String
|
|
workflowRunIDIsNil - Boolean
|
|
workflowRunIDNotNil - Boolean
|
|
workflowRunIDEqualFold - String
|
|
workflowRunIDContainsFold - String
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasAccountConnection - Boolean
|
account_connection edge predicates |
hasAccountConnectionWith - [AccountConnectionWhereInput!]
|
|
hasExportedVideo - Boolean
|
exported_video edge predicates |
hasExportedVideoWith - [VideoWhereInput!]
|
Example
{}
InsightRequest
InsightRequestWhereInput
Description
InsightRequestWhereInput is used for filtering InsightRequest objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - InsightRequestWhereInput
|
|
and - [InsightRequestWhereInput!]
|
|
or - [InsightRequestWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
insightType - String
|
insight_type field predicates |
insightTypeNEQ - String
|
|
insightTypeIn - [String!]
|
|
insightTypeNotIn - [String!]
|
|
insightTypeGT - String
|
|
insightTypeGTE - String
|
|
insightTypeLT - String
|
|
insightTypeLTE - String
|
|
insightTypeContains - String
|
|
insightTypeHasPrefix - String
|
|
insightTypeHasSuffix - String
|
|
insightTypeIsNil - Boolean
|
|
insightTypeNotNil - Boolean
|
|
insightTypeEqualFold - String
|
|
insightTypeContainsFold - String
|
|
insightValue - String
|
insight_value field predicates |
insightValueNEQ - String
|
|
insightValueIn - [String!]
|
|
insightValueNotIn - [String!]
|
|
insightValueGT - String
|
|
insightValueGTE - String
|
|
insightValueLT - String
|
|
insightValueLTE - String
|
|
insightValueContains - String
|
|
insightValueHasPrefix - String
|
|
insightValueHasSuffix - String
|
|
insightValueIsNil - Boolean
|
|
insightValueNotNil - Boolean
|
|
insightValueEqualFold - String
|
|
insightValueContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
Example
{}
InstagramScrapeLog
Example
{
"id": 4,
"request": Map,
"response": Map,
"accountConnectionID": "4",
"workflowID": "abc123",
"workflowRunID": "abc123",
"createdAt": "10:15:30Z",
"accountConnection": AccountConnection
}
InstagramScrapeLogWhereInput
Description
InstagramScrapeLogWhereInput is used for filtering InstagramScrapeLog objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - InstagramScrapeLogWhereInput
|
|
and - [InstagramScrapeLogWhereInput!]
|
|
or - [InstagramScrapeLogWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
accountConnectionID - ID
|
account_connection_id field predicates |
accountConnectionIDNEQ - ID
|
|
accountConnectionIDIn - [ID!]
|
|
accountConnectionIDNotIn - [ID!]
|
|
workflowID - String
|
workflow_id field predicates |
workflowIDNEQ - String
|
|
workflowIDIn - [String!]
|
|
workflowIDNotIn - [String!]
|
|
workflowIDGT - String
|
|
workflowIDGTE - String
|
|
workflowIDLT - String
|
|
workflowIDLTE - String
|
|
workflowIDContains - String
|
|
workflowIDHasPrefix - String
|
|
workflowIDHasSuffix - String
|
|
workflowIDIsNil - Boolean
|
|
workflowIDNotNil - Boolean
|
|
workflowIDEqualFold - String
|
|
workflowIDContainsFold - String
|
|
workflowRunID - String
|
workflow_run_id field predicates |
workflowRunIDNEQ - String
|
|
workflowRunIDIn - [String!]
|
|
workflowRunIDNotIn - [String!]
|
|
workflowRunIDGT - String
|
|
workflowRunIDGTE - String
|
|
workflowRunIDLT - String
|
|
workflowRunIDLTE - String
|
|
workflowRunIDContains - String
|
|
workflowRunIDHasPrefix - String
|
|
workflowRunIDHasSuffix - String
|
|
workflowRunIDIsNil - Boolean
|
|
workflowRunIDNotNil - Boolean
|
|
workflowRunIDEqualFold - String
|
|
workflowRunIDContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasAccountConnection - Boolean
|
account_connection edge predicates |
hasAccountConnectionWith - [AccountConnectionWhereInput!]
|
Example
{}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
{}
JobHistory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
jobName - String!
|
Job Name |
startedAt - Time!
|
The time the job started |
endedAt - Time
|
The time the job ended |
status - JobHistoryStatus!
|
Status of the job |
entityType - String
|
The type of entity the job is processing |
entityID - Int
|
The ID of the entity the job is processing |
error - String
|
The error message if the job failed |
Example
{
"id": 4,
"jobName": "xyz789",
"startedAt": "10:15:30Z",
"endedAt": "10:15:30Z",
"status": "success",
"entityType": "abc123",
"entityID": 123,
"error": "abc123"
}
JobHistoryConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [JobHistoryEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [JobHistoryEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
JobHistoryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - JobHistory
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": JobHistory,
"cursor": Cursor
}
JobHistoryStatus
Description
JobHistoryStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
JobHistoryWhereInput
Description
JobHistoryWhereInput is used for filtering JobHistory objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - JobHistoryWhereInput
|
|
and - [JobHistoryWhereInput!]
|
|
or - [JobHistoryWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
jobName - String
|
job_name field predicates |
jobNameNEQ - String
|
|
jobNameIn - [String!]
|
|
jobNameNotIn - [String!]
|
|
jobNameGT - String
|
|
jobNameGTE - String
|
|
jobNameLT - String
|
|
jobNameLTE - String
|
|
jobNameContains - String
|
|
jobNameHasPrefix - String
|
|
jobNameHasSuffix - String
|
|
jobNameEqualFold - String
|
|
jobNameContainsFold - String
|
|
startedAt - Time
|
started_at field predicates |
startedAtNEQ - Time
|
|
startedAtIn - [Time!]
|
|
startedAtNotIn - [Time!]
|
|
startedAtGT - Time
|
|
startedAtGTE - Time
|
|
startedAtLT - Time
|
|
startedAtLTE - Time
|
|
endedAt - Time
|
ended_at field predicates |
endedAtNEQ - Time
|
|
endedAtIn - [Time!]
|
|
endedAtNotIn - [Time!]
|
|
endedAtGT - Time
|
|
endedAtGTE - Time
|
|
endedAtLT - Time
|
|
endedAtLTE - Time
|
|
endedAtIsNil - Boolean
|
|
endedAtNotNil - Boolean
|
|
status - JobHistoryStatus
|
status field predicates |
statusNEQ - JobHistoryStatus
|
|
statusIn - [JobHistoryStatus!]
|
|
statusNotIn - [JobHistoryStatus!]
|
|
entityType - String
|
entity_type field predicates |
entityTypeNEQ - String
|
|
entityTypeIn - [String!]
|
|
entityTypeNotIn - [String!]
|
|
entityTypeGT - String
|
|
entityTypeGTE - String
|
|
entityTypeLT - String
|
|
entityTypeLTE - String
|
|
entityTypeContains - String
|
|
entityTypeHasPrefix - String
|
|
entityTypeHasSuffix - String
|
|
entityTypeIsNil - Boolean
|
|
entityTypeNotNil - Boolean
|
|
entityTypeEqualFold - String
|
|
entityTypeContainsFold - String
|
|
entityID - Int
|
entity_id field predicates |
entityIDNEQ - Int
|
|
entityIDIn - [Int!]
|
|
entityIDNotIn - [Int!]
|
|
entityIDGT - Int
|
|
entityIDGTE - Int
|
|
entityIDLT - Int
|
|
entityIDLTE - Int
|
|
entityIDIsNil - Boolean
|
|
entityIDNotNil - Boolean
|
|
error - String
|
error field predicates |
errorNEQ - String
|
|
errorIn - [String!]
|
|
errorNotIn - [String!]
|
|
errorGT - String
|
|
errorGTE - String
|
|
errorLT - String
|
|
errorLTE - String
|
|
errorContains - String
|
|
errorHasPrefix - String
|
|
errorHasSuffix - String
|
|
errorIsNil - Boolean
|
|
errorNotNil - Boolean
|
|
errorEqualFold - String
|
|
errorContainsFold - String
|
Example
{}
Journal
LearningObjective
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
surveyQuestion - String
|
|
tenant - Tenant
|
The tenant that the topic belongs to. |
posts - [Post!]
|
The posts that have this learning objective. |
educationCredits - [EducationCredit!]
|
The credits that have this learning objective. |
certificateSurveyQuestions - [CertificateSurveyQuestion!]
|
The survey questions that have this learning objective. |
videos - [Video!]
|
|
postlearningobjectives - [PostLearningObjective!]
|
Example
{
"id": "4",
"name": "xyz789",
"surveyQuestion": "abc123",
"tenant": Tenant,
"posts": [Post],
"educationCredits": [EducationCredit],
"certificateSurveyQuestions": [
CertificateSurveyQuestion
],
"videos": [Video],
"postlearningobjectives": [PostLearningObjective]
}
LearningObjectiveConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [LearningObjectiveEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [LearningObjectiveEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
LearningObjectiveEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - LearningObjective
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": LearningObjective,
"cursor": Cursor
}
LearningObjectiveWhereInput
Description
LearningObjectiveWhereInput is used for filtering LearningObjective objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - LearningObjectiveWhereInput
|
|
and - [LearningObjectiveWhereInput!]
|
|
or - [LearningObjectiveWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
surveyQuestion - String
|
survey_question field predicates |
surveyQuestionNEQ - String
|
|
surveyQuestionIn - [String!]
|
|
surveyQuestionNotIn - [String!]
|
|
surveyQuestionGT - String
|
|
surveyQuestionGTE - String
|
|
surveyQuestionLT - String
|
|
surveyQuestionLTE - String
|
|
surveyQuestionContains - String
|
|
surveyQuestionHasPrefix - String
|
|
surveyQuestionHasSuffix - String
|
|
surveyQuestionIsNil - Boolean
|
|
surveyQuestionNotNil - Boolean
|
|
surveyQuestionEqualFold - String
|
|
surveyQuestionContainsFold - String
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasPosts - Boolean
|
posts edge predicates |
hasPostsWith - [PostWhereInput!]
|
|
hasEducationCredits - Boolean
|
education_credits edge predicates |
hasEducationCreditsWith - [EducationCreditWhereInput!]
|
|
hasCertificateSurveyQuestions - Boolean
|
certificate_survey_questions edge predicates |
hasCertificateSurveyQuestionsWith - [CertificateSurveyQuestionWhereInput!]
|
|
hasVideos - Boolean
|
videos edge predicates |
hasVideosWith - [VideoWhereInput!]
|
|
hasPostlearningobjectives - Boolean
|
postlearningobjectives edge predicates |
hasPostlearningobjectivesWith - [PostLearningObjectiveWhereInput!]
|
Example
{}
LicenseHistory
Example
{
"id": "4",
"institution": "abc123",
"title": "xyz789",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"user": User
}
LicenseHistoryConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [LicenseHistoryEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [LicenseHistoryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
LicenseHistoryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - LicenseHistory
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": LicenseHistory,
"cursor": Cursor
}
LicenseHistoryWhereInput
Description
LicenseHistoryWhereInput is used for filtering LicenseHistory objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - LicenseHistoryWhereInput
|
|
and - [LicenseHistoryWhereInput!]
|
|
or - [LicenseHistoryWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
institution - String
|
institution field predicates |
institutionNEQ - String
|
|
institutionIn - [String!]
|
|
institutionNotIn - [String!]
|
|
institutionGT - String
|
|
institutionGTE - String
|
|
institutionLT - String
|
|
institutionLTE - String
|
|
institutionContains - String
|
|
institutionHasPrefix - String
|
|
institutionHasSuffix - String
|
|
institutionIsNil - Boolean
|
|
institutionNotNil - Boolean
|
|
institutionEqualFold - String
|
|
institutionContainsFold - String
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
startDate - Time
|
start_date field predicates |
startDateNEQ - Time
|
|
startDateIn - [Time!]
|
|
startDateNotIn - [Time!]
|
|
startDateGT - Time
|
|
startDateGTE - Time
|
|
startDateLT - Time
|
|
startDateLTE - Time
|
|
startDateIsNil - Boolean
|
|
startDateNotNil - Boolean
|
|
endDate - Time
|
end_date field predicates |
endDateNEQ - Time
|
|
endDateIn - [Time!]
|
|
endDateNotIn - [Time!]
|
|
endDateGT - Time
|
|
endDateGTE - Time
|
|
endDateLT - Time
|
|
endDateLTE - Time
|
|
endDateIsNil - Boolean
|
|
endDateNotNil - Boolean
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
Like
Example
{
"id": "4",
"likedAt": "10:15:30Z",
"userID": "4",
"postID": 4,
"user": User,
"post": Post
}
LikeCommentInput
Fields
| Input Field | Description |
|---|---|
commentId - ID!
|
Example
{}
LikeConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [LikeEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [LikeEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
LikeEdge
LikeOrder
Description
Ordering options for Like connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - LikeOrderField!
|
The field by which to order Likes. |
Example
{}
LikeOrderField
Description
Properties by which Like connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
LikePostInput
Fields
| Input Field | Description |
|---|---|
postId - ID!
|
Example
{}
LikeWhereInput
Description
LikeWhereInput is used for filtering Like objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - LikeWhereInput
|
|
and - [LikeWhereInput!]
|
|
or - [LikeWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
likedAt - Time
|
liked_at field predicates |
likedAtNEQ - Time
|
|
likedAtIn - [Time!]
|
|
likedAtNotIn - [Time!]
|
|
likedAtGT - Time
|
|
likedAtGTE - Time
|
|
likedAtLT - Time
|
|
likedAtLTE - Time
|
|
hasPostWith - [PostWhereInput!]
|
Example
{}
LoginResponse
Map
Description
The builtin Map type
Example
{}
MarkNotificationsAsRead
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
Example
{}
MediaItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
publicID - String!
|
[Deprecated] The public ID in Cloudinary of the media item. |
width - Int!
|
The width of the media item in pixels. |
height - Int!
|
The height of the media item in pixels. |
bytes - Int!
|
The size of the media item in bytes. |
format - String!
|
The format of the media item. ie jpg, png, gif, etc. |
mediaType - String!
|
The type of media item. Will be image or video |
url - String!
|
The URL of the media item. |
originalFilename - String!
|
The original filename of the media item. |
ordinal - Int!
|
|
duration - Int
|
The duration of the media item in seconds. |
post - Post
|
The post that the media item belongs to. |
Example
{
"id": 4,
"publicID": "abc123",
"width": 123,
"height": 987,
"bytes": 987,
"format": "xyz789",
"mediaType": "xyz789",
"url": "xyz789",
"originalFilename": "abc123",
"ordinal": 987,
"duration": 123,
"post": Post
}
MediaItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [MediaItemEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [MediaItemEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
MediaItemEdge
MediaItemWhereInput
Description
MediaItemWhereInput is used for filtering MediaItem objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - MediaItemWhereInput
|
|
and - [MediaItemWhereInput!]
|
|
or - [MediaItemWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
publicID - String
|
public_id field predicates |
publicIDNEQ - String
|
|
publicIDIn - [String!]
|
|
publicIDNotIn - [String!]
|
|
publicIDGT - String
|
|
publicIDGTE - String
|
|
publicIDLT - String
|
|
publicIDLTE - String
|
|
publicIDContains - String
|
|
publicIDHasPrefix - String
|
|
publicIDHasSuffix - String
|
|
publicIDEqualFold - String
|
|
publicIDContainsFold - String
|
|
width - Int
|
width field predicates |
widthNEQ - Int
|
|
widthIn - [Int!]
|
|
widthNotIn - [Int!]
|
|
widthGT - Int
|
|
widthGTE - Int
|
|
widthLT - Int
|
|
widthLTE - Int
|
|
height - Int
|
height field predicates |
heightNEQ - Int
|
|
heightIn - [Int!]
|
|
heightNotIn - [Int!]
|
|
heightGT - Int
|
|
heightGTE - Int
|
|
heightLT - Int
|
|
heightLTE - Int
|
|
bytes - Int
|
bytes field predicates |
bytesNEQ - Int
|
|
bytesIn - [Int!]
|
|
bytesNotIn - [Int!]
|
|
bytesGT - Int
|
|
bytesGTE - Int
|
|
bytesLT - Int
|
|
bytesLTE - Int
|
|
format - String
|
format field predicates |
formatNEQ - String
|
|
formatIn - [String!]
|
|
formatNotIn - [String!]
|
|
formatGT - String
|
|
formatGTE - String
|
|
formatLT - String
|
|
formatLTE - String
|
|
formatContains - String
|
|
formatHasPrefix - String
|
|
formatHasSuffix - String
|
|
formatEqualFold - String
|
|
formatContainsFold - String
|
|
mediaType - String
|
media_type field predicates |
mediaTypeNEQ - String
|
|
mediaTypeIn - [String!]
|
|
mediaTypeNotIn - [String!]
|
|
mediaTypeGT - String
|
|
mediaTypeGTE - String
|
|
mediaTypeLT - String
|
|
mediaTypeLTE - String
|
|
mediaTypeContains - String
|
|
mediaTypeHasPrefix - String
|
|
mediaTypeHasSuffix - String
|
|
mediaTypeEqualFold - String
|
|
mediaTypeContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
originalFilename - String
|
original_filename field predicates |
originalFilenameNEQ - String
|
|
originalFilenameIn - [String!]
|
|
originalFilenameNotIn - [String!]
|
|
originalFilenameGT - String
|
|
originalFilenameGTE - String
|
|
originalFilenameLT - String
|
|
originalFilenameLTE - String
|
|
originalFilenameContains - String
|
|
originalFilenameHasPrefix - String
|
|
originalFilenameHasSuffix - String
|
|
originalFilenameEqualFold - String
|
|
originalFilenameContainsFold - String
|
|
ordinal - Int
|
ordinal field predicates |
ordinalNEQ - Int
|
|
ordinalIn - [Int!]
|
|
ordinalNotIn - [Int!]
|
|
ordinalGT - Int
|
|
ordinalGTE - Int
|
|
ordinalLT - Int
|
|
ordinalLTE - Int
|
|
duration - Int
|
duration field predicates |
durationNEQ - Int
|
|
durationIn - [Int!]
|
|
durationNotIn - [Int!]
|
|
durationGT - Int
|
|
durationGTE - Int
|
|
durationLT - Int
|
|
durationLTE - Int
|
|
durationIsNil - Boolean
|
|
durationNotNil - Boolean
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
Example
{}
MedicalDictionaryDefinition
MedicalDictionaryMatch
Fields
| Field Name | Description |
|---|---|
word - String!
|
Example
{"word": "abc123"}
MedicalDictionarySearchResult
MedicalHealthTerm
MedicalHealthTermWhereInput
Description
MedicalHealthTermWhereInput is used for filtering MedicalHealthTerm objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - MedicalHealthTermWhereInput
|
|
and - [MedicalHealthTermWhereInput!]
|
|
or - [MedicalHealthTermWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
term - String
|
term field predicates |
termNEQ - String
|
|
termIn - [String!]
|
|
termNotIn - [String!]
|
|
termGT - String
|
|
termGTE - String
|
|
termLT - String
|
|
termLTE - String
|
|
termContains - String
|
|
termHasPrefix - String
|
|
termHasSuffix - String
|
|
termEqualFold - String
|
|
termContainsFold - String
|
|
definition - String
|
definition field predicates |
definitionNEQ - String
|
|
definitionIn - [String!]
|
|
definitionNotIn - [String!]
|
|
definitionGT - String
|
|
definitionGTE - String
|
|
definitionLT - String
|
|
definitionLTE - String
|
|
definitionContains - String
|
|
definitionHasPrefix - String
|
|
definitionHasSuffix - String
|
|
definitionEqualFold - String
|
|
definitionContainsFold - String
|
Example
{}
MedicalNreResult
MedicalSubjectHeading
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
descriptorUI - String!
|
|
name - String!
|
|
entryTerms - [String!]!
|
|
treeNumbers - [String!]!
|
|
scopeNote - String
|
Example
{
"id": 4,
"descriptorUI": "abc123",
"name": "abc123",
"entryTerms": ["xyz789"],
"treeNumbers": ["xyz789"],
"scopeNote": "xyz789"
}
MedicalSubjectHeadingWhereInput
Description
MedicalSubjectHeadingWhereInput is used for filtering MedicalSubjectHeading objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - MedicalSubjectHeadingWhereInput
|
|
and - [MedicalSubjectHeadingWhereInput!]
|
|
or - [MedicalSubjectHeadingWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
descriptorUI - String
|
descriptor_ui field predicates |
descriptorUINEQ - String
|
|
descriptorUIIn - [String!]
|
|
descriptorUINotIn - [String!]
|
|
descriptorUIGT - String
|
|
descriptorUIGTE - String
|
|
descriptorUILT - String
|
|
descriptorUILTE - String
|
|
descriptorUIContains - String
|
|
descriptorUIHasPrefix - String
|
|
descriptorUIHasSuffix - String
|
|
descriptorUIEqualFold - String
|
|
descriptorUIContainsFold - String
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
scopeNote - String
|
scope_note field predicates |
scopeNoteNEQ - String
|
|
scopeNoteIn - [String!]
|
|
scopeNoteNotIn - [String!]
|
|
scopeNoteGT - String
|
|
scopeNoteGTE - String
|
|
scopeNoteLT - String
|
|
scopeNoteLTE - String
|
|
scopeNoteContains - String
|
|
scopeNoteHasPrefix - String
|
|
scopeNoteHasSuffix - String
|
|
scopeNoteIsNil - Boolean
|
|
scopeNoteNotNil - Boolean
|
|
scopeNoteEqualFold - String
|
|
scopeNoteContainsFold - String
|
Example
{}
MeshHeading
NamedEntity
NamedEntityStat
Node
Description
An object with an ID. Follows the Relay Global Object Identification Specification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the object. |
Possible Types
| Node Types |
|---|
Example
{"id": "4"}
Notification
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
notificationType - NotificationNotificationType!
|
The type of notification. |
resourceType - String!
|
The type of resource that the notification is for. |
resourceID - String!
|
The ID of the resource that the notification is for. |
message - String!
|
(DEPRECATED - Use body instead) The message of the notification. |
body - String!
|
The body of the notification. This is the fully rendered message minus the user's name ie. liked your post "Test Post" or reflected on your post "Test Post" |
readAt - Time
|
The time that the notification was read. |
createdAt - Time!
|
|
pushSentAt - Time
|
|
user - User
|
The user that the notification is for. |
from - User
|
The user that sent the notification. |
Example
{
"id": 4,
"notificationType": "like",
"resourceType": "abc123",
"resourceID": "xyz789",
"message": "xyz789",
"body": "abc123",
"readAt": "10:15:30Z",
"createdAt": "10:15:30Z",
"pushSentAt": "10:15:30Z",
"user": User,
"from": User
}
NotificationConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
followUserMessage - String!
|
The message template for follow notifications. |
likedPostMessage - String!
|
The message template for like notifications. |
reflectedPostMessage - String!
|
The message template for comment notifications. |
reflectionApproved - String!
|
The message template for reflection approved notifications. |
createdAt - Time!
|
|
updatedAt - Time!
|
Example
{
"id": "4",
"followUserMessage": "xyz789",
"likedPostMessage": "abc123",
"reflectedPostMessage": "abc123",
"reflectionApproved": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
NotificationConfigConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [NotificationConfigEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [NotificationConfigEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
NotificationConfigEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - NotificationConfig
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": NotificationConfig,
"cursor": Cursor
}
NotificationConfigOrder
Description
Ordering options for NotificationConfig connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - NotificationConfigOrderField!
|
The field by which to order NotificationConfigs. |
Example
{}
NotificationConfigOrderField
Description
Properties by which NotificationConfig connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
NotificationConfigWhereInput
Description
NotificationConfigWhereInput is used for filtering NotificationConfig objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - NotificationConfigWhereInput
|
|
and - [NotificationConfigWhereInput!]
|
|
or - [NotificationConfigWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
followUserMessage - String
|
follow_user_message field predicates |
followUserMessageNEQ - String
|
|
followUserMessageIn - [String!]
|
|
followUserMessageNotIn - [String!]
|
|
followUserMessageGT - String
|
|
followUserMessageGTE - String
|
|
followUserMessageLT - String
|
|
followUserMessageLTE - String
|
|
followUserMessageContains - String
|
|
followUserMessageHasPrefix - String
|
|
followUserMessageHasSuffix - String
|
|
followUserMessageEqualFold - String
|
|
followUserMessageContainsFold - String
|
|
likedPostMessage - String
|
liked_post_message field predicates |
likedPostMessageNEQ - String
|
|
likedPostMessageIn - [String!]
|
|
likedPostMessageNotIn - [String!]
|
|
likedPostMessageGT - String
|
|
likedPostMessageGTE - String
|
|
likedPostMessageLT - String
|
|
likedPostMessageLTE - String
|
|
likedPostMessageContains - String
|
|
likedPostMessageHasPrefix - String
|
|
likedPostMessageHasSuffix - String
|
|
likedPostMessageEqualFold - String
|
|
likedPostMessageContainsFold - String
|
|
reflectedPostMessage - String
|
reflected_post_message field predicates |
reflectedPostMessageNEQ - String
|
|
reflectedPostMessageIn - [String!]
|
|
reflectedPostMessageNotIn - [String!]
|
|
reflectedPostMessageGT - String
|
|
reflectedPostMessageGTE - String
|
|
reflectedPostMessageLT - String
|
|
reflectedPostMessageLTE - String
|
|
reflectedPostMessageContains - String
|
|
reflectedPostMessageHasPrefix - String
|
|
reflectedPostMessageHasSuffix - String
|
|
reflectedPostMessageEqualFold - String
|
|
reflectedPostMessageContainsFold - String
|
|
reflectionApproved - String
|
reflection_approved field predicates |
reflectionApprovedNEQ - String
|
|
reflectionApprovedIn - [String!]
|
|
reflectionApprovedNotIn - [String!]
|
|
reflectionApprovedGT - String
|
|
reflectionApprovedGTE - String
|
|
reflectionApprovedLT - String
|
|
reflectionApprovedLTE - String
|
|
reflectionApprovedContains - String
|
|
reflectionApprovedHasPrefix - String
|
|
reflectionApprovedHasSuffix - String
|
|
reflectionApprovedEqualFold - String
|
|
reflectionApprovedContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
NotificationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [NotificationEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [NotificationEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
NotificationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - Notification
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": Notification,
"cursor": Cursor
}
NotificationNotificationType
Description
NotificationNotificationType is enum for the field notification_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
NotificationOrder
Description
Ordering options for Notification connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - NotificationOrderField!
|
The field by which to order Notifications. |
Example
{}
NotificationOrderField
Description
Properties by which Notification connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
NotificationWhereInput
Description
NotificationWhereInput is used for filtering Notification objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - NotificationWhereInput
|
|
and - [NotificationWhereInput!]
|
|
or - [NotificationWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
notificationType - NotificationNotificationType
|
notification_type field predicates |
notificationTypeNEQ - NotificationNotificationType
|
|
notificationTypeIn - [NotificationNotificationType!]
|
|
notificationTypeNotIn - [NotificationNotificationType!]
|
|
resourceType - String
|
resource_type field predicates |
resourceTypeNEQ - String
|
|
resourceTypeIn - [String!]
|
|
resourceTypeNotIn - [String!]
|
|
resourceTypeGT - String
|
|
resourceTypeGTE - String
|
|
resourceTypeLT - String
|
|
resourceTypeLTE - String
|
|
resourceTypeContains - String
|
|
resourceTypeHasPrefix - String
|
|
resourceTypeHasSuffix - String
|
|
resourceTypeEqualFold - String
|
|
resourceTypeContainsFold - String
|
|
resourceID - String
|
resource_id field predicates |
resourceIDNEQ - String
|
|
resourceIDIn - [String!]
|
|
resourceIDNotIn - [String!]
|
|
resourceIDGT - String
|
|
resourceIDGTE - String
|
|
resourceIDLT - String
|
|
resourceIDLTE - String
|
|
resourceIDContains - String
|
|
resourceIDHasPrefix - String
|
|
resourceIDHasSuffix - String
|
|
resourceIDEqualFold - String
|
|
resourceIDContainsFold - String
|
|
message - String
|
message field predicates |
messageNEQ - String
|
|
messageIn - [String!]
|
|
messageNotIn - [String!]
|
|
messageGT - String
|
|
messageGTE - String
|
|
messageLT - String
|
|
messageLTE - String
|
|
messageContains - String
|
|
messageHasPrefix - String
|
|
messageHasSuffix - String
|
|
messageEqualFold - String
|
|
messageContainsFold - String
|
|
body - String
|
body field predicates |
bodyNEQ - String
|
|
bodyIn - [String!]
|
|
bodyNotIn - [String!]
|
|
bodyGT - String
|
|
bodyGTE - String
|
|
bodyLT - String
|
|
bodyLTE - String
|
|
bodyContains - String
|
|
bodyHasPrefix - String
|
|
bodyHasSuffix - String
|
|
bodyEqualFold - String
|
|
bodyContainsFold - String
|
|
readAt - Time
|
read_at field predicates |
readAtNEQ - Time
|
|
readAtIn - [Time!]
|
|
readAtNotIn - [Time!]
|
|
readAtGT - Time
|
|
readAtGTE - Time
|
|
readAtLT - Time
|
|
readAtLTE - Time
|
|
readAtIsNil - Boolean
|
|
readAtNotNil - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
pushSentAt - Time
|
push_sent_at field predicates |
pushSentAtNEQ - Time
|
|
pushSentAtIn - [Time!]
|
|
pushSentAtNotIn - [Time!]
|
|
pushSentAtGT - Time
|
|
pushSentAtGTE - Time
|
|
pushSentAtLT - Time
|
|
pushSentAtLTE - Time
|
|
pushSentAtIsNil - Boolean
|
|
pushSentAtNotNil - Boolean
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasFrom - Boolean
|
from edge predicates |
hasFromWith - [UserWhereInput!]
|
Example
{}
NpiTaxonomy
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
code - String!
|
|
displayName - String!
|
|
grouping - String!
|
|
classification - String!
|
|
specialization - String
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
audiences - [Audience!]
|
|
topics - [Topic!]
|
The topics that are tagged with the NPI taxonomy. |
topicNpiTaxonomy - [TopicNpiTaxonomy!]
|
Example
{
"id": 4,
"code": "xyz789",
"displayName": "xyz789",
"grouping": "abc123",
"classification": "xyz789",
"specialization": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"audiences": [Audience],
"topics": [Topic],
"topicNpiTaxonomy": [TopicNpiTaxonomy]
}
NpiTaxonomyConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [NpiTaxonomyEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [NpiTaxonomyEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
NpiTaxonomyEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - NpiTaxonomy
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": NpiTaxonomy,
"cursor": Cursor
}
NpiTaxonomyOrder
Description
Ordering options for NpiTaxonomy connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - NpiTaxonomyOrderField!
|
The field by which to order NpiTaxonomies. |
Example
{}
NpiTaxonomyOrderField
Description
Properties by which NpiTaxonomy connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
NpiTaxonomyWhereInput
Description
NpiTaxonomyWhereInput is used for filtering NpiTaxonomy objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - NpiTaxonomyWhereInput
|
|
and - [NpiTaxonomyWhereInput!]
|
|
or - [NpiTaxonomyWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
code - String
|
code field predicates |
codeNEQ - String
|
|
codeIn - [String!]
|
|
codeNotIn - [String!]
|
|
codeGT - String
|
|
codeGTE - String
|
|
codeLT - String
|
|
codeLTE - String
|
|
codeContains - String
|
|
codeHasPrefix - String
|
|
codeHasSuffix - String
|
|
codeEqualFold - String
|
|
codeContainsFold - String
|
|
displayName - String
|
display_name field predicates |
displayNameNEQ - String
|
|
displayNameIn - [String!]
|
|
displayNameNotIn - [String!]
|
|
displayNameGT - String
|
|
displayNameGTE - String
|
|
displayNameLT - String
|
|
displayNameLTE - String
|
|
displayNameContains - String
|
|
displayNameHasPrefix - String
|
|
displayNameHasSuffix - String
|
|
displayNameEqualFold - String
|
|
displayNameContainsFold - String
|
|
grouping - String
|
grouping field predicates |
groupingNEQ - String
|
|
groupingIn - [String!]
|
|
groupingNotIn - [String!]
|
|
groupingGT - String
|
|
groupingGTE - String
|
|
groupingLT - String
|
|
groupingLTE - String
|
|
groupingContains - String
|
|
groupingHasPrefix - String
|
|
groupingHasSuffix - String
|
|
groupingEqualFold - String
|
|
groupingContainsFold - String
|
|
classification - String
|
classification field predicates |
classificationNEQ - String
|
|
classificationIn - [String!]
|
|
classificationNotIn - [String!]
|
|
classificationGT - String
|
|
classificationGTE - String
|
|
classificationLT - String
|
|
classificationLTE - String
|
|
classificationContains - String
|
|
classificationHasPrefix - String
|
|
classificationHasSuffix - String
|
|
classificationEqualFold - String
|
|
classificationContainsFold - String
|
|
specialization - String
|
specialization field predicates |
specializationNEQ - String
|
|
specializationIn - [String!]
|
|
specializationNotIn - [String!]
|
|
specializationGT - String
|
|
specializationGTE - String
|
|
specializationLT - String
|
|
specializationLTE - String
|
|
specializationContains - String
|
|
specializationHasPrefix - String
|
|
specializationHasSuffix - String
|
|
specializationIsNil - Boolean
|
|
specializationNotNil - Boolean
|
|
specializationEqualFold - String
|
|
specializationContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasAudiences - Boolean
|
audiences edge predicates |
hasAudiencesWith - [AudienceWhereInput!]
|
|
hasTopics - Boolean
|
topics edge predicates |
hasTopicsWith - [TopicWhereInput!]
|
|
hasTopicNpiTaxonomy - Boolean
|
topic_npi_taxonomy edge predicates |
hasTopicNpiTaxonomyWith - [TopicNpiTaxonomyWhereInput!]
|
Example
{}
Office
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
primary - Boolean!
|
Whether the office is the primary office location. |
address1 - String!
|
The first line of the address. Typically the street address or PO Box number. |
address2 - String
|
The second line of the address. Typically the number of the apartment, suite, or unit. |
city - String!
|
The city of the office |
stateCode - String!
|
The two-letter code for the region. For example CA for California. |
zip - String!
|
The zip or postal code of the address. |
countryCode - String
|
The two-letter code for the country of the address. For example US for United States. |
phone - String
|
The phone number of the office, Formatted using E.164 standard. |
fax - String
|
The fax number of the office. Formatted using E.164 standard. |
email - String
|
The email address for the office |
user - User
|
Example
{
"id": 4,
"primary": true,
"address1": "xyz789",
"address2": "xyz789",
"city": "xyz789",
"stateCode": "xyz789",
"zip": "abc123",
"countryCode": "xyz789",
"phone": "abc123",
"fax": "abc123",
"email": "xyz789",
"user": User
}
OfficeConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [OfficeEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [OfficeEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
OfficeEdge
OfficeWhereInput
Description
OfficeWhereInput is used for filtering Office objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - OfficeWhereInput
|
|
and - [OfficeWhereInput!]
|
|
or - [OfficeWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
primary - Boolean
|
primary field predicates |
primaryNEQ - Boolean
|
|
address1 - String
|
address1 field predicates |
address1NEQ - String
|
|
address1In - [String!]
|
|
address1NotIn - [String!]
|
|
address1GT - String
|
|
address1GTE - String
|
|
address1LT - String
|
|
address1LTE - String
|
|
address1Contains - String
|
|
address1HasPrefix - String
|
|
address1HasSuffix - String
|
|
address1EqualFold - String
|
|
address1ContainsFold - String
|
|
address2 - String
|
address2 field predicates |
address2NEQ - String
|
|
address2In - [String!]
|
|
address2NotIn - [String!]
|
|
address2GT - String
|
|
address2GTE - String
|
|
address2LT - String
|
|
address2LTE - String
|
|
address2Contains - String
|
|
address2HasPrefix - String
|
|
address2HasSuffix - String
|
|
address2IsNil - Boolean
|
|
address2NotNil - Boolean
|
|
address2EqualFold - String
|
|
address2ContainsFold - String
|
|
city - String
|
city field predicates |
cityNEQ - String
|
|
cityIn - [String!]
|
|
cityNotIn - [String!]
|
|
cityGT - String
|
|
cityGTE - String
|
|
cityLT - String
|
|
cityLTE - String
|
|
cityContains - String
|
|
cityHasPrefix - String
|
|
cityHasSuffix - String
|
|
cityEqualFold - String
|
|
cityContainsFold - String
|
|
stateCode - String
|
state_code field predicates |
stateCodeNEQ - String
|
|
stateCodeIn - [String!]
|
|
stateCodeNotIn - [String!]
|
|
stateCodeGT - String
|
|
stateCodeGTE - String
|
|
stateCodeLT - String
|
|
stateCodeLTE - String
|
|
stateCodeContains - String
|
|
stateCodeHasPrefix - String
|
|
stateCodeHasSuffix - String
|
|
stateCodeEqualFold - String
|
|
stateCodeContainsFold - String
|
|
zip - String
|
zip field predicates |
zipNEQ - String
|
|
zipIn - [String!]
|
|
zipNotIn - [String!]
|
|
zipGT - String
|
|
zipGTE - String
|
|
zipLT - String
|
|
zipLTE - String
|
|
zipContains - String
|
|
zipHasPrefix - String
|
|
zipHasSuffix - String
|
|
zipEqualFold - String
|
|
zipContainsFold - String
|
|
countryCode - String
|
country_code field predicates |
countryCodeNEQ - String
|
|
countryCodeIn - [String!]
|
|
countryCodeNotIn - [String!]
|
|
countryCodeGT - String
|
|
countryCodeGTE - String
|
|
countryCodeLT - String
|
|
countryCodeLTE - String
|
|
countryCodeContains - String
|
|
countryCodeHasPrefix - String
|
|
countryCodeHasSuffix - String
|
|
countryCodeIsNil - Boolean
|
|
countryCodeNotNil - Boolean
|
|
countryCodeEqualFold - String
|
|
countryCodeContainsFold - String
|
|
phone - String
|
phone field predicates |
phoneNEQ - String
|
|
phoneIn - [String!]
|
|
phoneNotIn - [String!]
|
|
phoneGT - String
|
|
phoneGTE - String
|
|
phoneLT - String
|
|
phoneLTE - String
|
|
phoneContains - String
|
|
phoneHasPrefix - String
|
|
phoneHasSuffix - String
|
|
phoneIsNil - Boolean
|
|
phoneNotNil - Boolean
|
|
phoneEqualFold - String
|
|
phoneContainsFold - String
|
|
fax - String
|
fax field predicates |
faxNEQ - String
|
|
faxIn - [String!]
|
|
faxNotIn - [String!]
|
|
faxGT - String
|
|
faxGTE - String
|
|
faxLT - String
|
|
faxLTE - String
|
|
faxContains - String
|
|
faxHasPrefix - String
|
|
faxHasSuffix - String
|
|
faxIsNil - Boolean
|
|
faxNotNil - Boolean
|
|
faxEqualFold - String
|
|
faxContainsFold - String
|
|
email - String
|
email field predicates |
emailNEQ - String
|
|
emailIn - [String!]
|
|
emailNotIn - [String!]
|
|
emailGT - String
|
|
emailGTE - String
|
|
emailLT - String
|
|
emailLTE - String
|
|
emailContains - String
|
|
emailHasPrefix - String
|
|
emailHasSuffix - String
|
|
emailIsNil - Boolean
|
|
emailNotNil - Boolean
|
|
emailEqualFold - String
|
|
emailContainsFold - String
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
OrderDirection
Description
Possible directions in which to order a list of items when provided an orderBy argument.
Values
| Enum Value | Description |
|---|---|
|
|
Specifies an ascending order for a given orderBy argument. |
|
|
Specifies a descending order for a given orderBy argument. |
Example
{}
PageInfo
Description
Information about pagination in a connection. https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - Cursor
|
When paginating backwards, the cursor to continue. |
endCursor - Cursor
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": Cursor,
"endCursor": Cursor
}
PartOfSpeechTag
Example
{
"text": "abc123",
"lemma": "abc123",
"pos": "xyz789",
"tag": "abc123",
"dep": "abc123",
"shape": "xyz789",
"isAlpha": false,
"isStop": false
}
PhoneVerificationResponse
Fields
| Field Name | Description |
|---|---|
token - String!
|
Example
{"token": "xyz789"}
PhoneVerificationToken
Example
{
"id": "4",
"phone": "abc123",
"token": "abc123",
"createdAt": "10:15:30Z",
"expiresAt": "10:15:30Z",
"message": "xyz789",
"user": User
}
PhoneVerificationTokenConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PhoneVerificationTokenEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [PhoneVerificationTokenEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PhoneVerificationTokenEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - PhoneVerificationToken
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": PhoneVerificationToken,
"cursor": Cursor
}
PhoneVerificationTokenOrder
Description
Ordering options for PhoneVerificationToken connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - PhoneVerificationTokenOrderField!
|
The field by which to order PhoneVerificationTokens. |
Example
{}
PhoneVerificationTokenOrderField
Description
Properties by which PhoneVerificationToken connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
PhoneVerificationTokenWhereInput
Description
PhoneVerificationTokenWhereInput is used for filtering PhoneVerificationToken objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PhoneVerificationTokenWhereInput
|
|
and - [PhoneVerificationTokenWhereInput!]
|
|
or - [PhoneVerificationTokenWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
phone - String
|
phone field predicates |
phoneNEQ - String
|
|
phoneIn - [String!]
|
|
phoneNotIn - [String!]
|
|
phoneGT - String
|
|
phoneGTE - String
|
|
phoneLT - String
|
|
phoneLTE - String
|
|
phoneContains - String
|
|
phoneHasPrefix - String
|
|
phoneHasSuffix - String
|
|
phoneEqualFold - String
|
|
phoneContainsFold - String
|
|
token - String
|
token field predicates |
tokenNEQ - String
|
|
tokenIn - [String!]
|
|
tokenNotIn - [String!]
|
|
tokenGT - String
|
|
tokenGTE - String
|
|
tokenLT - String
|
|
tokenLTE - String
|
|
tokenContains - String
|
|
tokenHasPrefix - String
|
|
tokenHasSuffix - String
|
|
tokenEqualFold - String
|
|
tokenContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
expiresAt - Time
|
expires_at field predicates |
expiresAtNEQ - Time
|
|
expiresAtIn - [Time!]
|
|
expiresAtNotIn - [Time!]
|
|
expiresAtGT - Time
|
|
expiresAtGTE - Time
|
|
expiresAtLT - Time
|
|
expiresAtLTE - Time
|
|
message - String
|
message field predicates |
messageNEQ - String
|
|
messageIn - [String!]
|
|
messageNotIn - [String!]
|
|
messageGT - String
|
|
messageGTE - String
|
|
messageLT - String
|
|
messageLTE - String
|
|
messageContains - String
|
|
messageHasPrefix - String
|
|
messageHasSuffix - String
|
|
messageIsNil - Boolean
|
|
messageNotNil - Boolean
|
|
messageEqualFold - String
|
|
messageContainsFold - String
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
Poll
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
totalVotes - Int!
|
|
createdAt - Time!
|
|
post - Post
|
|
questions - [PollQuestion!]
|
Example
{
"id": 4,
"totalVotes": 123,
"createdAt": "10:15:30Z",
"post": Post,
"questions": [PollQuestion]
}
PollAnswer
PollAnswerWhereInput
Description
PollAnswerWhereInput is used for filtering PollAnswer objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PollAnswerWhereInput
|
|
and - [PollAnswerWhereInput!]
|
|
or - [PollAnswerWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
pollID - ID
|
poll_id field predicates |
pollIDNEQ - ID
|
|
pollIDIn - [ID!]
|
|
pollIDNotIn - [ID!]
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasPoll - Boolean
|
poll edge predicates |
hasPollWith - [PollWhereInput!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasQuestion - Boolean
|
question edge predicates |
hasQuestionWith - [PollQuestionWhereInput!]
|
Example
{}
PollQuestion
PollQuestionWhereInput
Description
PollQuestionWhereInput is used for filtering PollQuestion objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PollQuestionWhereInput
|
|
and - [PollQuestionWhereInput!]
|
|
or - [PollQuestionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
question - String
|
question field predicates |
questionNEQ - String
|
|
questionIn - [String!]
|
|
questionNotIn - [String!]
|
|
questionGT - String
|
|
questionGTE - String
|
|
questionLT - String
|
|
questionLTE - String
|
|
questionContains - String
|
|
questionHasPrefix - String
|
|
questionHasSuffix - String
|
|
questionEqualFold - String
|
|
questionContainsFold - String
|
|
totalVotes - Int
|
total_votes field predicates |
totalVotesNEQ - Int
|
|
totalVotesIn - [Int!]
|
|
totalVotesNotIn - [Int!]
|
|
totalVotesGT - Int
|
|
totalVotesGTE - Int
|
|
totalVotesLT - Int
|
|
totalVotesLTE - Int
|
|
hasPoll - Boolean
|
poll edge predicates |
hasPollWith - [PollWhereInput!]
|
Example
{}
PollWhereInput
Description
PollWhereInput is used for filtering Poll objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PollWhereInput
|
|
and - [PollWhereInput!]
|
|
or - [PollWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
totalVotes - Int
|
total_votes field predicates |
totalVotesNEQ - Int
|
|
totalVotesIn - [Int!]
|
|
totalVotesNotIn - [Int!]
|
|
totalVotesGT - Int
|
|
totalVotesGTE - Int
|
|
totalVotesLT - Int
|
|
totalVotesLTE - Int
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
|
hasQuestions - Boolean
|
questions edge predicates |
hasQuestionsWith - [PollQuestionWhereInput!]
|
Example
{}
Post
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
title - String!
|
Title of the post |
suggestedTitle - String
|
A suggested title based on the audio transcription |
creditHours - Float!
|
The number of CE credits this post is accredited for |
status - PostStatus!
|
Status of the post |
body - String!
|
Body of the post. Tags (starting with a #) and Mentions (starting with an @) are allowed |
suggestedBody - String
|
A suggested body based on the audio transcription |
totalVideos - Int!
|
Total number of videos on this post. |
totalImages - Int!
|
Total number of images on this post. |
totalDuration - Int!
|
The total duration of all videos for this post, in seconds. |
totalLikes - Int!
|
Total number of likes |
totalComments - Int!
|
Total number of comments |
totalReactions - Int!
|
Total number of reactions |
totalBookmarks - Int!
|
Total number of bookmarks |
speakMediaID - String
|
The ID of this post in SpeakAI |
featured - Boolean!
|
Whether this post is featured |
transcription - SpeakInsightResult
|
The transcription result from SpeakAI |
discussionPoints - [String!]
|
The main discussion points for this post |
topLearningObjectives - [String!]
|
The top learning objectives for this post |
createdAt - Time!
|
|
updatedAt - Time!
|
|
transcriptionStartedAt - Time
|
The time when the transcription started |
transcriptionCompletedAt - Time
|
The time when the transcription completed |
insightsGeneratedAt - Time
|
The time when the insights were last generated |
sortKey - Int
|
|
termsPerMinute - Float!
|
The number of terms per minute in the video |
terms - [String!]
|
|
termFrequencies - Map
|
|
wordcloud - String
|
|
type - PostType!
|
The type of the post |
author - User
|
The author of this post |
topics - [Topic!]
|
The topics this post is associated with |
citations - [PostCitation!]
|
The citations this post is associated with |
tenant - Tenant
|
The tenant that the topic belongs to. |
accreditedLearningObjective - LearningObjective
|
The accredited learning objective for this post |
comments - [Comment!]
|
The comments on this post |
mediaItems - [MediaItem!]
|
The media items in this post |
videos - [Video!]
|
The videos for this post. |
coverImage - Image
|
The cover image for this post. Images are hosted using Cloudflare images. Please see https://developers.cloudflare.com/images/cloudflare-images/serve-images/ for details on how to serve images. |
images - [Image!]
|
The images for this post. |
postCollections - [PostCollection!]
|
The collections this post is associated with |
educationCredits - [EducationCredit!]
|
All credits earned from this post, across all the user. |
audiences - [Audience!]
|
The audiences for this post |
tags - [Tag!]
|
The tags on this post |
likedUsers - [User!]
|
The users who liked this post |
bookmarkedUsers - [User!]
|
The users who bookmarked this post |
learningObjectives - [LearningObjective!]
|
The selected learning objectives for this post |
postReports - [PostReport!]
|
The post reports this post has received |
poll - Poll
|
|
embeddings - [PostEmbedding!]
|
|
likes - [Like!]
|
|
bookmarks - [Bookmark!]
|
|
postlearningobectives - [PostLearningObjective!]
|
|
likedAt - Time
|
|
bookmarkedAt - Time
|
|
commentsDisabled - Boolean
|
|
topicClassifications - [TopicClassification!]
|
|
Example
{
"id": 4,
"title": "xyz789",
"suggestedTitle": "xyz789",
"creditHours": 123.45,
"status": "draft",
"body": "abc123",
"suggestedBody": "xyz789",
"totalVideos": 987,
"totalImages": 123,
"totalDuration": 987,
"totalLikes": 123,
"totalComments": 987,
"totalReactions": 987,
"totalBookmarks": 123,
"speakMediaID": "abc123",
"featured": false,
"transcription": SpeakInsightResult,
"discussionPoints": ["xyz789"],
"topLearningObjectives": ["xyz789"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcriptionStartedAt": "10:15:30Z",
"transcriptionCompletedAt": "10:15:30Z",
"insightsGeneratedAt": "10:15:30Z",
"sortKey": 123,
"termsPerMinute": 123.45,
"terms": ["xyz789"],
"termFrequencies": Map,
"wordcloud": "abc123",
"type": "video",
"author": User,
"topics": [Topic],
"citations": [PostCitation],
"tenant": Tenant,
"accreditedLearningObjective": LearningObjective,
"comments": [Comment],
"mediaItems": [MediaItem],
"videos": [Video],
"coverImage": Image,
"images": [Image],
"postCollections": [PostCollection],
"educationCredits": [EducationCredit],
"audiences": [Audience],
"tags": [Tag],
"likedUsers": [User],
"bookmarkedUsers": [User],
"learningObjectives": [LearningObjective],
"postReports": [PostReport],
"poll": Poll,
"embeddings": [PostEmbedding],
"likes": [Like],
"bookmarks": [Bookmark],
"postlearningobectives": [PostLearningObjective],
"likedAt": "10:15:30Z",
"bookmarkedAt": "10:15:30Z",
"commentsDisabled": true,
"topicClassifications": [TopicClassification]
}
PostCitation
PostCitationWhereInput
Description
PostCitationWhereInput is used for filtering PostCitation objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostCitationWhereInput
|
|
and - [PostCitationWhereInput!]
|
|
or - [PostCitationWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
Example
{}
PostCollection
PostCollectionWhereInput
Description
PostCollectionWhereInput is used for filtering PostCollection objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostCollectionWhereInput
|
|
and - [PostCollectionWhereInput!]
|
|
or - [PostCollectionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
postID - ID
|
post_id field predicates |
postIDNEQ - ID
|
|
postIDIn - [ID!]
|
|
postIDNotIn - [ID!]
|
|
collectionID - ID
|
collection_id field predicates |
collectionIDNEQ - ID
|
|
collectionIDIn - [ID!]
|
|
collectionIDNotIn - [ID!]
|
|
ordinal - Int
|
ordinal field predicates |
ordinalNEQ - Int
|
|
ordinalIn - [Int!]
|
|
ordinalNotIn - [Int!]
|
|
ordinalGT - Int
|
|
ordinalGTE - Int
|
|
ordinalLT - Int
|
|
ordinalLTE - Int
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
|
hasCollection - Boolean
|
collection edge predicates |
hasCollectionWith - [CollectionWhereInput!]
|
Example
{}
PostConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PostEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PostEdge
PostEmbedding
PostEmbeddingType
Description
PostEmbeddingType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
PostEmbeddingWhereInput
Description
PostEmbeddingWhereInput is used for filtering PostEmbedding objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostEmbeddingWhereInput
|
|
and - [PostEmbeddingWhereInput!]
|
|
or - [PostEmbeddingWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
content - String
|
content field predicates |
contentNEQ - String
|
|
contentIn - [String!]
|
|
contentNotIn - [String!]
|
|
contentGT - String
|
|
contentGTE - String
|
|
contentLT - String
|
|
contentLTE - String
|
|
contentContains - String
|
|
contentHasPrefix - String
|
|
contentHasSuffix - String
|
|
contentEqualFold - String
|
|
contentContainsFold - String
|
|
type - PostEmbeddingType
|
type field predicates |
typeNEQ - PostEmbeddingType
|
|
typeIn - [PostEmbeddingType!]
|
|
typeNotIn - [PostEmbeddingType!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
postID - ID
|
post_id field predicates |
postIDNEQ - ID
|
|
postIDIn - [ID!]
|
|
postIDNotIn - [ID!]
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
Example
{}
PostLearningObjective
PostLearningObjectiveWhereInput
Description
PostLearningObjectiveWhereInput is used for filtering PostLearningObjective objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostLearningObjectiveWhereInput
|
|
and - [PostLearningObjectiveWhereInput!]
|
|
or - [PostLearningObjectiveWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
ordinal - Int
|
ordinal field predicates |
ordinalNEQ - Int
|
|
ordinalIn - [Int!]
|
|
ordinalNotIn - [Int!]
|
|
ordinalGT - Int
|
|
ordinalGTE - Int
|
|
ordinalLT - Int
|
|
ordinalLTE - Int
|
Example
{}
PostOrder
Description
Ordering options for Post connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - PostOrderField!
|
The field by which to order Posts. |
Example
{}
PostOrderField
Description
Properties by which Post connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
PostReaction
Example
{
"id": "4",
"reactedAt": "10:15:30Z",
"value": "abc123",
"userID": 4,
"postID": "4",
"user": User,
"post": Post
}
PostReactionInput
PostReactionWhereInput
Description
PostReactionWhereInput is used for filtering PostReaction objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostReactionWhereInput
|
|
and - [PostReactionWhereInput!]
|
|
or - [PostReactionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
reactedAt - Time
|
reacted_at field predicates |
reactedAtNEQ - Time
|
|
reactedAtIn - [Time!]
|
|
reactedAtNotIn - [Time!]
|
|
reactedAtGT - Time
|
|
reactedAtGTE - Time
|
|
reactedAtLT - Time
|
|
reactedAtLTE - Time
|
|
value - String
|
value field predicates |
valueNEQ - String
|
|
valueIn - [String!]
|
|
valueNotIn - [String!]
|
|
valueGT - String
|
|
valueGTE - String
|
|
valueLT - String
|
|
valueLTE - String
|
|
valueContains - String
|
|
valueHasPrefix - String
|
|
valueHasSuffix - String
|
|
valueEqualFold - String
|
|
valueContainsFold - String
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
postID - ID
|
post_id field predicates |
postIDNEQ - ID
|
|
postIDIn - [ID!]
|
|
postIDNotIn - [ID!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
Example
{}
PostReport
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
description - String
|
The description of the user report |
createdAt - Time!
|
|
reviewedAt - Time
|
The time the report was reviewed |
reportReason - ReportReason
|
The reason for the user report |
author - User
|
The author of the post report |
reportedPost - Post
|
The post that was reported |
reviewedBy - User
|
The admin user that reviewed the report |
Example
{
"id": "4",
"description": "abc123",
"createdAt": "10:15:30Z",
"reviewedAt": "10:15:30Z",
"reportReason": ReportReason,
"author": User,
"reportedPost": Post,
"reviewedBy": User
}
PostReportConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PostReportEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [PostReportEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PostReportEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - PostReport
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": PostReport,
"cursor": Cursor
}
PostReportOrder
Description
Ordering options for PostReport connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - PostReportOrderField!
|
The field by which to order PostReports. |
Example
{}
PostReportOrderField
Description
Properties by which PostReport connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
PostReportWhereInput
Description
PostReportWhereInput is used for filtering PostReport objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostReportWhereInput
|
|
and - [PostReportWhereInput!]
|
|
or - [PostReportWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
description - String
|
description field predicates |
descriptionNEQ - String
|
|
descriptionIn - [String!]
|
|
descriptionNotIn - [String!]
|
|
descriptionGT - String
|
|
descriptionGTE - String
|
|
descriptionLT - String
|
|
descriptionLTE - String
|
|
descriptionContains - String
|
|
descriptionHasPrefix - String
|
|
descriptionHasSuffix - String
|
|
descriptionIsNil - Boolean
|
|
descriptionNotNil - Boolean
|
|
descriptionEqualFold - String
|
|
descriptionContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
reviewedAt - Time
|
reviewed_at field predicates |
reviewedAtNEQ - Time
|
|
reviewedAtIn - [Time!]
|
|
reviewedAtNotIn - [Time!]
|
|
reviewedAtGT - Time
|
|
reviewedAtGTE - Time
|
|
reviewedAtLT - Time
|
|
reviewedAtLTE - Time
|
|
reviewedAtIsNil - Boolean
|
|
reviewedAtNotNil - Boolean
|
|
hasReportReason - Boolean
|
report_reason edge predicates |
hasReportReasonWith - [ReportReasonWhereInput!]
|
|
hasAuthor - Boolean
|
author edge predicates |
hasAuthorWith - [UserWhereInput!]
|
|
hasReportedPost - Boolean
|
reported_post edge predicates |
hasReportedPostWith - [PostWhereInput!]
|
|
hasReviewedBy - Boolean
|
reviewed_by edge predicates |
hasReviewedByWith - [UserWhereInput!]
|
Example
{}
PostSearchConnection
Fields
| Field Name | Description |
|---|---|
edges - [PostEdge]
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
|
topics - [Topic]
|
The topics that are present in the search results. |
Example
{
"edges": [PostEdge],
"pageInfo": PageInfo,
"totalCount": 123,
"topics": [Topic]
}
PostSearchResult
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
title - String!
|
|
coverImage - SearchResultImage
|
|
video - SearchResultVideo
|
|
user - UserSearchResult
|
|
topics - [TopicSearchResult!]!
|
|
tags - [String!]!
|
Example
{
"id": "4",
"title": "xyz789",
"coverImage": SearchResultImage,
"video": SearchResultVideo,
"user": UserSearchResult,
"topics": [TopicSearchResult],
"tags": ["abc123"]
}
PostStatus
Description
PostStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
PostType
Description
PostType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
PostWhereInput
Description
PostWhereInput is used for filtering Post objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PostWhereInput
|
|
and - [PostWhereInput!]
|
|
or - [PostWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
suggestedTitle - String
|
suggested_title field predicates |
suggestedTitleNEQ - String
|
|
suggestedTitleIn - [String!]
|
|
suggestedTitleNotIn - [String!]
|
|
suggestedTitleGT - String
|
|
suggestedTitleGTE - String
|
|
suggestedTitleLT - String
|
|
suggestedTitleLTE - String
|
|
suggestedTitleContains - String
|
|
suggestedTitleHasPrefix - String
|
|
suggestedTitleHasSuffix - String
|
|
suggestedTitleIsNil - Boolean
|
|
suggestedTitleNotNil - Boolean
|
|
suggestedTitleEqualFold - String
|
|
suggestedTitleContainsFold - String
|
|
creditHours - Float
|
credit_hours field predicates |
creditHoursNEQ - Float
|
|
creditHoursIn - [Float!]
|
|
creditHoursNotIn - [Float!]
|
|
creditHoursGT - Float
|
|
creditHoursGTE - Float
|
|
creditHoursLT - Float
|
|
creditHoursLTE - Float
|
|
status - PostStatus
|
status field predicates |
statusNEQ - PostStatus
|
|
statusIn - [PostStatus!]
|
|
statusNotIn - [PostStatus!]
|
|
body - String
|
body field predicates |
bodyNEQ - String
|
|
bodyIn - [String!]
|
|
bodyNotIn - [String!]
|
|
bodyGT - String
|
|
bodyGTE - String
|
|
bodyLT - String
|
|
bodyLTE - String
|
|
bodyContains - String
|
|
bodyHasPrefix - String
|
|
bodyHasSuffix - String
|
|
bodyEqualFold - String
|
|
bodyContainsFold - String
|
|
suggestedBody - String
|
suggested_body field predicates |
suggestedBodyNEQ - String
|
|
suggestedBodyIn - [String!]
|
|
suggestedBodyNotIn - [String!]
|
|
suggestedBodyGT - String
|
|
suggestedBodyGTE - String
|
|
suggestedBodyLT - String
|
|
suggestedBodyLTE - String
|
|
suggestedBodyContains - String
|
|
suggestedBodyHasPrefix - String
|
|
suggestedBodyHasSuffix - String
|
|
suggestedBodyIsNil - Boolean
|
|
suggestedBodyNotNil - Boolean
|
|
suggestedBodyEqualFold - String
|
|
suggestedBodyContainsFold - String
|
|
totalVideos - Int
|
total_videos field predicates |
totalVideosNEQ - Int
|
|
totalVideosIn - [Int!]
|
|
totalVideosNotIn - [Int!]
|
|
totalVideosGT - Int
|
|
totalVideosGTE - Int
|
|
totalVideosLT - Int
|
|
totalVideosLTE - Int
|
|
totalImages - Int
|
total_images field predicates |
totalImagesNEQ - Int
|
|
totalImagesIn - [Int!]
|
|
totalImagesNotIn - [Int!]
|
|
totalImagesGT - Int
|
|
totalImagesGTE - Int
|
|
totalImagesLT - Int
|
|
totalImagesLTE - Int
|
|
totalDuration - Int
|
total_duration field predicates |
totalDurationNEQ - Int
|
|
totalDurationIn - [Int!]
|
|
totalDurationNotIn - [Int!]
|
|
totalDurationGT - Int
|
|
totalDurationGTE - Int
|
|
totalDurationLT - Int
|
|
totalDurationLTE - Int
|
|
totalLikes - Int
|
total_likes field predicates |
totalLikesNEQ - Int
|
|
totalLikesIn - [Int!]
|
|
totalLikesNotIn - [Int!]
|
|
totalLikesGT - Int
|
|
totalLikesGTE - Int
|
|
totalLikesLT - Int
|
|
totalLikesLTE - Int
|
|
totalComments - Int
|
total_comments field predicates |
totalCommentsNEQ - Int
|
|
totalCommentsIn - [Int!]
|
|
totalCommentsNotIn - [Int!]
|
|
totalCommentsGT - Int
|
|
totalCommentsGTE - Int
|
|
totalCommentsLT - Int
|
|
totalCommentsLTE - Int
|
|
totalReactions - Int
|
total_reactions field predicates |
totalReactionsNEQ - Int
|
|
totalReactionsIn - [Int!]
|
|
totalReactionsNotIn - [Int!]
|
|
totalReactionsGT - Int
|
|
totalReactionsGTE - Int
|
|
totalReactionsLT - Int
|
|
totalReactionsLTE - Int
|
|
totalBookmarks - Int
|
total_bookmarks field predicates |
totalBookmarksNEQ - Int
|
|
totalBookmarksIn - [Int!]
|
|
totalBookmarksNotIn - [Int!]
|
|
totalBookmarksGT - Int
|
|
totalBookmarksGTE - Int
|
|
totalBookmarksLT - Int
|
|
totalBookmarksLTE - Int
|
|
speakMediaID - String
|
speak_media_id field predicates |
speakMediaIDNEQ - String
|
|
speakMediaIDIn - [String!]
|
|
speakMediaIDNotIn - [String!]
|
|
speakMediaIDGT - String
|
|
speakMediaIDGTE - String
|
|
speakMediaIDLT - String
|
|
speakMediaIDLTE - String
|
|
speakMediaIDContains - String
|
|
speakMediaIDHasPrefix - String
|
|
speakMediaIDHasSuffix - String
|
|
speakMediaIDIsNil - Boolean
|
|
speakMediaIDNotNil - Boolean
|
|
speakMediaIDEqualFold - String
|
|
speakMediaIDContainsFold - String
|
|
featured - Boolean
|
featured field predicates |
featuredNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
transcriptionStartedAt - Time
|
transcription_started_at field predicates |
transcriptionStartedAtNEQ - Time
|
|
transcriptionStartedAtIn - [Time!]
|
|
transcriptionStartedAtNotIn - [Time!]
|
|
transcriptionStartedAtGT - Time
|
|
transcriptionStartedAtGTE - Time
|
|
transcriptionStartedAtLT - Time
|
|
transcriptionStartedAtLTE - Time
|
|
transcriptionStartedAtIsNil - Boolean
|
|
transcriptionStartedAtNotNil - Boolean
|
|
transcriptionCompletedAt - Time
|
transcription_completed_at field predicates |
transcriptionCompletedAtNEQ - Time
|
|
transcriptionCompletedAtIn - [Time!]
|
|
transcriptionCompletedAtNotIn - [Time!]
|
|
transcriptionCompletedAtGT - Time
|
|
transcriptionCompletedAtGTE - Time
|
|
transcriptionCompletedAtLT - Time
|
|
transcriptionCompletedAtLTE - Time
|
|
transcriptionCompletedAtIsNil - Boolean
|
|
transcriptionCompletedAtNotNil - Boolean
|
|
insightsGeneratedAt - Time
|
insights_generated_at field predicates |
insightsGeneratedAtNEQ - Time
|
|
insightsGeneratedAtIn - [Time!]
|
|
insightsGeneratedAtNotIn - [Time!]
|
|
insightsGeneratedAtGT - Time
|
|
insightsGeneratedAtGTE - Time
|
|
insightsGeneratedAtLT - Time
|
|
insightsGeneratedAtLTE - Time
|
|
insightsGeneratedAtIsNil - Boolean
|
|
insightsGeneratedAtNotNil - Boolean
|
|
sortKey - Int
|
sort_key field predicates |
sortKeyNEQ - Int
|
|
sortKeyIn - [Int!]
|
|
sortKeyNotIn - [Int!]
|
|
sortKeyGT - Int
|
|
sortKeyGTE - Int
|
|
sortKeyLT - Int
|
|
sortKeyLTE - Int
|
|
sortKeyIsNil - Boolean
|
|
sortKeyNotNil - Boolean
|
|
termsPerMinute - Float
|
terms_per_minute field predicates |
termsPerMinuteNEQ - Float
|
|
termsPerMinuteIn - [Float!]
|
|
termsPerMinuteNotIn - [Float!]
|
|
termsPerMinuteGT - Float
|
|
termsPerMinuteGTE - Float
|
|
termsPerMinuteLT - Float
|
|
termsPerMinuteLTE - Float
|
|
wordcloud - String
|
wordcloud field predicates |
wordcloudNEQ - String
|
|
wordcloudIn - [String!]
|
|
wordcloudNotIn - [String!]
|
|
wordcloudGT - String
|
|
wordcloudGTE - String
|
|
wordcloudLT - String
|
|
wordcloudLTE - String
|
|
wordcloudContains - String
|
|
wordcloudHasPrefix - String
|
|
wordcloudHasSuffix - String
|
|
wordcloudIsNil - Boolean
|
|
wordcloudNotNil - Boolean
|
|
wordcloudEqualFold - String
|
|
wordcloudContainsFold - String
|
|
type - PostType
|
type field predicates |
typeNEQ - PostType
|
|
typeIn - [PostType!]
|
|
typeNotIn - [PostType!]
|
|
hasAuthor - Boolean
|
author edge predicates |
hasAuthorWith - [UserWhereInput!]
|
|
hasTopics - Boolean
|
topics edge predicates |
hasTopicsWith - [TopicWhereInput!]
|
|
hasCitations - Boolean
|
citations edge predicates |
hasCitationsWith - [PostCitationWhereInput!]
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasAccreditedLearningObjective - Boolean
|
accredited_learning_objective edge predicates |
hasAccreditedLearningObjectiveWith - [LearningObjectiveWhereInput!]
|
|
hasComments - Boolean
|
comments edge predicates |
hasCommentsWith - [CommentWhereInput!]
|
|
hasMediaItems - Boolean
|
media_items edge predicates |
hasMediaItemsWith - [MediaItemWhereInput!]
|
|
hasVideos - Boolean
|
videos edge predicates |
hasVideosWith - [VideoWhereInput!]
|
|
hasCoverImage - Boolean
|
cover_image edge predicates |
hasCoverImageWith - [ImageWhereInput!]
|
|
hasImages - Boolean
|
images edge predicates |
hasImagesWith - [ImageWhereInput!]
|
|
hasPostCollections - Boolean
|
post_collections edge predicates |
hasPostCollectionsWith - [PostCollectionWhereInput!]
|
|
hasEducationCredits - Boolean
|
education_credits edge predicates |
hasEducationCreditsWith - [EducationCreditWhereInput!]
|
|
hasAudiences - Boolean
|
audiences edge predicates |
hasAudiencesWith - [AudienceWhereInput!]
|
|
hasPostTags - Boolean
|
post_tags edge predicates |
hasPostTagsWith - [TagWhereInput!]
|
|
hasLikedUsers - Boolean
|
liked_users edge predicates |
hasLikedUsersWith - [UserWhereInput!]
|
|
hasBookmarkedUsers - Boolean
|
bookmarked_users edge predicates |
hasBookmarkedUsersWith - [UserWhereInput!]
|
|
hasLearningObjectives - Boolean
|
learning_objectives edge predicates |
hasLearningObjectivesWith - [LearningObjectiveWhereInput!]
|
|
hasPostReports - Boolean
|
post_reports edge predicates |
hasPostReportsWith - [PostReportWhereInput!]
|
|
hasPoll - Boolean
|
poll edge predicates |
hasPollWith - [PollWhereInput!]
|
|
hasEmbeddings - Boolean
|
embeddings edge predicates |
hasEmbeddingsWith - [PostEmbeddingWhereInput!]
|
|
hasLikes - Boolean
|
likes edge predicates |
hasLikesWith - [LikeWhereInput!]
|
|
hasBookmarks - Boolean
|
bookmarks edge predicates |
hasBookmarksWith - [BookmarkWhereInput!]
|
|
hasPostlearningobectives - Boolean
|
postlearningobectives edge predicates |
hasPostlearningobectivesWith - [PostLearningObjectiveWhereInput!]
|
Example
{}
PreviousReflectionResultInput
Provider
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
npi - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
middleName - String!
|
|
prefix - String!
|
|
suffix - String!
|
|
credential - String!
|
|
businessMailAddress - String!
|
|
businessMailAddress2 - String!
|
|
businessCity - String!
|
|
businessState - String!
|
|
businessPostalCode - String!
|
|
businessCountryCode - String!
|
|
businessTelephoneNumber - String!
|
|
practiceLocationAddress - String!
|
|
practiceLocationAddress2 - String!
|
|
practiceLocationCity - String!
|
|
practiceLocationState - String!
|
|
practiceLocationPostalCode - String!
|
|
practiceLocationCountryCode - String!
|
|
practiceLocationTelephoneNumber - String!
|
|
taxonomyCode - String!
|
|
licenseNumber - String!
|
|
licenseStateCode - String!
|
Example
{
"id": 4,
"npi": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"middleName": "xyz789",
"prefix": "xyz789",
"suffix": "xyz789",
"credential": "abc123",
"businessMailAddress": "abc123",
"businessMailAddress2": "xyz789",
"businessCity": "xyz789",
"businessState": "xyz789",
"businessPostalCode": "abc123",
"businessCountryCode": "xyz789",
"businessTelephoneNumber": "abc123",
"practiceLocationAddress": "abc123",
"practiceLocationAddress2": "abc123",
"practiceLocationCity": "abc123",
"practiceLocationState": "abc123",
"practiceLocationPostalCode": "abc123",
"practiceLocationCountryCode": "xyz789",
"practiceLocationTelephoneNumber": "xyz789",
"taxonomyCode": "abc123",
"licenseNumber": "abc123",
"licenseStateCode": "abc123"
}
ProviderWhereInput
Description
ProviderWhereInput is used for filtering Provider objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ProviderWhereInput
|
|
and - [ProviderWhereInput!]
|
|
or - [ProviderWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
npi - String
|
npi field predicates |
npiNEQ - String
|
|
npiIn - [String!]
|
|
npiNotIn - [String!]
|
|
npiGT - String
|
|
npiGTE - String
|
|
npiLT - String
|
|
npiLTE - String
|
|
npiContains - String
|
|
npiHasPrefix - String
|
|
npiHasSuffix - String
|
|
npiEqualFold - String
|
|
npiContainsFold - String
|
|
firstName - String
|
first_name field predicates |
firstNameNEQ - String
|
|
firstNameIn - [String!]
|
|
firstNameNotIn - [String!]
|
|
firstNameGT - String
|
|
firstNameGTE - String
|
|
firstNameLT - String
|
|
firstNameLTE - String
|
|
firstNameContains - String
|
|
firstNameHasPrefix - String
|
|
firstNameHasSuffix - String
|
|
firstNameEqualFold - String
|
|
firstNameContainsFold - String
|
|
lastName - String
|
last_name field predicates |
lastNameNEQ - String
|
|
lastNameIn - [String!]
|
|
lastNameNotIn - [String!]
|
|
lastNameGT - String
|
|
lastNameGTE - String
|
|
lastNameLT - String
|
|
lastNameLTE - String
|
|
lastNameContains - String
|
|
lastNameHasPrefix - String
|
|
lastNameHasSuffix - String
|
|
lastNameEqualFold - String
|
|
lastNameContainsFold - String
|
|
middleName - String
|
middle_name field predicates |
middleNameNEQ - String
|
|
middleNameIn - [String!]
|
|
middleNameNotIn - [String!]
|
|
middleNameGT - String
|
|
middleNameGTE - String
|
|
middleNameLT - String
|
|
middleNameLTE - String
|
|
middleNameContains - String
|
|
middleNameHasPrefix - String
|
|
middleNameHasSuffix - String
|
|
middleNameEqualFold - String
|
|
middleNameContainsFold - String
|
|
prefix - String
|
prefix field predicates |
prefixNEQ - String
|
|
prefixIn - [String!]
|
|
prefixNotIn - [String!]
|
|
prefixGT - String
|
|
prefixGTE - String
|
|
prefixLT - String
|
|
prefixLTE - String
|
|
prefixContains - String
|
|
prefixHasPrefix - String
|
|
prefixHasSuffix - String
|
|
prefixEqualFold - String
|
|
prefixContainsFold - String
|
|
suffix - String
|
suffix field predicates |
suffixNEQ - String
|
|
suffixIn - [String!]
|
|
suffixNotIn - [String!]
|
|
suffixGT - String
|
|
suffixGTE - String
|
|
suffixLT - String
|
|
suffixLTE - String
|
|
suffixContains - String
|
|
suffixHasPrefix - String
|
|
suffixHasSuffix - String
|
|
suffixEqualFold - String
|
|
suffixContainsFold - String
|
|
credential - String
|
credential field predicates |
credentialNEQ - String
|
|
credentialIn - [String!]
|
|
credentialNotIn - [String!]
|
|
credentialGT - String
|
|
credentialGTE - String
|
|
credentialLT - String
|
|
credentialLTE - String
|
|
credentialContains - String
|
|
credentialHasPrefix - String
|
|
credentialHasSuffix - String
|
|
credentialEqualFold - String
|
|
credentialContainsFold - String
|
|
businessMailAddress - String
|
business_mail_address field predicates |
businessMailAddressNEQ - String
|
|
businessMailAddressIn - [String!]
|
|
businessMailAddressNotIn - [String!]
|
|
businessMailAddressGT - String
|
|
businessMailAddressGTE - String
|
|
businessMailAddressLT - String
|
|
businessMailAddressLTE - String
|
|
businessMailAddressContains - String
|
|
businessMailAddressHasPrefix - String
|
|
businessMailAddressHasSuffix - String
|
|
businessMailAddressEqualFold - String
|
|
businessMailAddressContainsFold - String
|
|
businessMailAddress2 - String
|
business_mail_address_2 field predicates |
businessMailAddress2NEQ - String
|
|
businessMailAddress2In - [String!]
|
|
businessMailAddress2NotIn - [String!]
|
|
businessMailAddress2GT - String
|
|
businessMailAddress2GTE - String
|
|
businessMailAddress2LT - String
|
|
businessMailAddress2LTE - String
|
|
businessMailAddress2Contains - String
|
|
businessMailAddress2HasPrefix - String
|
|
businessMailAddress2HasSuffix - String
|
|
businessMailAddress2EqualFold - String
|
|
businessMailAddress2ContainsFold - String
|
|
businessCity - String
|
business_city field predicates |
businessCityNEQ - String
|
|
businessCityIn - [String!]
|
|
businessCityNotIn - [String!]
|
|
businessCityGT - String
|
|
businessCityGTE - String
|
|
businessCityLT - String
|
|
businessCityLTE - String
|
|
businessCityContains - String
|
|
businessCityHasPrefix - String
|
|
businessCityHasSuffix - String
|
|
businessCityEqualFold - String
|
|
businessCityContainsFold - String
|
|
businessState - String
|
business_state field predicates |
businessStateNEQ - String
|
|
businessStateIn - [String!]
|
|
businessStateNotIn - [String!]
|
|
businessStateGT - String
|
|
businessStateGTE - String
|
|
businessStateLT - String
|
|
businessStateLTE - String
|
|
businessStateContains - String
|
|
businessStateHasPrefix - String
|
|
businessStateHasSuffix - String
|
|
businessStateEqualFold - String
|
|
businessStateContainsFold - String
|
|
businessPostalCode - String
|
business_postal_code field predicates |
businessPostalCodeNEQ - String
|
|
businessPostalCodeIn - [String!]
|
|
businessPostalCodeNotIn - [String!]
|
|
businessPostalCodeGT - String
|
|
businessPostalCodeGTE - String
|
|
businessPostalCodeLT - String
|
|
businessPostalCodeLTE - String
|
|
businessPostalCodeContains - String
|
|
businessPostalCodeHasPrefix - String
|
|
businessPostalCodeHasSuffix - String
|
|
businessPostalCodeEqualFold - String
|
|
businessPostalCodeContainsFold - String
|
|
businessCountryCode - String
|
business_country_code field predicates |
businessCountryCodeNEQ - String
|
|
businessCountryCodeIn - [String!]
|
|
businessCountryCodeNotIn - [String!]
|
|
businessCountryCodeGT - String
|
|
businessCountryCodeGTE - String
|
|
businessCountryCodeLT - String
|
|
businessCountryCodeLTE - String
|
|
businessCountryCodeContains - String
|
|
businessCountryCodeHasPrefix - String
|
|
businessCountryCodeHasSuffix - String
|
|
businessCountryCodeEqualFold - String
|
|
businessCountryCodeContainsFold - String
|
|
businessTelephoneNumber - String
|
business_telephone_number field predicates |
businessTelephoneNumberNEQ - String
|
|
businessTelephoneNumberIn - [String!]
|
|
businessTelephoneNumberNotIn - [String!]
|
|
businessTelephoneNumberGT - String
|
|
businessTelephoneNumberGTE - String
|
|
businessTelephoneNumberLT - String
|
|
businessTelephoneNumberLTE - String
|
|
businessTelephoneNumberContains - String
|
|
businessTelephoneNumberHasPrefix - String
|
|
businessTelephoneNumberHasSuffix - String
|
|
businessTelephoneNumberEqualFold - String
|
|
businessTelephoneNumberContainsFold - String
|
|
practiceLocationAddress - String
|
practice_location_address field predicates |
practiceLocationAddressNEQ - String
|
|
practiceLocationAddressIn - [String!]
|
|
practiceLocationAddressNotIn - [String!]
|
|
practiceLocationAddressGT - String
|
|
practiceLocationAddressGTE - String
|
|
practiceLocationAddressLT - String
|
|
practiceLocationAddressLTE - String
|
|
practiceLocationAddressContains - String
|
|
practiceLocationAddressHasPrefix - String
|
|
practiceLocationAddressHasSuffix - String
|
|
practiceLocationAddressEqualFold - String
|
|
practiceLocationAddressContainsFold - String
|
|
practiceLocationAddress2 - String
|
practice_location_address_2 field predicates |
practiceLocationAddress2NEQ - String
|
|
practiceLocationAddress2In - [String!]
|
|
practiceLocationAddress2NotIn - [String!]
|
|
practiceLocationAddress2GT - String
|
|
practiceLocationAddress2GTE - String
|
|
practiceLocationAddress2LT - String
|
|
practiceLocationAddress2LTE - String
|
|
practiceLocationAddress2Contains - String
|
|
practiceLocationAddress2HasPrefix - String
|
|
practiceLocationAddress2HasSuffix - String
|
|
practiceLocationAddress2EqualFold - String
|
|
practiceLocationAddress2ContainsFold - String
|
|
practiceLocationCity - String
|
practice_location_city field predicates |
practiceLocationCityNEQ - String
|
|
practiceLocationCityIn - [String!]
|
|
practiceLocationCityNotIn - [String!]
|
|
practiceLocationCityGT - String
|
|
practiceLocationCityGTE - String
|
|
practiceLocationCityLT - String
|
|
practiceLocationCityLTE - String
|
|
practiceLocationCityContains - String
|
|
practiceLocationCityHasPrefix - String
|
|
practiceLocationCityHasSuffix - String
|
|
practiceLocationCityEqualFold - String
|
|
practiceLocationCityContainsFold - String
|
|
practiceLocationState - String
|
practice_location_state field predicates |
practiceLocationStateNEQ - String
|
|
practiceLocationStateIn - [String!]
|
|
practiceLocationStateNotIn - [String!]
|
|
practiceLocationStateGT - String
|
|
practiceLocationStateGTE - String
|
|
practiceLocationStateLT - String
|
|
practiceLocationStateLTE - String
|
|
practiceLocationStateContains - String
|
|
practiceLocationStateHasPrefix - String
|
|
practiceLocationStateHasSuffix - String
|
|
practiceLocationStateEqualFold - String
|
|
practiceLocationStateContainsFold - String
|
|
practiceLocationPostalCode - String
|
practice_location_postal_code field predicates |
practiceLocationPostalCodeNEQ - String
|
|
practiceLocationPostalCodeIn - [String!]
|
|
practiceLocationPostalCodeNotIn - [String!]
|
|
practiceLocationPostalCodeGT - String
|
|
practiceLocationPostalCodeGTE - String
|
|
practiceLocationPostalCodeLT - String
|
|
practiceLocationPostalCodeLTE - String
|
|
practiceLocationPostalCodeContains - String
|
|
practiceLocationPostalCodeHasPrefix - String
|
|
practiceLocationPostalCodeHasSuffix - String
|
|
practiceLocationPostalCodeEqualFold - String
|
|
practiceLocationPostalCodeContainsFold - String
|
|
practiceLocationCountryCode - String
|
practice_location_country_code field predicates |
practiceLocationCountryCodeNEQ - String
|
|
practiceLocationCountryCodeIn - [String!]
|
|
practiceLocationCountryCodeNotIn - [String!]
|
|
practiceLocationCountryCodeGT - String
|
|
practiceLocationCountryCodeGTE - String
|
|
practiceLocationCountryCodeLT - String
|
|
practiceLocationCountryCodeLTE - String
|
|
practiceLocationCountryCodeContains - String
|
|
practiceLocationCountryCodeHasPrefix - String
|
|
practiceLocationCountryCodeHasSuffix - String
|
|
practiceLocationCountryCodeEqualFold - String
|
|
practiceLocationCountryCodeContainsFold - String
|
|
practiceLocationTelephoneNumber - String
|
practice_location_telephone_number field predicates |
practiceLocationTelephoneNumberNEQ - String
|
|
practiceLocationTelephoneNumberIn - [String!]
|
|
practiceLocationTelephoneNumberNotIn - [String!]
|
|
practiceLocationTelephoneNumberGT - String
|
|
practiceLocationTelephoneNumberGTE - String
|
|
practiceLocationTelephoneNumberLT - String
|
|
practiceLocationTelephoneNumberLTE - String
|
|
practiceLocationTelephoneNumberContains - String
|
|
practiceLocationTelephoneNumberHasPrefix - String
|
|
practiceLocationTelephoneNumberHasSuffix - String
|
|
practiceLocationTelephoneNumberEqualFold - String
|
|
practiceLocationTelephoneNumberContainsFold - String
|
|
taxonomyCode - String
|
taxonomy_code field predicates |
taxonomyCodeNEQ - String
|
|
taxonomyCodeIn - [String!]
|
|
taxonomyCodeNotIn - [String!]
|
|
taxonomyCodeGT - String
|
|
taxonomyCodeGTE - String
|
|
taxonomyCodeLT - String
|
|
taxonomyCodeLTE - String
|
|
taxonomyCodeContains - String
|
|
taxonomyCodeHasPrefix - String
|
|
taxonomyCodeHasSuffix - String
|
|
taxonomyCodeEqualFold - String
|
|
taxonomyCodeContainsFold - String
|
|
licenseNumber - String
|
license_number field predicates |
licenseNumberNEQ - String
|
|
licenseNumberIn - [String!]
|
|
licenseNumberNotIn - [String!]
|
|
licenseNumberGT - String
|
|
licenseNumberGTE - String
|
|
licenseNumberLT - String
|
|
licenseNumberLTE - String
|
|
licenseNumberContains - String
|
|
licenseNumberHasPrefix - String
|
|
licenseNumberHasSuffix - String
|
|
licenseNumberEqualFold - String
|
|
licenseNumberContainsFold - String
|
|
licenseStateCode - String
|
license_state_code field predicates |
licenseStateCodeNEQ - String
|
|
licenseStateCodeIn - [String!]
|
|
licenseStateCodeNotIn - [String!]
|
|
licenseStateCodeGT - String
|
|
licenseStateCodeGTE - String
|
|
licenseStateCodeLT - String
|
|
licenseStateCodeLTE - String
|
|
licenseStateCodeContains - String
|
|
licenseStateCodeHasPrefix - String
|
|
licenseStateCodeHasSuffix - String
|
|
licenseStateCodeEqualFold - String
|
|
licenseStateCodeContainsFold - String
|
Example
{}
PubmedAbstractEmbedding
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdAt - Time!
|
|
pubmedArticleID - ID!
|
|
pubmedAbstractID - ID!
|
|
abstract - PubmedArticleAbstract!
|
|
pubmedArticle - PubmedArticle!
|
Example
{
"id": "4",
"createdAt": "10:15:30Z",
"pubmedArticleID": "4",
"pubmedAbstractID": "4",
"abstract": PubmedArticleAbstract,
"pubmedArticle": PubmedArticle
}
PubmedAbstractEmbeddingWhereInput
Description
PubmedAbstractEmbeddingWhereInput is used for filtering PubmedAbstractEmbedding objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedAbstractEmbeddingWhereInput
|
|
and - [PubmedAbstractEmbeddingWhereInput!]
|
|
or - [PubmedAbstractEmbeddingWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
pubmedArticleID - ID
|
pubmed_article_id field predicates |
pubmedArticleIDNEQ - ID
|
|
pubmedArticleIDIn - [ID!]
|
|
pubmedArticleIDNotIn - [ID!]
|
|
pubmedAbstractID - ID
|
pubmed_abstract_id field predicates |
pubmedAbstractIDNEQ - ID
|
|
pubmedAbstractIDIn - [ID!]
|
|
pubmedAbstractIDNotIn - [ID!]
|
|
hasAbstract - Boolean
|
abstract edge predicates |
hasAbstractWith - [PubmedArticleAbstractWhereInput!]
|
|
hasPubmedArticle - Boolean
|
pubmed_article edge predicates |
hasPubmedArticleWith - [PubmedArticleWhereInput!]
|
Example
{}
PubmedArticle
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
pmid - Int!
|
The unique identifier for the article |
title - String!
|
|
journal - Journal
|
|
abstract - String
|
|
abstractCopyright - String
|
|
abstractStructured - [Abstract!]
|
|
summary - String
|
|
summaryGeneratedAt - Time
|
When the summary was generated for the article |
medline - Boolean!
|
Is the article in medline |
pmc - Boolean!
|
Is the article in PMC |
openAccess - Boolean!
|
Is the article in PMC and open access |
pmcDownloadedAt - Time
|
When the article was downloaded from PMC |
embeddingsGeneratedAt - Time
|
When the embeddings were generated for the article |
authorList - [Author!]
|
|
grantList - [Grant!]
|
|
keywordList - [String!]
|
|
articleIDList - [ArticleId!]
|
|
meshHeadingList - [MeshHeading!]
|
|
referenceList - [Reference!]
|
|
terms - [String!]
|
|
termFrequencies - Map
|
|
tokens - Int
|
The number of tokens in the title and abstract |
dateRevised - Time
|
The date the article was revised in pubmed |
dateCompleted - Time
|
The date the article was created in pubmed |
createdAt - Time!
|
When the article was created in out database |
updatedAt - Time!
|
When the article was last updated in our database |
embeddings - [PubmedAbstractEmbedding!]
|
|
abstracts - [PubmedArticleAbstract!]
|
|
sparkyQueries - [SparkyQuery!]
|
The sparky queries that reference this article |
topicClassifications - [TopicClassification!]
|
Example
{
"id": "4",
"pmid": 987,
"title": "xyz789",
"journal": Journal,
"abstract": "abc123",
"abstractCopyright": "abc123",
"abstractStructured": [Abstract],
"summary": "xyz789",
"summaryGeneratedAt": "10:15:30Z",
"medline": false,
"pmc": false,
"openAccess": true,
"pmcDownloadedAt": "10:15:30Z",
"embeddingsGeneratedAt": "10:15:30Z",
"authorList": [Author],
"grantList": [Grant],
"keywordList": ["xyz789"],
"articleIDList": [ArticleId],
"meshHeadingList": [MeshHeading],
"referenceList": [Reference],
"terms": ["xyz789"],
"termFrequencies": Map,
"tokens": 987,
"dateRevised": "10:15:30Z",
"dateCompleted": "10:15:30Z",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"embeddings": [PubmedAbstractEmbedding],
"abstracts": [PubmedArticleAbstract],
"sparkyQueries": [SparkyQuery],
"topicClassifications": [TopicClassification]
}
PubmedArticleAbstract
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
content - String!
|
|
label - String
|
|
nlmCategory - String
|
|
pubmedArticleAbstracts - ID!
|
|
embedding - PubmedAbstractEmbedding
|
|
pubmedArticle - PubmedArticle!
|
Example
{
"id": "4",
"content": "abc123",
"label": "abc123",
"nlmCategory": "abc123",
"pubmedArticleAbstracts": "4",
"embedding": PubmedAbstractEmbedding,
"pubmedArticle": PubmedArticle
}
PubmedArticleAbstractWhereInput
Description
PubmedArticleAbstractWhereInput is used for filtering PubmedArticleAbstract objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedArticleAbstractWhereInput
|
|
and - [PubmedArticleAbstractWhereInput!]
|
|
or - [PubmedArticleAbstractWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
content - String
|
content field predicates |
contentNEQ - String
|
|
contentIn - [String!]
|
|
contentNotIn - [String!]
|
|
contentGT - String
|
|
contentGTE - String
|
|
contentLT - String
|
|
contentLTE - String
|
|
contentContains - String
|
|
contentHasPrefix - String
|
|
contentHasSuffix - String
|
|
contentEqualFold - String
|
|
contentContainsFold - String
|
|
label - String
|
label field predicates |
labelNEQ - String
|
|
labelIn - [String!]
|
|
labelNotIn - [String!]
|
|
labelGT - String
|
|
labelGTE - String
|
|
labelLT - String
|
|
labelLTE - String
|
|
labelContains - String
|
|
labelHasPrefix - String
|
|
labelHasSuffix - String
|
|
labelIsNil - Boolean
|
|
labelNotNil - Boolean
|
|
labelEqualFold - String
|
|
labelContainsFold - String
|
|
nlmCategory - String
|
nlm_category field predicates |
nlmCategoryNEQ - String
|
|
nlmCategoryIn - [String!]
|
|
nlmCategoryNotIn - [String!]
|
|
nlmCategoryGT - String
|
|
nlmCategoryGTE - String
|
|
nlmCategoryLT - String
|
|
nlmCategoryLTE - String
|
|
nlmCategoryContains - String
|
|
nlmCategoryHasPrefix - String
|
|
nlmCategoryHasSuffix - String
|
|
nlmCategoryIsNil - Boolean
|
|
nlmCategoryNotNil - Boolean
|
|
nlmCategoryEqualFold - String
|
|
nlmCategoryContainsFold - String
|
|
pubmedArticleAbstracts - ID
|
pubmed_article_abstracts field predicates |
pubmedArticleAbstractsNEQ - ID
|
|
pubmedArticleAbstractsIn - [ID!]
|
|
pubmedArticleAbstractsNotIn - [ID!]
|
|
hasEmbedding - Boolean
|
embedding edge predicates |
hasEmbeddingWith - [PubmedAbstractEmbeddingWhereInput!]
|
|
hasPubmedArticle - Boolean
|
pubmed_article edge predicates |
hasPubmedArticleWith - [PubmedArticleWhereInput!]
|
Example
{}
PubmedArticleConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PubmedArticleEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [PubmedArticleEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
PubmedArticleCountDate
PubmedArticleEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - PubmedArticle
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": PubmedArticle,
"cursor": Cursor
}
PubmedArticleEmbedding
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
content - String!
|
|
createdAt - Time!
|
|
pubmedArticle - PubmedArticle
|
Example
{
"id": 4,
"content": "xyz789",
"createdAt": "10:15:30Z",
"pubmedArticle": PubmedArticle
}
PubmedArticleEmbeddingWhereInput
Description
PubmedArticleEmbeddingWhereInput is used for filtering PubmedArticleEmbedding objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedArticleEmbeddingWhereInput
|
|
and - [PubmedArticleEmbeddingWhereInput!]
|
|
or - [PubmedArticleEmbeddingWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
content - String
|
content field predicates |
contentNEQ - String
|
|
contentIn - [String!]
|
|
contentNotIn - [String!]
|
|
contentGT - String
|
|
contentGTE - String
|
|
contentLT - String
|
|
contentLTE - String
|
|
contentContains - String
|
|
contentHasPrefix - String
|
|
contentHasSuffix - String
|
|
contentEqualFold - String
|
|
contentContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasPubmedArticle - Boolean
|
pubmed_article edge predicates |
hasPubmedArticleWith - [PubmedArticleWhereInput!]
|
Example
{}
PubmedArticleOrder
Description
Ordering options for PubmedArticle connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - PubmedArticleOrderField!
|
The field by which to order PubmedArticles. |
Example
{}
PubmedArticleOrderField
Description
Properties by which PubmedArticle connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
PubmedArticleWhereInput
Description
PubmedArticleWhereInput is used for filtering PubmedArticle objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedArticleWhereInput
|
|
and - [PubmedArticleWhereInput!]
|
|
or - [PubmedArticleWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
pmid - Int
|
pmid field predicates |
pmidNEQ - Int
|
|
pmidIn - [Int!]
|
|
pmidNotIn - [Int!]
|
|
pmidGT - Int
|
|
pmidGTE - Int
|
|
pmidLT - Int
|
|
pmidLTE - Int
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
abstract - String
|
abstract field predicates |
abstractNEQ - String
|
|
abstractIn - [String!]
|
|
abstractNotIn - [String!]
|
|
abstractGT - String
|
|
abstractGTE - String
|
|
abstractLT - String
|
|
abstractLTE - String
|
|
abstractContains - String
|
|
abstractHasPrefix - String
|
|
abstractHasSuffix - String
|
|
abstractIsNil - Boolean
|
|
abstractNotNil - Boolean
|
|
abstractEqualFold - String
|
|
abstractContainsFold - String
|
|
abstractCopyright - String
|
abstract_copyright field predicates |
abstractCopyrightNEQ - String
|
|
abstractCopyrightIn - [String!]
|
|
abstractCopyrightNotIn - [String!]
|
|
abstractCopyrightGT - String
|
|
abstractCopyrightGTE - String
|
|
abstractCopyrightLT - String
|
|
abstractCopyrightLTE - String
|
|
abstractCopyrightContains - String
|
|
abstractCopyrightHasPrefix - String
|
|
abstractCopyrightHasSuffix - String
|
|
abstractCopyrightIsNil - Boolean
|
|
abstractCopyrightNotNil - Boolean
|
|
abstractCopyrightEqualFold - String
|
|
abstractCopyrightContainsFold - String
|
|
summary - String
|
summary field predicates |
summaryNEQ - String
|
|
summaryIn - [String!]
|
|
summaryNotIn - [String!]
|
|
summaryGT - String
|
|
summaryGTE - String
|
|
summaryLT - String
|
|
summaryLTE - String
|
|
summaryContains - String
|
|
summaryHasPrefix - String
|
|
summaryHasSuffix - String
|
|
summaryIsNil - Boolean
|
|
summaryNotNil - Boolean
|
|
summaryEqualFold - String
|
|
summaryContainsFold - String
|
|
summaryGeneratedAt - Time
|
summary_generated_at field predicates |
summaryGeneratedAtNEQ - Time
|
|
summaryGeneratedAtIn - [Time!]
|
|
summaryGeneratedAtNotIn - [Time!]
|
|
summaryGeneratedAtGT - Time
|
|
summaryGeneratedAtGTE - Time
|
|
summaryGeneratedAtLT - Time
|
|
summaryGeneratedAtLTE - Time
|
|
summaryGeneratedAtIsNil - Boolean
|
|
summaryGeneratedAtNotNil - Boolean
|
|
medline - Boolean
|
medline field predicates |
medlineNEQ - Boolean
|
|
pmc - Boolean
|
pmc field predicates |
pmcNEQ - Boolean
|
|
openAccess - Boolean
|
open_access field predicates |
openAccessNEQ - Boolean
|
|
pmcDownloadedAt - Time
|
pmc_downloaded_at field predicates |
pmcDownloadedAtNEQ - Time
|
|
pmcDownloadedAtIn - [Time!]
|
|
pmcDownloadedAtNotIn - [Time!]
|
|
pmcDownloadedAtGT - Time
|
|
pmcDownloadedAtGTE - Time
|
|
pmcDownloadedAtLT - Time
|
|
pmcDownloadedAtLTE - Time
|
|
pmcDownloadedAtIsNil - Boolean
|
|
pmcDownloadedAtNotNil - Boolean
|
|
embeddingsGeneratedAt - Time
|
embeddings_generated_at field predicates |
embeddingsGeneratedAtNEQ - Time
|
|
embeddingsGeneratedAtIn - [Time!]
|
|
embeddingsGeneratedAtNotIn - [Time!]
|
|
embeddingsGeneratedAtGT - Time
|
|
embeddingsGeneratedAtGTE - Time
|
|
embeddingsGeneratedAtLT - Time
|
|
embeddingsGeneratedAtLTE - Time
|
|
embeddingsGeneratedAtIsNil - Boolean
|
|
embeddingsGeneratedAtNotNil - Boolean
|
|
tokens - Int
|
tokens field predicates |
tokensNEQ - Int
|
|
tokensIn - [Int!]
|
|
tokensNotIn - [Int!]
|
|
tokensGT - Int
|
|
tokensGTE - Int
|
|
tokensLT - Int
|
|
tokensLTE - Int
|
|
tokensIsNil - Boolean
|
|
tokensNotNil - Boolean
|
|
dateRevised - Time
|
date_revised field predicates |
dateRevisedNEQ - Time
|
|
dateRevisedIn - [Time!]
|
|
dateRevisedNotIn - [Time!]
|
|
dateRevisedGT - Time
|
|
dateRevisedGTE - Time
|
|
dateRevisedLT - Time
|
|
dateRevisedLTE - Time
|
|
dateRevisedIsNil - Boolean
|
|
dateRevisedNotNil - Boolean
|
|
dateCompleted - Time
|
date_completed field predicates |
dateCompletedNEQ - Time
|
|
dateCompletedIn - [Time!]
|
|
dateCompletedNotIn - [Time!]
|
|
dateCompletedGT - Time
|
|
dateCompletedGTE - Time
|
|
dateCompletedLT - Time
|
|
dateCompletedLTE - Time
|
|
dateCompletedIsNil - Boolean
|
|
dateCompletedNotNil - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasEmbeddings - Boolean
|
embeddings edge predicates |
hasEmbeddingsWith - [PubmedAbstractEmbeddingWhereInput!]
|
|
hasAbstracts - Boolean
|
abstracts edge predicates |
hasAbstractsWith - [PubmedArticleAbstractWhereInput!]
|
|
hasSparkyQueries - Boolean
|
sparky_queries edge predicates |
hasSparkyQueriesWith - [SparkyQueryWhereInput!]
|
Example
{}
PubmedCentralArticle
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
pmcid - String!
|
The unique identifier for the article |
bioc - BioCDocument
|
|
date - Time
|
Example
{
"id": 4,
"pmcid": "xyz789",
"bioc": BioCDocument,
"date": "10:15:30Z"
}
PubmedCentralArticleWhereInput
Description
PubmedCentralArticleWhereInput is used for filtering PubmedCentralArticle objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedCentralArticleWhereInput
|
|
and - [PubmedCentralArticleWhereInput!]
|
|
or - [PubmedCentralArticleWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
pmcid - String
|
pmcid field predicates |
pmcidNEQ - String
|
|
pmcidIn - [String!]
|
|
pmcidNotIn - [String!]
|
|
pmcidGT - String
|
|
pmcidGTE - String
|
|
pmcidLT - String
|
|
pmcidLTE - String
|
|
pmcidContains - String
|
|
pmcidHasPrefix - String
|
|
pmcidHasSuffix - String
|
|
pmcidEqualFold - String
|
|
pmcidContainsFold - String
|
|
date - Time
|
date field predicates |
dateNEQ - Time
|
|
dateIn - [Time!]
|
|
dateNotIn - [Time!]
|
|
dateGT - Time
|
|
dateGTE - Time
|
|
dateLT - Time
|
|
dateLTE - Time
|
|
dateIsNil - Boolean
|
|
dateNotNil - Boolean
|
Example
{}
PubmedClusterCount
PubmedClusterCountDate
PubmedDownloadLog
PubmedDownloadLogStatus
Description
PubmedDownloadLogStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
PubmedDownloadLogWhereInput
Description
PubmedDownloadLogWhereInput is used for filtering PubmedDownloadLog objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedDownloadLogWhereInput
|
|
and - [PubmedDownloadLogWhereInput!]
|
|
or - [PubmedDownloadLogWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
ftpDate - Time
|
ftp_date field predicates |
ftpDateNEQ - Time
|
|
ftpDateIn - [Time!]
|
|
ftpDateNotIn - [Time!]
|
|
ftpDateGT - Time
|
|
ftpDateGTE - Time
|
|
ftpDateLT - Time
|
|
ftpDateLTE - Time
|
|
status - PubmedDownloadLogStatus
|
status field predicates |
statusNEQ - PubmedDownloadLogStatus
|
|
statusIn - [PubmedDownloadLogStatus!]
|
|
statusNotIn - [PubmedDownloadLogStatus!]
|
|
statusIsNil - Boolean
|
|
statusNotNil - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
completedAt - Time
|
completed_at field predicates |
completedAtNEQ - Time
|
|
completedAtIn - [Time!]
|
|
completedAtNotIn - [Time!]
|
|
completedAtGT - Time
|
|
completedAtGTE - Time
|
|
completedAtLT - Time
|
|
completedAtLTE - Time
|
Example
{}
PubmedEdge
Fields
| Field Name | Description |
|---|---|
cursor - Cursor!
|
|
node - PubmedArticle!
|
Example
{
"cursor": Cursor,
"node": PubmedArticle
}
PubmedSearchConnection
Fields
| Field Name | Description |
|---|---|
edges - [PubmedEdge]
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
Example
{
"edges": [PubmedEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PubmedTopicCluster
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
clusterID - Int!
|
|
clusterLabel - String!
|
|
label - String
|
|
clusterWords - [String!]!
|
|
pubmedArticles - [PubmedArticle!]
|
|
topics - [Topic!]
|
|
topicPubmedTopicCluster - [TopicPubmedTopicCluster!]
|
Example
{
"id": 4,
"clusterID": 123,
"clusterLabel": "xyz789",
"label": "abc123",
"clusterWords": ["xyz789"],
"pubmedArticles": [PubmedArticle],
"topics": [Topic],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
PubmedTopicClusterConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [PubmedTopicClusterEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [PubmedTopicClusterEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
PubmedTopicClusterEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - PubmedTopicCluster
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": PubmedTopicCluster,
"cursor": Cursor
}
PubmedTopicClusterWhereInput
Description
PubmedTopicClusterWhereInput is used for filtering PubmedTopicCluster objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - PubmedTopicClusterWhereInput
|
|
and - [PubmedTopicClusterWhereInput!]
|
|
or - [PubmedTopicClusterWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
clusterID - Int
|
cluster_id field predicates |
clusterIDNEQ - Int
|
|
clusterIDIn - [Int!]
|
|
clusterIDNotIn - [Int!]
|
|
clusterIDGT - Int
|
|
clusterIDGTE - Int
|
|
clusterIDLT - Int
|
|
clusterIDLTE - Int
|
|
clusterLabel - String
|
cluster_label field predicates |
clusterLabelNEQ - String
|
|
clusterLabelIn - [String!]
|
|
clusterLabelNotIn - [String!]
|
|
clusterLabelGT - String
|
|
clusterLabelGTE - String
|
|
clusterLabelLT - String
|
|
clusterLabelLTE - String
|
|
clusterLabelContains - String
|
|
clusterLabelHasPrefix - String
|
|
clusterLabelHasSuffix - String
|
|
clusterLabelEqualFold - String
|
|
clusterLabelContainsFold - String
|
|
label - String
|
label field predicates |
labelNEQ - String
|
|
labelIn - [String!]
|
|
labelNotIn - [String!]
|
|
labelGT - String
|
|
labelGTE - String
|
|
labelLT - String
|
|
labelLTE - String
|
|
labelContains - String
|
|
labelHasPrefix - String
|
|
labelHasSuffix - String
|
|
labelIsNil - Boolean
|
|
labelNotNil - Boolean
|
|
labelEqualFold - String
|
|
labelContainsFold - String
|
|
hasPubmedArticles - Boolean
|
pubmed_articles edge predicates |
hasPubmedArticlesWith - [PubmedArticleWhereInput!]
|
|
hasTopics - Boolean
|
topics edge predicates |
hasTopicsWith - [TopicWhereInput!]
|
|
hasTopicPubmedTopicCluster - Boolean
|
topic_pubmed_topic_cluster edge predicates |
hasTopicPubmedTopicClusterWith - [TopicPubmedTopicClusterWhereInput!]
|
Example
{}
Reference
ReflectionPrompt
Fields
| Field Name | Description |
|---|---|
text - String!
|
Example
{"text": "abc123"}
ReflectionResult
Fields
| Field Name | Description |
|---|---|
isLinguisticallyAcceptable - Boolean
|
|
qaPrediction - String
|
|
isToxic - Boolean
|
|
shouldEarnCredits - Boolean
|
|
totalWords - Int
|
|
isInquisitive - Boolean
|
|
isReflective - Boolean
|
|
personalProperNounCount - Int
|
|
followUpPrompt - String
|
|
medicalTermCount - Int
|
|
tags - [PartOfSpeechTag!]
|
|
allTerms - [MedicalNreResult!]
|
|
medicalTerms - [MedicalNreResult!]
|
|
sentiments - [SentimentResult!]
|
|
medicalDictionaryMatches - [MedicalDictionaryMatch!]
|
Example
{
"isLinguisticallyAcceptable": true,
"qaPrediction": "abc123",
"isToxic": false,
"shouldEarnCredits": true,
"totalWords": 123,
"isInquisitive": false,
"isReflective": true,
"personalProperNounCount": 123,
"followUpPrompt": "xyz789",
"medicalTermCount": 123,
"tags": [PartOfSpeechTag],
"allTerms": [MedicalNreResult],
"medicalTerms": [MedicalNreResult],
"sentiments": [SentimentResult],
"medicalDictionaryMatches": [MedicalDictionaryMatch]
}
RegistryResult
Example
{
"number": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"address": "xyz789",
"zip": "xyz789",
"state": "abc123",
"credential": "abc123",
"taxonomyCode": "abc123",
"taxonomyDesc": "xyz789",
"claimed": false
}
ReportReason
ReportReasonConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [ReportReasonEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [ReportReasonEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
ReportReasonEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ReportReason
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": ReportReason,
"cursor": Cursor
}
ReportReasonWhereInput
Description
ReportReasonWhereInput is used for filtering ReportReason objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - ReportReasonWhereInput
|
|
and - [ReportReasonWhereInput!]
|
|
or - [ReportReasonWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
Example
{}
Search
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
query - String!
|
The raw query that the user entered. |
normalizedQuery - String!
|
The normalized query that the user entered. |
resultsCount - Int!
|
The number of results that the search returned. |
createdAt - Time!
|
The time that the search was made. |
convertedAt - Time
|
The time that the user converted the search by clicking on a result. |
user - User
|
The user that made the search. |
conversions - [SearchConversion!]
|
The conversions that the user made from this search. |
Example
{
"id": "4",
"query": "xyz789",
"normalizedQuery": "xyz789",
"resultsCount": 987,
"createdAt": "10:15:30Z",
"convertedAt": "10:15:30Z",
"user": User,
"conversions": [SearchConversion]
}
SearchConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [SearchEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [SearchEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SearchConversion
Example
{
"id": "4",
"createdAt": "10:15:30Z",
"convertableType": "abc123",
"convertableID": 987,
"search": Search
}
SearchConversionInput
SearchConversionWhereInput
Description
SearchConversionWhereInput is used for filtering SearchConversion objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SearchConversionWhereInput
|
|
and - [SearchConversionWhereInput!]
|
|
or - [SearchConversionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
convertableType - String
|
convertable_type field predicates |
convertableTypeNEQ - String
|
|
convertableTypeIn - [String!]
|
|
convertableTypeNotIn - [String!]
|
|
convertableTypeGT - String
|
|
convertableTypeGTE - String
|
|
convertableTypeLT - String
|
|
convertableTypeLTE - String
|
|
convertableTypeContains - String
|
|
convertableTypeHasPrefix - String
|
|
convertableTypeHasSuffix - String
|
|
convertableTypeIsNil - Boolean
|
|
convertableTypeNotNil - Boolean
|
|
convertableTypeEqualFold - String
|
|
convertableTypeContainsFold - String
|
|
convertableID - Int
|
convertable_id field predicates |
convertableIDNEQ - Int
|
|
convertableIDIn - [Int!]
|
|
convertableIDNotIn - [Int!]
|
|
convertableIDGT - Int
|
|
convertableIDGTE - Int
|
|
convertableIDLT - Int
|
|
convertableIDLTE - Int
|
|
convertableIDIsNil - Boolean
|
|
convertableIDNotNil - Boolean
|
|
hasSearch - Boolean
|
search edge predicates |
hasSearchWith - [SearchWhereInput!]
|
Example
{}
SearchEdge
SearchOrder
Description
Ordering options for Search connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - SearchOrderField!
|
The field by which to order Searches. |
Example
{}
SearchOrderField
Description
Properties by which Search connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
SearchPostFilterInput
Fields
| Input Field | Description |
|---|---|
people - SearchPostFilterPeople
|
The people to include in the search results. Default is All. |
hasCE - Boolean
|
Return only posts eligible to earn CE from. |
hasVideo - Boolean
|
Return only posts that have a video. |
hasImage - Boolean
|
Return only posts that have an image(s). |
hasPoll - Boolean
|
Return only posts that have a poll. |
topicIDs - [ID!]
|
Return only posts that are in these topics. |
Example
{}
SearchPostFilterPeople
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
SearchPostOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
SearchResult
Types
| Union Types |
|---|
Example
{}
SearchResultImage
SearchResultVideo
SearchResults
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
results - [SearchResult!]!
|
Example
{"id": 4, "results": [UserSearchResult]}
SearchSuggestionResult
Fields
| Field Name | Description |
|---|---|
users - [UserSearchResult!]!
|
|
topics - [TopicSearchResult!]!
|
Example
{
"users": [UserSearchResult],
"topics": [TopicSearchResult]
}
SearchSuggestionResultV2
SearchUserFilterInput
Fields
| Input Field | Description |
|---|---|
people - SearchUserFilterPeople
|
The people to include in the search results. Default is All. |
specialtyIDs - [ID!]
|
Return only users that have this specialty. |
Example
{}
SearchUserFilterPeople
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
SearchUserOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
SearchWhereInput
Description
SearchWhereInput is used for filtering Search objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SearchWhereInput
|
|
and - [SearchWhereInput!]
|
|
or - [SearchWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
query - String
|
query field predicates |
queryNEQ - String
|
|
queryIn - [String!]
|
|
queryNotIn - [String!]
|
|
queryGT - String
|
|
queryGTE - String
|
|
queryLT - String
|
|
queryLTE - String
|
|
queryContains - String
|
|
queryHasPrefix - String
|
|
queryHasSuffix - String
|
|
queryEqualFold - String
|
|
queryContainsFold - String
|
|
normalizedQuery - String
|
normalized_query field predicates |
normalizedQueryNEQ - String
|
|
normalizedQueryIn - [String!]
|
|
normalizedQueryNotIn - [String!]
|
|
normalizedQueryGT - String
|
|
normalizedQueryGTE - String
|
|
normalizedQueryLT - String
|
|
normalizedQueryLTE - String
|
|
normalizedQueryContains - String
|
|
normalizedQueryHasPrefix - String
|
|
normalizedQueryHasSuffix - String
|
|
normalizedQueryEqualFold - String
|
|
normalizedQueryContainsFold - String
|
|
resultsCount - Int
|
results_count field predicates |
resultsCountNEQ - Int
|
|
resultsCountIn - [Int!]
|
|
resultsCountNotIn - [Int!]
|
|
resultsCountGT - Int
|
|
resultsCountGTE - Int
|
|
resultsCountLT - Int
|
|
resultsCountLTE - Int
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
convertedAt - Time
|
converted_at field predicates |
convertedAtNEQ - Time
|
|
convertedAtIn - [Time!]
|
|
convertedAtNotIn - [Time!]
|
|
convertedAtGT - Time
|
|
convertedAtGTE - Time
|
|
convertedAtLT - Time
|
|
convertedAtLTE - Time
|
|
convertedAtIsNil - Boolean
|
|
convertedAtNotNil - Boolean
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasConversions - Boolean
|
conversions edge predicates |
hasConversionsWith - [SearchConversionWhereInput!]
|
Example
{}
Sentiment
SentimentResult
SignupInput
Description
The CreateUserInput is used to create a new user
Fields
| Input Field | Description |
|---|---|
email - String
|
The user's email address. Must be unique across users |
phone - String!
|
The user's phone number. Must be unique across users |
firstName - String
|
|
lastName - String
|
|
npiNumber - String
|
The user's NPI number. Must be unique across users |
credential - String
|
The user's credential, usually MD, DO, etc |
taxonomyCode - String
|
The user's taxonomy code in the NPI database |
taxonomyDesc - String
|
The user's taxonomy description in the NPI database |
handle - String!
|
The user's username/handle. Must be unique across users |
profileImageID - Int
|
The Image ID of the user's avatar |
phoneVerificationToken - String!
|
Example
{}
SignupWithoutNPIInput
SparkyChatConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
|
suggestReflectionPrompt - String!
|
|
reflectionNudgePrompt - String!
|
|
isDefault - Boolean!
|
|
createdAt - Time!
|
|
reflectionGradingExpression - String
|
|
updatedAt - Time!
|
|
user - User
|
The user who created this prompt |
copies - SparkyChatConfig
|
The prompt this prompt was copied from |
copiedFrom - [SparkyChatConfig!]
|
|
rules - [SparkyRule!]
|
The rules for this prompt |
Example
{
"id": "4",
"name": "abc123",
"suggestReflectionPrompt": "xyz789",
"reflectionNudgePrompt": "xyz789",
"isDefault": true,
"createdAt": "10:15:30Z",
"reflectionGradingExpression": "abc123",
"updatedAt": "10:15:30Z",
"user": User,
"copies": SparkyChatConfig,
"copiedFrom": [SparkyChatConfig],
"rules": [SparkyRule]
}
SparkyChatConfigConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [SparkyChatConfigEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [SparkyChatConfigEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SparkyChatConfigEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SparkyChatConfig
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": SparkyChatConfig,
"cursor": Cursor
}
SparkyChatConfigOrder
Description
Ordering options for SparkyChatConfig connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - SparkyChatConfigOrderField!
|
The field by which to order SparkyChatConfigs. |
Example
{}
SparkyChatConfigOrderField
Description
Properties by which SparkyChatConfig connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
SparkyChatConfigWhereInput
Description
SparkyChatConfigWhereInput is used for filtering SparkyChatConfig objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyChatConfigWhereInput
|
|
and - [SparkyChatConfigWhereInput!]
|
|
or - [SparkyChatConfigWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameIsNil - Boolean
|
|
nameNotNil - Boolean
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
suggestReflectionPrompt - String
|
suggest_reflection_prompt field predicates |
suggestReflectionPromptNEQ - String
|
|
suggestReflectionPromptIn - [String!]
|
|
suggestReflectionPromptNotIn - [String!]
|
|
suggestReflectionPromptGT - String
|
|
suggestReflectionPromptGTE - String
|
|
suggestReflectionPromptLT - String
|
|
suggestReflectionPromptLTE - String
|
|
suggestReflectionPromptContains - String
|
|
suggestReflectionPromptHasPrefix - String
|
|
suggestReflectionPromptHasSuffix - String
|
|
suggestReflectionPromptEqualFold - String
|
|
suggestReflectionPromptContainsFold - String
|
|
reflectionNudgePrompt - String
|
reflection_nudge_prompt field predicates |
reflectionNudgePromptNEQ - String
|
|
reflectionNudgePromptIn - [String!]
|
|
reflectionNudgePromptNotIn - [String!]
|
|
reflectionNudgePromptGT - String
|
|
reflectionNudgePromptGTE - String
|
|
reflectionNudgePromptLT - String
|
|
reflectionNudgePromptLTE - String
|
|
reflectionNudgePromptContains - String
|
|
reflectionNudgePromptHasPrefix - String
|
|
reflectionNudgePromptHasSuffix - String
|
|
reflectionNudgePromptEqualFold - String
|
|
reflectionNudgePromptContainsFold - String
|
|
isDefault - Boolean
|
is_default field predicates |
isDefaultNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
reflectionGradingExpression - String
|
reflection_grading_expression field predicates |
reflectionGradingExpressionNEQ - String
|
|
reflectionGradingExpressionIn - [String!]
|
|
reflectionGradingExpressionNotIn - [String!]
|
|
reflectionGradingExpressionGT - String
|
|
reflectionGradingExpressionGTE - String
|
|
reflectionGradingExpressionLT - String
|
|
reflectionGradingExpressionLTE - String
|
|
reflectionGradingExpressionContains - String
|
|
reflectionGradingExpressionHasPrefix - String
|
|
reflectionGradingExpressionHasSuffix - String
|
|
reflectionGradingExpressionIsNil - Boolean
|
|
reflectionGradingExpressionNotNil - Boolean
|
|
reflectionGradingExpressionEqualFold - String
|
|
reflectionGradingExpressionContainsFold - String
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasCopies - Boolean
|
copies edge predicates |
hasCopiesWith - [SparkyChatConfigWhereInput!]
|
|
hasCopiedFrom - Boolean
|
copied_from edge predicates |
hasCopiedFromWith - [SparkyChatConfigWhereInput!]
|
|
hasRules - Boolean
|
rules edge predicates |
hasRulesWith - [SparkyRuleWhereInput!]
|
Example
{}
SparkyConversation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
demo - Boolean!
|
Whether this is a demo conversation. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
startedFrom - SparkyConversationStartedFrom!
|
The entity this conversation was started from. Used to determine which entity to link to when displaying the conversation. |
config - SparkyChatConfig
|
The configuration for this conversation. |
tenant - Tenant
|
|
user - User!
|
The user who started this conversation. |
comment - Comment
|
The comment this conversation was started from. |
post - Post
|
The post this conversation was started from. |
collection - [Collection!]
|
The collection of posts this conversation was started from. |
video - Video
|
The video this conversation was started from |
messages - [SparkyMessage!]
|
The messages in this conversation. |
educationCredit - EducationCredit
|
Example
{
"id": "4",
"demo": false,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"startedFrom": "post",
"config": SparkyChatConfig,
"tenant": Tenant,
"user": User,
"comment": Comment,
"post": Post,
"collection": [Collection],
"video": Video,
"messages": [SparkyMessage],
"educationCredit": EducationCredit
}
SparkyConversationConfigSet
Example
{
"id": 4,
"name": "abc123",
"config": Map,
"isDefault": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User
}
SparkyConversationConfigSetWhereInput
Description
SparkyConversationConfigSetWhereInput is used for filtering SparkyConversationConfigSet objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyConversationConfigSetWhereInput
|
|
and - [SparkyConversationConfigSetWhereInput!]
|
|
or - [SparkyConversationConfigSetWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
isDefault - Boolean
|
is_default field predicates |
isDefaultNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
SparkyConversationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [SparkyConversationEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [SparkyConversationEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SparkyConversationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SparkyConversation
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": SparkyConversation,
"cursor": Cursor
}
SparkyConversationOrder
Description
Ordering options for SparkyConversation connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - SparkyConversationOrderField!
|
The field by which to order SparkyConversations. |
Example
{}
SparkyConversationOrderField
Description
Properties by which SparkyConversation connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
SparkyConversationStartedFrom
Description
SparkyConversationStartedFrom is enum for the field started_from
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
SparkyConversationWhereInput
Description
SparkyConversationWhereInput is used for filtering SparkyConversation objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyConversationWhereInput
|
|
and - [SparkyConversationWhereInput!]
|
|
or - [SparkyConversationWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
demo - Boolean
|
demo field predicates |
demoNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
startedFrom - SparkyConversationStartedFrom
|
started_from field predicates |
startedFromNEQ - SparkyConversationStartedFrom
|
|
startedFromIn - [SparkyConversationStartedFrom!]
|
|
startedFromNotIn - [SparkyConversationStartedFrom!]
|
|
hasConfig - Boolean
|
config edge predicates |
hasConfigWith - [SparkyChatConfigWhereInput!]
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasComment - Boolean
|
comment edge predicates |
hasCommentWith - [CommentWhereInput!]
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
|
hasCollection - Boolean
|
collection edge predicates |
hasCollectionWith - [CollectionWhereInput!]
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
|
hasMessages - Boolean
|
messages edge predicates |
hasMessagesWith - [SparkyMessageWhereInput!]
|
|
hasEducationCredit - Boolean
|
education_credit edge predicates |
hasEducationCreditWith - [EducationCreditWhereInput!]
|
Example
{}
SparkyInsights
SparkyMessage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
body - String!
|
|
sentBySparky - Boolean!
|
|
invalidMessage - Boolean!
|
|
shouldEarnCredits - Boolean!
|
|
reflectionAnalysisResultsV1 - ReflectionResult
|
The results of the reflection analysis |
createdAt - Time!
|
|
updatedAt - Time!
|
|
promptValue - String
|
The value of the prompt that was used to generate this message |
conversation - SparkyConversation
|
|
addendum - [SparkyMessageAddendum!]!
|
Example
{
"id": 4,
"body": "abc123",
"sentBySparky": true,
"invalidMessage": false,
"shouldEarnCredits": true,
"reflectionAnalysisResultsV1": ReflectionResult,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"promptValue": "abc123",
"conversation": SparkyConversation,
"addendum": [SparkyMessageAddendum]
}
SparkyMessageAddendum
SparkyMessageWhereInput
Description
SparkyMessageWhereInput is used for filtering SparkyMessage objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyMessageWhereInput
|
|
and - [SparkyMessageWhereInput!]
|
|
or - [SparkyMessageWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
body - String
|
body field predicates |
bodyNEQ - String
|
|
bodyIn - [String!]
|
|
bodyNotIn - [String!]
|
|
bodyGT - String
|
|
bodyGTE - String
|
|
bodyLT - String
|
|
bodyLTE - String
|
|
bodyContains - String
|
|
bodyHasPrefix - String
|
|
bodyHasSuffix - String
|
|
bodyEqualFold - String
|
|
bodyContainsFold - String
|
|
sentBySparky - Boolean
|
sent_by_sparky field predicates |
sentBySparkyNEQ - Boolean
|
|
invalidMessage - Boolean
|
invalid_message field predicates |
invalidMessageNEQ - Boolean
|
|
shouldEarnCredits - Boolean
|
should_earn_credits field predicates |
shouldEarnCreditsNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
promptValue - String
|
prompt_value field predicates |
promptValueNEQ - String
|
|
promptValueIn - [String!]
|
|
promptValueNotIn - [String!]
|
|
promptValueGT - String
|
|
promptValueGTE - String
|
|
promptValueLT - String
|
|
promptValueLTE - String
|
|
promptValueContains - String
|
|
promptValueHasPrefix - String
|
|
promptValueHasSuffix - String
|
|
promptValueIsNil - Boolean
|
|
promptValueNotNil - Boolean
|
|
promptValueEqualFold - String
|
|
promptValueContainsFold - String
|
|
hasConversation - Boolean
|
conversation edge predicates |
hasConversationWith - [SparkyConversationWhereInput!]
|
Example
{}
SparkyPrompt
Example
{
"id": "4",
"key": "abc123",
"label": "xyz789",
"prompt": "xyz789",
"isDefault": true,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User
}
SparkyPromptConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [SparkyPromptEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [SparkyPromptEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
SparkyPromptEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SparkyPrompt
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": SparkyPrompt,
"cursor": Cursor
}
SparkyPromptOrder
Description
Ordering options for SparkyPrompt connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - SparkyPromptOrderField!
|
The field by which to order SparkyPrompts. |
Example
{}
SparkyPromptOrderField
Description
Properties by which SparkyPrompt connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
SparkyPromptWhereInput
Description
SparkyPromptWhereInput is used for filtering SparkyPrompt objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyPromptWhereInput
|
|
and - [SparkyPromptWhereInput!]
|
|
or - [SparkyPromptWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
key - String
|
key field predicates |
keyNEQ - String
|
|
keyIn - [String!]
|
|
keyNotIn - [String!]
|
|
keyGT - String
|
|
keyGTE - String
|
|
keyLT - String
|
|
keyLTE - String
|
|
keyContains - String
|
|
keyHasPrefix - String
|
|
keyHasSuffix - String
|
|
keyEqualFold - String
|
|
keyContainsFold - String
|
|
label - String
|
label field predicates |
labelNEQ - String
|
|
labelIn - [String!]
|
|
labelNotIn - [String!]
|
|
labelGT - String
|
|
labelGTE - String
|
|
labelLT - String
|
|
labelLTE - String
|
|
labelContains - String
|
|
labelHasPrefix - String
|
|
labelHasSuffix - String
|
|
labelEqualFold - String
|
|
labelContainsFold - String
|
|
prompt - String
|
prompt field predicates |
promptNEQ - String
|
|
promptIn - [String!]
|
|
promptNotIn - [String!]
|
|
promptGT - String
|
|
promptGTE - String
|
|
promptLT - String
|
|
promptLTE - String
|
|
promptContains - String
|
|
promptHasPrefix - String
|
|
promptHasSuffix - String
|
|
promptEqualFold - String
|
|
promptContainsFold - String
|
|
isDefault - Boolean
|
is_default field predicates |
isDefaultNEQ - Boolean
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
SparkyQuery
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
query - String!
|
|
stepBackPrompt - String
|
|
stepBackResponse - String
|
|
hydePrompt - String
|
|
hydeResponse - String
|
|
step - SparkyQueryStep!
|
|
candidateIds - [String!]!
|
|
rankedCandidateIds - [String!]!
|
|
prompt - String
|
|
tokens - Int
|
|
draftResponse - String
|
|
finalResponse - String
|
|
createdAt - Time!
|
|
updatedAt - Time!
|
|
completedAt - Time
|
|
user - User
|
The user who created this prompt |
references - [PubmedArticle!]
|
Example
{
"id": 4,
"query": "xyz789",
"stepBackPrompt": "abc123",
"stepBackResponse": "xyz789",
"hydePrompt": "abc123",
"hydeResponse": "abc123",
"step": "query",
"candidateIds": ["xyz789"],
"rankedCandidateIds": ["abc123"],
"prompt": "xyz789",
"tokens": 987,
"draftResponse": "xyz789",
"finalResponse": "xyz789",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"completedAt": "10:15:30Z",
"user": User,
"references": [PubmedArticle]
}
SparkyQueryConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [SparkyQueryEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [SparkyQueryEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
SparkyQueryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SparkyQuery
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": SparkyQuery,
"cursor": Cursor
}
SparkyQueryStep
Description
SparkyQueryStep is enum for the field step
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
SparkyQueryWhereInput
Description
SparkyQueryWhereInput is used for filtering SparkyQuery objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyQueryWhereInput
|
|
and - [SparkyQueryWhereInput!]
|
|
or - [SparkyQueryWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
query - String
|
query field predicates |
queryNEQ - String
|
|
queryIn - [String!]
|
|
queryNotIn - [String!]
|
|
queryGT - String
|
|
queryGTE - String
|
|
queryLT - String
|
|
queryLTE - String
|
|
queryContains - String
|
|
queryHasPrefix - String
|
|
queryHasSuffix - String
|
|
queryEqualFold - String
|
|
queryContainsFold - String
|
|
stepBackPrompt - String
|
step_back_prompt field predicates |
stepBackPromptNEQ - String
|
|
stepBackPromptIn - [String!]
|
|
stepBackPromptNotIn - [String!]
|
|
stepBackPromptGT - String
|
|
stepBackPromptGTE - String
|
|
stepBackPromptLT - String
|
|
stepBackPromptLTE - String
|
|
stepBackPromptContains - String
|
|
stepBackPromptHasPrefix - String
|
|
stepBackPromptHasSuffix - String
|
|
stepBackPromptIsNil - Boolean
|
|
stepBackPromptNotNil - Boolean
|
|
stepBackPromptEqualFold - String
|
|
stepBackPromptContainsFold - String
|
|
stepBackResponse - String
|
step_back_response field predicates |
stepBackResponseNEQ - String
|
|
stepBackResponseIn - [String!]
|
|
stepBackResponseNotIn - [String!]
|
|
stepBackResponseGT - String
|
|
stepBackResponseGTE - String
|
|
stepBackResponseLT - String
|
|
stepBackResponseLTE - String
|
|
stepBackResponseContains - String
|
|
stepBackResponseHasPrefix - String
|
|
stepBackResponseHasSuffix - String
|
|
stepBackResponseIsNil - Boolean
|
|
stepBackResponseNotNil - Boolean
|
|
stepBackResponseEqualFold - String
|
|
stepBackResponseContainsFold - String
|
|
hydePrompt - String
|
hyde_prompt field predicates |
hydePromptNEQ - String
|
|
hydePromptIn - [String!]
|
|
hydePromptNotIn - [String!]
|
|
hydePromptGT - String
|
|
hydePromptGTE - String
|
|
hydePromptLT - String
|
|
hydePromptLTE - String
|
|
hydePromptContains - String
|
|
hydePromptHasPrefix - String
|
|
hydePromptHasSuffix - String
|
|
hydePromptIsNil - Boolean
|
|
hydePromptNotNil - Boolean
|
|
hydePromptEqualFold - String
|
|
hydePromptContainsFold - String
|
|
hydeResponse - String
|
hyde_response field predicates |
hydeResponseNEQ - String
|
|
hydeResponseIn - [String!]
|
|
hydeResponseNotIn - [String!]
|
|
hydeResponseGT - String
|
|
hydeResponseGTE - String
|
|
hydeResponseLT - String
|
|
hydeResponseLTE - String
|
|
hydeResponseContains - String
|
|
hydeResponseHasPrefix - String
|
|
hydeResponseHasSuffix - String
|
|
hydeResponseIsNil - Boolean
|
|
hydeResponseNotNil - Boolean
|
|
hydeResponseEqualFold - String
|
|
hydeResponseContainsFold - String
|
|
step - SparkyQueryStep
|
step field predicates |
stepNEQ - SparkyQueryStep
|
|
stepIn - [SparkyQueryStep!]
|
|
stepNotIn - [SparkyQueryStep!]
|
|
prompt - String
|
prompt field predicates |
promptNEQ - String
|
|
promptIn - [String!]
|
|
promptNotIn - [String!]
|
|
promptGT - String
|
|
promptGTE - String
|
|
promptLT - String
|
|
promptLTE - String
|
|
promptContains - String
|
|
promptHasPrefix - String
|
|
promptHasSuffix - String
|
|
promptIsNil - Boolean
|
|
promptNotNil - Boolean
|
|
promptEqualFold - String
|
|
promptContainsFold - String
|
|
tokens - Int
|
tokens field predicates |
tokensNEQ - Int
|
|
tokensIn - [Int!]
|
|
tokensNotIn - [Int!]
|
|
tokensGT - Int
|
|
tokensGTE - Int
|
|
tokensLT - Int
|
|
tokensLTE - Int
|
|
tokensIsNil - Boolean
|
|
tokensNotNil - Boolean
|
|
draftResponse - String
|
draft_response field predicates |
draftResponseNEQ - String
|
|
draftResponseIn - [String!]
|
|
draftResponseNotIn - [String!]
|
|
draftResponseGT - String
|
|
draftResponseGTE - String
|
|
draftResponseLT - String
|
|
draftResponseLTE - String
|
|
draftResponseContains - String
|
|
draftResponseHasPrefix - String
|
|
draftResponseHasSuffix - String
|
|
draftResponseIsNil - Boolean
|
|
draftResponseNotNil - Boolean
|
|
draftResponseEqualFold - String
|
|
draftResponseContainsFold - String
|
|
finalResponse - String
|
final_response field predicates |
finalResponseNEQ - String
|
|
finalResponseIn - [String!]
|
|
finalResponseNotIn - [String!]
|
|
finalResponseGT - String
|
|
finalResponseGTE - String
|
|
finalResponseLT - String
|
|
finalResponseLTE - String
|
|
finalResponseContains - String
|
|
finalResponseHasPrefix - String
|
|
finalResponseHasSuffix - String
|
|
finalResponseIsNil - Boolean
|
|
finalResponseNotNil - Boolean
|
|
finalResponseEqualFold - String
|
|
finalResponseContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
completedAt - Time
|
completed_at field predicates |
completedAtNEQ - Time
|
|
completedAtIn - [Time!]
|
|
completedAtNotIn - [Time!]
|
|
completedAtGT - Time
|
|
completedAtGTE - Time
|
|
completedAtLT - Time
|
|
completedAtLTE - Time
|
|
completedAtIsNil - Boolean
|
|
completedAtNotNil - Boolean
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasReferences - Boolean
|
references edge predicates |
hasReferencesWith - [PubmedArticleWhereInput!]
|
Example
{}
SparkyRule
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
|
conditions - [SparkyRuleCondition!]
|
The conditions for this rule |
config - SparkyChatConfig
|
The config this rule belongs to |
Example
{
"id": 4,
"name": "xyz789",
"conditions": [SparkyRuleCondition],
"config": SparkyChatConfig
}
SparkyRuleCondition
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
operator - SparkyRuleConditionOperator!
|
|
name - String!
|
|
value - String!
|
|
type - SparkyRuleConditionType!
|
|
rule - SparkyRule
|
The rule this condition belongs to |
Example
{
"id": "4",
"operator": "eq",
"name": "abc123",
"value": "xyz789",
"type": "number",
"rule": SparkyRule
}
SparkyRuleConditionInput
SparkyRuleConditionOperator
Description
SparkyRuleConditionOperator is enum for the field operator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
SparkyRuleConditionType
Description
SparkyRuleConditionType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
SparkyRuleConditionWhereInput
Description
SparkyRuleConditionWhereInput is used for filtering SparkyRuleCondition objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyRuleConditionWhereInput
|
|
and - [SparkyRuleConditionWhereInput!]
|
|
or - [SparkyRuleConditionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
operator - SparkyRuleConditionOperator
|
operator field predicates |
operatorNEQ - SparkyRuleConditionOperator
|
|
operatorIn - [SparkyRuleConditionOperator!]
|
|
operatorNotIn - [SparkyRuleConditionOperator!]
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
value - String
|
value field predicates |
valueNEQ - String
|
|
valueIn - [String!]
|
|
valueNotIn - [String!]
|
|
valueGT - String
|
|
valueGTE - String
|
|
valueLT - String
|
|
valueLTE - String
|
|
valueContains - String
|
|
valueHasPrefix - String
|
|
valueHasSuffix - String
|
|
valueEqualFold - String
|
|
valueContainsFold - String
|
|
type - SparkyRuleConditionType
|
type field predicates |
typeNEQ - SparkyRuleConditionType
|
|
typeIn - [SparkyRuleConditionType!]
|
|
typeNotIn - [SparkyRuleConditionType!]
|
|
hasRule - Boolean
|
rule edge predicates |
hasRuleWith - [SparkyRuleWhereInput!]
|
Example
{}
SparkyRuleField
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
value - String!
|
|
type - SparkyRuleFieldType!
|
Example
{
"id": "4",
"name": "xyz789",
"value": "abc123",
"type": "string"
}
SparkyRuleFieldType
Description
SparkyRuleFieldType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
SparkyRuleFieldWhereInput
Description
SparkyRuleFieldWhereInput is used for filtering SparkyRuleField objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyRuleFieldWhereInput
|
|
and - [SparkyRuleFieldWhereInput!]
|
|
or - [SparkyRuleFieldWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
value - String
|
value field predicates |
valueNEQ - String
|
|
valueIn - [String!]
|
|
valueNotIn - [String!]
|
|
valueGT - String
|
|
valueGTE - String
|
|
valueLT - String
|
|
valueLTE - String
|
|
valueContains - String
|
|
valueHasPrefix - String
|
|
valueHasSuffix - String
|
|
valueEqualFold - String
|
|
valueContainsFold - String
|
|
type - SparkyRuleFieldType
|
type field predicates |
typeNEQ - SparkyRuleFieldType
|
|
typeIn - [SparkyRuleFieldType!]
|
|
typeNotIn - [SparkyRuleFieldType!]
|
Example
{}
SparkyRuleInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String
|
|
conditions - [SparkyRuleConditionInput!]!
|
Example
{}
SparkyRuleWhereInput
Description
SparkyRuleWhereInput is used for filtering SparkyRule objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - SparkyRuleWhereInput
|
|
and - [SparkyRuleWhereInput!]
|
|
or - [SparkyRuleWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameIsNil - Boolean
|
|
nameNotNil - Boolean
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
hasConditions - Boolean
|
conditions edge predicates |
hasConditionsWith - [SparkyRuleConditionWhereInput!]
|
|
hasConfig - Boolean
|
config edge predicates |
hasConfigWith - [SparkyChatConfigWhereInput!]
|
Example
{}
SparkyTestMessage
SparkyTestRuleResult
Fields
| Field Name | Description |
|---|---|
shouldEarnCredits - Boolean!
|
|
result - ReflectionResult!
|
|
messages - [SparkyTestMessage!]!
|
Example
{
"shouldEarnCredits": false,
"result": ReflectionResult,
"messages": [SparkyTestMessage]
}
SpeakInsightResult
String
Description
The Stringscalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
{}
SubmitVerificationRequestInput
TableData
Fields
| Field Name | Description |
|---|---|
columns - [TableDataColumn!]!
|
|
rowData - [String!]!
|
|
sortField - String
|
|
sortDirection - String
|
Example
{
"columns": [TableDataColumn],
"rowData": ["abc123"],
"sortField": "xyz789",
"sortDirection": "xyz789"
}
TableDataColumn
TableSeries
Fields
| Field Name | Description |
|---|---|
series - [TableSeriesItem!]!
|
Example
{"series": [TableSeriesItem]}
TableSeriesItem
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
data - TableData!
|
Example
{
"name": "abc123",
"data": TableData
}
Tag
TagConnection
Description
A connection to a list of items.
Example
{
"edges": [TagEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TagEdge
TagWhereInput
Description
TagWhereInput is used for filtering Tag objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TagWhereInput
|
|
and - [TagWhereInput!]
|
|
or - [TagWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
value - String
|
value field predicates |
valueNEQ - String
|
|
valueIn - [String!]
|
|
valueNotIn - [String!]
|
|
valueGT - String
|
|
valueGTE - String
|
|
valueLT - String
|
|
valueLTE - String
|
|
valueContains - String
|
|
valueHasPrefix - String
|
|
valueHasSuffix - String
|
|
valueEqualFold - String
|
|
valueContainsFold - String
|
|
count - Int
|
count field predicates |
countNEQ - Int
|
|
countIn - [Int!]
|
|
countNotIn - [Int!]
|
|
countGT - Int
|
|
countGTE - Int
|
|
countLT - Int
|
|
countLTE - Int
|
|
hasTaggedPosts - Boolean
|
tagged_posts edge predicates |
hasTaggedPostsWith - [PostWhereInput!]
|
Example
{}
Tenant
TenantWhereInput
Description
TenantWhereInput is used for filtering Tenant objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TenantWhereInput
|
|
and - [TenantWhereInput!]
|
|
or - [TenantWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
default - Boolean
|
default field predicates |
defaultNEQ - Boolean
|
|
hasUsers - Boolean
|
users edge predicates |
hasUsersWith - [UserWhereInput!]
|
Example
{}
Time
Description
The builtin Time type
Example
{}
Topic
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
The name of the topic. |
ordinal - Int!
|
The ordinal of the topic. |
type - TopicType!
|
The type of the topic. |
modelID - String
|
|
modelVersion - String
|
|
totalPosts - Int!
|
The total number of posts that are tagged with the topic. |
words - [String!]
|
|
wordFrequencies - Map
|
|
generatedLabel - String
|
|
clusterID - Int
|
|
clusterLabel - String
|
|
tenant - Tenant
|
The tenant that the topic belongs to. |
cover - MediaItem
|
The cover image of the topic. |
coverImage - Image
|
The cover image of the topic. |
users - [User!]
|
The users that are subscribed to the topic. |
classifications - [TopicClassification!]
|
The classifications of the topic. |
posts - [Post!]
|
The posts that are tagged with the topic. |
pubmedArticles - [PubmedArticle!]
|
The articles that are tagged with the topic. |
npiTaxonomies - [NpiTaxonomy!]
|
The NPI taxonomies that are tagged with the topic. |
parent - Topic
|
The children topics of the topic. |
children - [Topic!]
|
|
pubmedTopicClusters - [PubmedTopicCluster!]
|
|
topicNpiTaxonomies - [TopicNpiTaxonomy!]
|
|
topicPubmedTopicCluster - [TopicPubmedTopicCluster!]
|
Example
{
"id": 4,
"name": "abc123",
"ordinal": 987,
"type": "specialty",
"modelID": "abc123",
"modelVersion": "abc123",
"totalPosts": 987,
"words": ["xyz789"],
"wordFrequencies": Map,
"generatedLabel": "xyz789",
"clusterID": 987,
"clusterLabel": "abc123",
"tenant": Tenant,
"cover": MediaItem,
"coverImage": Image,
"users": [User],
"classifications": [TopicClassification],
"posts": [Post],
"pubmedArticles": [PubmedArticle],
"npiTaxonomies": [NpiTaxonomy],
"parent": Topic,
"children": [Topic],
"pubmedTopicClusters": [PubmedTopicCluster],
"topicNpiTaxonomies": [TopicNpiTaxonomy],
"topicPubmedTopicCluster": [TopicPubmedTopicCluster]
}
TopicClassification
Example
{
"id": 4,
"topicID": "4",
"entityID": 123,
"entityType": "abc123",
"modelVersion": "abc123",
"suggested": false,
"active": true,
"score": 987.65,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"topic": Topic
}
TopicClassificationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TopicClassificationEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [TopicClassificationEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
TopicClassificationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - TopicClassification
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": TopicClassification,
"cursor": Cursor
}
TopicClassificationWhereInput
Description
TopicClassificationWhereInput is used for filtering TopicClassification objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TopicClassificationWhereInput
|
|
and - [TopicClassificationWhereInput!]
|
|
or - [TopicClassificationWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
topicID - ID
|
topic_id field predicates |
topicIDNEQ - ID
|
|
topicIDIn - [ID!]
|
|
topicIDNotIn - [ID!]
|
|
entityID - Int
|
entity_id field predicates |
entityIDNEQ - Int
|
|
entityIDIn - [Int!]
|
|
entityIDNotIn - [Int!]
|
|
entityIDGT - Int
|
|
entityIDGTE - Int
|
|
entityIDLT - Int
|
|
entityIDLTE - Int
|
|
entityType - String
|
entity_type field predicates |
entityTypeNEQ - String
|
|
entityTypeIn - [String!]
|
|
entityTypeNotIn - [String!]
|
|
entityTypeGT - String
|
|
entityTypeGTE - String
|
|
entityTypeLT - String
|
|
entityTypeLTE - String
|
|
entityTypeContains - String
|
|
entityTypeHasPrefix - String
|
|
entityTypeHasSuffix - String
|
|
entityTypeEqualFold - String
|
|
entityTypeContainsFold - String
|
|
modelVersion - String
|
model_version field predicates |
modelVersionNEQ - String
|
|
modelVersionIn - [String!]
|
|
modelVersionNotIn - [String!]
|
|
modelVersionGT - String
|
|
modelVersionGTE - String
|
|
modelVersionLT - String
|
|
modelVersionLTE - String
|
|
modelVersionContains - String
|
|
modelVersionHasPrefix - String
|
|
modelVersionHasSuffix - String
|
|
modelVersionIsNil - Boolean
|
|
modelVersionNotNil - Boolean
|
|
modelVersionEqualFold - String
|
|
modelVersionContainsFold - String
|
|
suggested - Boolean
|
suggested field predicates |
suggestedNEQ - Boolean
|
|
active - Boolean
|
active field predicates |
activeNEQ - Boolean
|
|
score - Float
|
score field predicates |
scoreNEQ - Float
|
|
scoreIn - [Float!]
|
|
scoreNotIn - [Float!]
|
|
scoreGT - Float
|
|
scoreGTE - Float
|
|
scoreLT - Float
|
|
scoreLTE - Float
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasTopic - Boolean
|
topic edge predicates |
hasTopicWith - [TopicWhereInput!]
|
Example
{}
TopicCluster
Example
{
"id": 4,
"modelID": "abc123",
"label": "abc123",
"generatedLabel": "xyz789",
"clusterID": 987,
"clusterLabel": "abc123",
"words": ["xyz789"],
"wordFrequencies": Map
}
TopicClusterConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TopicClusterEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [TopicClusterEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TopicClusterEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - TopicCluster
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": TopicCluster,
"cursor": Cursor
}
TopicClusterWhereInput
Description
TopicClusterWhereInput is used for filtering TopicCluster objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TopicClusterWhereInput
|
|
and - [TopicClusterWhereInput!]
|
|
or - [TopicClusterWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
modelID - String
|
model_id field predicates |
modelIDNEQ - String
|
|
modelIDIn - [String!]
|
|
modelIDNotIn - [String!]
|
|
modelIDGT - String
|
|
modelIDGTE - String
|
|
modelIDLT - String
|
|
modelIDLTE - String
|
|
modelIDContains - String
|
|
modelIDHasPrefix - String
|
|
modelIDHasSuffix - String
|
|
modelIDEqualFold - String
|
|
modelIDContainsFold - String
|
|
label - String
|
label field predicates |
labelNEQ - String
|
|
labelIn - [String!]
|
|
labelNotIn - [String!]
|
|
labelGT - String
|
|
labelGTE - String
|
|
labelLT - String
|
|
labelLTE - String
|
|
labelContains - String
|
|
labelHasPrefix - String
|
|
labelHasSuffix - String
|
|
labelIsNil - Boolean
|
|
labelNotNil - Boolean
|
|
labelEqualFold - String
|
|
labelContainsFold - String
|
|
generatedLabel - String
|
generated_label field predicates |
generatedLabelNEQ - String
|
|
generatedLabelIn - [String!]
|
|
generatedLabelNotIn - [String!]
|
|
generatedLabelGT - String
|
|
generatedLabelGTE - String
|
|
generatedLabelLT - String
|
|
generatedLabelLTE - String
|
|
generatedLabelContains - String
|
|
generatedLabelHasPrefix - String
|
|
generatedLabelHasSuffix - String
|
|
generatedLabelIsNil - Boolean
|
|
generatedLabelNotNil - Boolean
|
|
generatedLabelEqualFold - String
|
|
generatedLabelContainsFold - String
|
|
clusterID - Int
|
cluster_id field predicates |
clusterIDNEQ - Int
|
|
clusterIDIn - [Int!]
|
|
clusterIDNotIn - [Int!]
|
|
clusterIDGT - Int
|
|
clusterIDGTE - Int
|
|
clusterIDLT - Int
|
|
clusterIDLTE - Int
|
|
clusterLabel - String
|
cluster_label field predicates |
clusterLabelNEQ - String
|
|
clusterLabelIn - [String!]
|
|
clusterLabelNotIn - [String!]
|
|
clusterLabelGT - String
|
|
clusterLabelGTE - String
|
|
clusterLabelLT - String
|
|
clusterLabelLTE - String
|
|
clusterLabelContains - String
|
|
clusterLabelHasPrefix - String
|
|
clusterLabelHasSuffix - String
|
|
clusterLabelEqualFold - String
|
|
clusterLabelContainsFold - String
|
Example
{}
TopicConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [TopicEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [TopicEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
TopicEdge
TopicNpiTaxonomy
Example
{
"id": 4,
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"topicID": "4",
"npiTaxonomyID": "4",
"topic": Topic,
"npiTaxonomy": NpiTaxonomy
}
TopicNpiTaxonomyWhereInput
Description
TopicNpiTaxonomyWhereInput is used for filtering TopicNpiTaxonomy objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TopicNpiTaxonomyWhereInput
|
|
and - [TopicNpiTaxonomyWhereInput!]
|
|
or - [TopicNpiTaxonomyWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
TopicOrder
Description
Ordering options for Topic connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - TopicOrderField!
|
The field by which to order Topics. |
Example
{}
TopicOrderField
Description
Properties by which Topic connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
TopicPubmedTopicCluster
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
topicID - ID!
|
|
pubmedTopicClusterID - ID!
|
|
topic - Topic!
|
|
pubmedTopicCluster - PubmedTopicCluster!
|
Example
{
"id": 4,
"topicID": "4",
"pubmedTopicClusterID": "4",
"topic": Topic,
"pubmedTopicCluster": PubmedTopicCluster
}
TopicPubmedTopicClusterWhereInput
Description
TopicPubmedTopicClusterWhereInput is used for filtering TopicPubmedTopicCluster objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TopicPubmedTopicClusterWhereInput
|
|
and - [TopicPubmedTopicClusterWhereInput!]
|
|
or - [TopicPubmedTopicClusterWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
Example
{}
TopicSearchResult
TopicType
Description
TopicType is enum for the field type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
TopicWhereInput
Description
TopicWhereInput is used for filtering Topic objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TopicWhereInput
|
|
and - [TopicWhereInput!]
|
|
or - [TopicWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
ordinal - Int
|
ordinal field predicates |
ordinalNEQ - Int
|
|
ordinalIn - [Int!]
|
|
ordinalNotIn - [Int!]
|
|
ordinalGT - Int
|
|
ordinalGTE - Int
|
|
ordinalLT - Int
|
|
ordinalLTE - Int
|
|
type - TopicType
|
type field predicates |
typeNEQ - TopicType
|
|
typeIn - [TopicType!]
|
|
typeNotIn - [TopicType!]
|
|
modelID - String
|
model_id field predicates |
modelIDNEQ - String
|
|
modelIDIn - [String!]
|
|
modelIDNotIn - [String!]
|
|
modelIDGT - String
|
|
modelIDGTE - String
|
|
modelIDLT - String
|
|
modelIDLTE - String
|
|
modelIDContains - String
|
|
modelIDHasPrefix - String
|
|
modelIDHasSuffix - String
|
|
modelIDIsNil - Boolean
|
|
modelIDNotNil - Boolean
|
|
modelIDEqualFold - String
|
|
modelIDContainsFold - String
|
|
modelVersion - String
|
model_version field predicates |
modelVersionNEQ - String
|
|
modelVersionIn - [String!]
|
|
modelVersionNotIn - [String!]
|
|
modelVersionGT - String
|
|
modelVersionGTE - String
|
|
modelVersionLT - String
|
|
modelVersionLTE - String
|
|
modelVersionContains - String
|
|
modelVersionHasPrefix - String
|
|
modelVersionHasSuffix - String
|
|
modelVersionIsNil - Boolean
|
|
modelVersionNotNil - Boolean
|
|
modelVersionEqualFold - String
|
|
modelVersionContainsFold - String
|
|
totalPosts - Int
|
total_posts field predicates |
totalPostsNEQ - Int
|
|
totalPostsIn - [Int!]
|
|
totalPostsNotIn - [Int!]
|
|
totalPostsGT - Int
|
|
totalPostsGTE - Int
|
|
totalPostsLT - Int
|
|
totalPostsLTE - Int
|
|
generatedLabel - String
|
generated_label field predicates |
generatedLabelNEQ - String
|
|
generatedLabelIn - [String!]
|
|
generatedLabelNotIn - [String!]
|
|
generatedLabelGT - String
|
|
generatedLabelGTE - String
|
|
generatedLabelLT - String
|
|
generatedLabelLTE - String
|
|
generatedLabelContains - String
|
|
generatedLabelHasPrefix - String
|
|
generatedLabelHasSuffix - String
|
|
generatedLabelIsNil - Boolean
|
|
generatedLabelNotNil - Boolean
|
|
generatedLabelEqualFold - String
|
|
generatedLabelContainsFold - String
|
|
clusterID - Int
|
cluster_id field predicates |
clusterIDNEQ - Int
|
|
clusterIDIn - [Int!]
|
|
clusterIDNotIn - [Int!]
|
|
clusterIDGT - Int
|
|
clusterIDGTE - Int
|
|
clusterIDLT - Int
|
|
clusterIDLTE - Int
|
|
clusterIDIsNil - Boolean
|
|
clusterIDNotNil - Boolean
|
|
clusterLabel - String
|
cluster_label field predicates |
clusterLabelNEQ - String
|
|
clusterLabelIn - [String!]
|
|
clusterLabelNotIn - [String!]
|
|
clusterLabelGT - String
|
|
clusterLabelGTE - String
|
|
clusterLabelLT - String
|
|
clusterLabelLTE - String
|
|
clusterLabelContains - String
|
|
clusterLabelHasPrefix - String
|
|
clusterLabelHasSuffix - String
|
|
clusterLabelIsNil - Boolean
|
|
clusterLabelNotNil - Boolean
|
|
clusterLabelEqualFold - String
|
|
clusterLabelContainsFold - String
|
|
hasTenant - Boolean
|
tenant edge predicates |
hasTenantWith - [TenantWhereInput!]
|
|
hasCover - Boolean
|
cover edge predicates |
hasCoverWith - [MediaItemWhereInput!]
|
|
hasCoverImage - Boolean
|
cover_image edge predicates |
hasCoverImageWith - [ImageWhereInput!]
|
|
hasUsers - Boolean
|
users edge predicates |
hasUsersWith - [UserWhereInput!]
|
|
hasClassifications - Boolean
|
classifications edge predicates |
hasClassificationsWith - [TopicClassificationWhereInput!]
|
|
hasPosts - Boolean
|
posts edge predicates |
hasPostsWith - [PostWhereInput!]
|
|
hasPubmedArticles - Boolean
|
pubmed_articles edge predicates |
hasPubmedArticlesWith - [PubmedArticleWhereInput!]
|
|
hasNpiTaxonomies - Boolean
|
npi_taxonomies edge predicates |
hasNpiTaxonomiesWith - [NpiTaxonomyWhereInput!]
|
|
hasParent - Boolean
|
parent edge predicates |
hasParentWith - [TopicWhereInput!]
|
|
hasChildren - Boolean
|
children edge predicates |
hasChildrenWith - [TopicWhereInput!]
|
|
hasPubmedTopicClusters - Boolean
|
pubmed_topic_clusters edge predicates |
hasPubmedTopicClustersWith - [PubmedTopicClusterWhereInput!]
|
|
hasTopicNpiTaxonomies - Boolean
|
topic_npi_taxonomies edge predicates |
hasTopicNpiTaxonomiesWith - [TopicNpiTaxonomyWhereInput!]
|
|
hasTopicPubmedTopicCluster - Boolean
|
topic_pubmed_topic_cluster edge predicates |
hasTopicPubmedTopicClusterWith - [TopicPubmedTopicClusterWhereInput!]
|
Example
{}
TranscriptionRequest
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
storageKey - String
|
|
mediaID - String
|
|
signedURL - String
|
|
uploadedAt - Time
|
|
finishedAt - Time
|
|
result - SpeakInsightResult
|
|
transcription - String
|
|
error - String
|
|
status - TranscriptionRequestStatus
|
Example
{
"id": 4,
"storageKey": "abc123",
"mediaID": "xyz789",
"signedURL": "abc123",
"uploadedAt": "10:15:30Z",
"finishedAt": "10:15:30Z",
"result": SpeakInsightResult,
"transcription": "abc123",
"error": "abc123",
"status": "uploaded"
}
TranscriptionRequestStatus
Description
TranscriptionRequestStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
TranscriptionRequestWhereInput
Description
TranscriptionRequestWhereInput is used for filtering TranscriptionRequest objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - TranscriptionRequestWhereInput
|
|
and - [TranscriptionRequestWhereInput!]
|
|
or - [TranscriptionRequestWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyIsNil - Boolean
|
|
storageKeyNotNil - Boolean
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
mediaID - String
|
media_id field predicates |
mediaIDNEQ - String
|
|
mediaIDIn - [String!]
|
|
mediaIDNotIn - [String!]
|
|
mediaIDGT - String
|
|
mediaIDGTE - String
|
|
mediaIDLT - String
|
|
mediaIDLTE - String
|
|
mediaIDContains - String
|
|
mediaIDHasPrefix - String
|
|
mediaIDHasSuffix - String
|
|
mediaIDIsNil - Boolean
|
|
mediaIDNotNil - Boolean
|
|
mediaIDEqualFold - String
|
|
mediaIDContainsFold - String
|
|
signedURL - String
|
signed_url field predicates |
signedURLNEQ - String
|
|
signedURLIn - [String!]
|
|
signedURLNotIn - [String!]
|
|
signedURLGT - String
|
|
signedURLGTE - String
|
|
signedURLLT - String
|
|
signedURLLTE - String
|
|
signedURLContains - String
|
|
signedURLHasPrefix - String
|
|
signedURLHasSuffix - String
|
|
signedURLIsNil - Boolean
|
|
signedURLNotNil - Boolean
|
|
signedURLEqualFold - String
|
|
signedURLContainsFold - String
|
|
uploadedAt - Time
|
uploaded_at field predicates |
uploadedAtNEQ - Time
|
|
uploadedAtIn - [Time!]
|
|
uploadedAtNotIn - [Time!]
|
|
uploadedAtGT - Time
|
|
uploadedAtGTE - Time
|
|
uploadedAtLT - Time
|
|
uploadedAtLTE - Time
|
|
uploadedAtIsNil - Boolean
|
|
uploadedAtNotNil - Boolean
|
|
finishedAt - Time
|
finished_at field predicates |
finishedAtNEQ - Time
|
|
finishedAtIn - [Time!]
|
|
finishedAtNotIn - [Time!]
|
|
finishedAtGT - Time
|
|
finishedAtGTE - Time
|
|
finishedAtLT - Time
|
|
finishedAtLTE - Time
|
|
finishedAtIsNil - Boolean
|
|
finishedAtNotNil - Boolean
|
|
transcription - String
|
transcription field predicates |
transcriptionNEQ - String
|
|
transcriptionIn - [String!]
|
|
transcriptionNotIn - [String!]
|
|
transcriptionGT - String
|
|
transcriptionGTE - String
|
|
transcriptionLT - String
|
|
transcriptionLTE - String
|
|
transcriptionContains - String
|
|
transcriptionHasPrefix - String
|
|
transcriptionHasSuffix - String
|
|
transcriptionIsNil - Boolean
|
|
transcriptionNotNil - Boolean
|
|
transcriptionEqualFold - String
|
|
transcriptionContainsFold - String
|
|
error - String
|
error field predicates |
errorNEQ - String
|
|
errorIn - [String!]
|
|
errorNotIn - [String!]
|
|
errorGT - String
|
|
errorGTE - String
|
|
errorLT - String
|
|
errorLTE - String
|
|
errorContains - String
|
|
errorHasPrefix - String
|
|
errorHasSuffix - String
|
|
errorIsNil - Boolean
|
|
errorNotNil - Boolean
|
|
errorEqualFold - String
|
|
errorContainsFold - String
|
|
status - TranscriptionRequestStatus
|
status field predicates |
statusNEQ - TranscriptionRequestStatus
|
|
statusIn - [TranscriptionRequestStatus!]
|
|
statusNotIn - [TranscriptionRequestStatus!]
|
|
statusIsNil - Boolean
|
|
statusNotNil - Boolean
|
Example
{}
UpdateAnatomicalModelInput
Description
UpdateAnatomicalModelInput is used for update AnatomicalModel object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
|
description - String
|
A description of the model. |
clearDescription - Boolean
|
|
keywords - [String!]
|
Keywords for the model. These are used to help users find the model. |
appendKeywords - [String!]
|
|
clearKeywords - Boolean
|
|
createdAt - Time
|
|
updatedAt - Time
|
|
videoID - ID
|
|
clearVideo - Boolean
|
|
renderedImageID - ID
|
|
clearRenderedImage - Boolean
|
Example
{}
UpdateAudienceInput
Description
UpdateAudienceInput is used for update Audience object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
|
designationtemplate - String
|
The raw text template for the designation text that will be displayed on the certificate. Use the designation field to get the rendered text. |
createdAt - Time
|
|
updatedAt - Time
|
|
addNpiTaxonomyIDs - [ID!]
|
|
removeNpiTaxonomyIDs - [ID!]
|
|
clearNpiTaxonomies - Boolean
|
|
addPostIDs - [ID!]
|
|
removePostIDs - [ID!]
|
|
clearPosts - Boolean
|
|
tenantID - ID
|
|
clearTenant - Boolean
|
Example
{}
UpdateCertificateSurveyQuestionChoiceInput
Description
UpdateCertificateSurveyQuestionChoiceInput is used for update CertificateSurveyQuestionChoice object. Input was generated by ent.
Example
{}
UpdateCertificateSurveyQuestionInput
Description
UpdateCertificateSurveyQuestionInput is used for update CertificateSurveyQuestion object. Input was generated by ent.
Example
{}
UpdateCollectionInput
Description
UpdateCollectionInput is used for update Collection object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
The name of the collection. |
description - String
|
The description of the collection. |
clearDescription - Boolean
|
|
totalDuration - Int
|
The total duration of all the posts in the collection. |
totalPosts - Int
|
The total number of posts in the collection. |
tenantID - ID
|
|
clearTenant - Boolean
|
|
addPostcollectionIDs - [ID!]
|
|
removePostcollectionIDs - [ID!]
|
|
clearPostcollections - Boolean
|
|
coverID - ID
|
|
clearCover - Boolean
|
|
addUserCompletionIDs - [ID!]
|
|
removeUserCompletionIDs - [ID!]
|
|
clearUserCompletions - Boolean
|
Example
{}
UpdateCourseInput
Description
UpdateCourseInput is used for update Course object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
|
description - String
|
|
clearDescription - Boolean
|
|
disclosure - String
|
|
clearDisclosure - Boolean
|
|
startDate - Time
|
|
clearStartDate - Boolean
|
|
creditHours - Float
|
|
price - Float
|
|
website - String
|
|
clearWebsite - Boolean
|
|
isRaceApproved - Boolean
|
|
type - CourseType
|
|
createdAt - Time
|
|
status - CourseStatus
|
|
reviewedAt - Time
|
|
clearReviewedAt - Boolean
|
|
authorID - ID
|
|
clearAuthor - Boolean
|
|
addFacultyIDs - [ID!]
|
|
removeFacultyIDs - [ID!]
|
|
clearFaculty - Boolean
|
|
reviewedByID - ID
|
|
clearReviewedBy - Boolean
|
|
tenantID - ID
|
|
clearTenant - Boolean
|
|
videoID - ID
|
|
clearVideo - Boolean
|
Example
{}
UpdateEducationHistoryInput
Description
UpdateEducationHistoryInput is used for update EducationHistory object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
institution - String
|
The institution/school name for this education history entry. |
degree - String
|
The degree attained for this education history entry. |
clearDegree - Boolean
|
|
major - String
|
The major for this education history entry. |
clearMajor - Boolean
|
|
startDate - Time
|
|
clearStartDate - Boolean
|
|
endDate - Time
|
|
clearEndDate - Boolean
|
|
type - EducationHistoryType
|
|
userID - ID
|
|
clearUser - Boolean
|
Example
{}
UpdateFinancialDisclosurePrintTemplateInput
UpdateFinancialDisclosureRoleInput
Description
UpdateFinancialDisclosureRoleInput is used for update FinancialDisclosureRole object. Input was generated by ent.
Example
{}
UpdateFinancialDisclosureStatementInput
Description
UpdateFinancialDisclosureStatementInput is used for update FinancialDisclosureStatement object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
deletedAt - Time
|
|
clearDeletedAt - Boolean
|
|
approvedAt - Time
|
The date the financial disclosure statement was approved (Admin Only) |
clearApprovedAt - Boolean
|
|
deniedAt - Time
|
The date the financial disclosure statement was denied (Admin Only) |
clearDeniedAt - Boolean
|
|
status - FinancialDisclosureStatementStatus
|
The status of the financial disclosure statement (Admin Only) |
requiresApproval - Boolean
|
If true, at least one of the relationships has a role requiring approval (Admin Only) |
hasFinancialRelationships - Boolean
|
If true, the user has financial relationships |
agreesToDisclose - Boolean
|
If true, the user agrees to disclose unlabeled/unapproved users of drugs or products |
doesAttest - Boolean
|
If true, the user attests that the information provided is true and accurate |
initials - String
|
The initials of the user |
signatureDate - Time
|
The date the user signed the financial disclosure statement |
createdAt - Time
|
|
updatedAt - Time
|
|
userID - ID
|
|
clearUser - Boolean
|
|
addRelationshipIDs - [ID!]
|
|
removeRelationshipIDs - [ID!]
|
|
clearRelationships - Boolean
|
|
relationships - [FinancialDisclosureInput!]
|
Input for creating or updating a relationship with a company. If the ID is not provided, a new relationship will be created. Pass in all existing relationships, even if they are not being updated. If a relationship is not passed in, it will be deleted. |
Example
{}
UpdateLearningObjectiveInput
Description
UpdateLearningObjectiveInput is used for update LearningObjective object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
|
surveyQuestion - String
|
|
clearSurveyQuestion - Boolean
|
|
tenantID - ID
|
|
clearTenant - Boolean
|
|
addPostIDs - [ID!]
|
|
removePostIDs - [ID!]
|
|
clearPosts - Boolean
|
|
addEducationCreditIDs - [ID!]
|
|
removeEducationCreditIDs - [ID!]
|
|
clearEducationCredits - Boolean
|
|
addCertificateSurveyQuestionIDs - [ID!]
|
|
removeCertificateSurveyQuestionIDs - [ID!]
|
|
clearCertificateSurveyQuestions - Boolean
|
|
addVideoIDs - [ID!]
|
|
removeVideoIDs - [ID!]
|
|
clearVideos - Boolean
|
Example
{}
UpdateLicenseHistoryInput
Description
UpdateLicenseHistoryInput is used for update LicenseHistory object. Input was generated by ent.
Example
{}
UpdateNotificationConfigInput
Description
UpdateNotificationConfigInput is used for update NotificationConfig object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
followUserMessage - String
|
The message template for follow notifications. |
likedPostMessage - String
|
The message template for like notifications. |
reflectedPostMessage - String
|
The message template for comment notifications. |
reflectionApproved - String
|
The message template for reflection approved notifications. |
createdAt - Time
|
|
updatedAt - Time
|
Example
{}
UpdateOfficeInput
Description
UpdateOfficeInput is used for update Office object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
primary - Boolean
|
Whether the office is the primary office location. |
address1 - String
|
The first line of the address. Typically the street address or PO Box number. |
address2 - String
|
The second line of the address. Typically the number of the apartment, suite, or unit. |
clearAddress2 - Boolean
|
|
city - String
|
The city of the office |
stateCode - String
|
The two-letter code for the region. For example CA for California. |
zip - String
|
The zip or postal code of the address. |
countryCode - String
|
The two-letter code for the country of the address. For example US for United States. |
clearCountryCode - Boolean
|
|
phone - String
|
The phone number of the office, Formatted using E.164 standard. |
clearPhone - Boolean
|
|
fax - String
|
The fax number of the office. Formatted using E.164 standard. |
clearFax - Boolean
|
|
email - String
|
The email address for the office |
clearEmail - Boolean
|
|
userID - ID
|
|
clearUser - Boolean
|
Example
{}
UpdatePostInput
Description
The field used to update an existing Post.
Fields
| Input Field | Description |
|---|---|
title - String
|
Title of the post |
creditHours - Float
|
The number of CE credits this post is accredited for |
status - PostStatus
|
Status of the post |
body - String
|
Body of the post. Tags (starting with a #) and Mentions (starting with an @) are allowed |
featured - Boolean
|
Whether this post is featured |
discussionPoints - [String!]
|
The main discussion points for this post |
appendDiscussionPoints - [String!]
|
|
clearDiscussionPoints - Boolean
|
|
createdAt - Time
|
|
updatedAt - Time
|
|
sortKey - Int
|
|
clearSortKey - Boolean
|
|
terms - [String!]
|
|
appendTerms - [String!]
|
|
clearTerms - Boolean
|
|
termFrequencies - Map
|
|
clearTermFrequencies - Boolean
|
|
wordcloud - String
|
|
clearWordcloud - Boolean
|
|
type - PostType
|
The type of the post |
authorID - ID
|
|
clearAuthor - Boolean
|
|
addTopicIDs - [ID!]
|
|
removeTopicIDs - [ID!]
|
|
clearTopics - Boolean
|
|
addCitationIDs - [ID!]
|
|
removeCitationIDs - [ID!]
|
|
clearCitations - Boolean
|
|
tenantID - ID
|
|
clearTenant - Boolean
|
|
accreditedLearningObjectiveID - ID
|
|
clearAccreditedLearningObjective - Boolean
|
|
addCommentIDs - [ID!]
|
|
removeCommentIDs - [ID!]
|
|
clearComments - Boolean
|
|
addMediaItemIDs - [ID!]
|
|
removeMediaItemIDs - [ID!]
|
|
clearMediaItems - Boolean
|
|
addVideoIDs - [ID!]
|
|
removeVideoIDs - [ID!]
|
|
clearVideos - Boolean
|
|
coverImageID - ID
|
|
clearCoverImage - Boolean
|
|
addImageIDs - [ID!]
|
|
removeImageIDs - [ID!]
|
|
clearImages - Boolean
|
|
addPostCollectionIDs - [ID!]
|
|
removePostCollectionIDs - [ID!]
|
|
clearPostCollections - Boolean
|
|
addEducationCreditIDs - [ID!]
|
|
removeEducationCreditIDs - [ID!]
|
|
clearEducationCredits - Boolean
|
|
addAudienceIDs - [ID!]
|
|
removeAudienceIDs - [ID!]
|
|
clearAudiences - Boolean
|
|
addPostTagIDs - [ID!]
|
|
removePostTagIDs - [ID!]
|
|
clearPostTags - Boolean
|
|
addLikedUserIDs - [ID!]
|
|
removeLikedUserIDs - [ID!]
|
|
clearLikedUsers - Boolean
|
|
addBookmarkedUserIDs - [ID!]
|
|
removeBookmarkedUserIDs - [ID!]
|
|
clearBookmarkedUsers - Boolean
|
|
addLearningObjectiveIDs - [ID!]
|
|
removeLearningObjectiveIDs - [ID!]
|
|
clearLearningObjectives - Boolean
|
|
addPostReportIDs - [ID!]
|
|
removePostReportIDs - [ID!]
|
|
clearPostReports - Boolean
|
|
pollID - ID
|
|
clearPoll - Boolean
|
|
addEmbeddingIDs - [ID!]
|
|
removeEmbeddingIDs - [ID!]
|
|
clearEmbeddings - Boolean
|
|
updateCitations - [UpsertPostCitationInput!]
|
Update a Citation for the post |
updatePollQuestions - [UpsertPollQuestionInput!]
|
Update the questions for the post |
removePollQuestionIDs - [ID!]
|
Remove the poll questions for the post, based on the provided IDs |
Example
{}
UpdatePostReportInput
Description
UpdatePostReportInput is used for update PostReport object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the user report |
clearDescription - Boolean
|
|
createdAt - Time
|
|
reviewedAt - Time
|
The time the report was reviewed |
clearReviewedAt - Boolean
|
|
reportReasonID - ID
|
|
clearReportReason - Boolean
|
|
authorID - ID
|
|
clearAuthor - Boolean
|
|
reportedPostID - ID
|
|
clearReportedPost - Boolean
|
|
reviewedByID - ID
|
|
clearReviewedBy - Boolean
|
Example
{}
UpdatePubmedTopicClusterInput
Description
UpdatePubmedTopicClusterInput is used for update PubmedTopicCluster object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
clusterID - Int
|
|
clusterLabel - String
|
|
label - String
|
|
clearLabel - Boolean
|
|
clusterWords - [String!]
|
|
appendClusterWords - [String!]
|
|
addPubmedArticleIDs - [ID!]
|
|
removePubmedArticleIDs - [ID!]
|
|
clearPubmedArticles - Boolean
|
|
addTopicIDs - [ID!]
|
|
removeTopicIDs - [ID!]
|
|
clearTopics - Boolean
|
Example
{}
UpdateReportReasonInput
Description
UpdateReportReasonInput is used for update ReportReason object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
Example
{}
UpdateSparkyChatConfigInput
Description
UpdateSparkyChatConfigInput is used for update SparkyChatConfig object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
|
clearName - Boolean
|
|
suggestReflectionPrompt - String
|
|
reflectionNudgePrompt - String
|
|
isDefault - Boolean
|
|
createdAt - Time
|
|
reflectionGradingExpression - String
|
|
clearReflectionGradingExpression - Boolean
|
|
updatedAt - Time
|
|
userID - ID
|
|
clearUser - Boolean
|
|
copiesID - ID
|
|
clearCopies - Boolean
|
|
addCopiedFromIDs - [ID!]
|
|
removeCopiedFromIDs - [ID!]
|
|
clearCopiedFrom - Boolean
|
|
addRuleIDs - [ID!]
|
|
removeRuleIDs - [ID!]
|
|
clearRules - Boolean
|
Example
{}
UpdateTopicInput
Description
UpdateTopicInput is used for update Topic object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
name - String
|
The name of the topic. |
ordinal - Int
|
The ordinal of the topic. |
type - TopicType
|
The type of the topic. |
modelID - String
|
|
clearModelID - Boolean
|
|
modelVersion - String
|
|
clearModelVersion - Boolean
|
|
totalPosts - Int
|
The total number of posts that are tagged with the topic. |
words - [String!]
|
|
appendWords - [String!]
|
|
clearWords - Boolean
|
|
wordFrequencies - Map
|
|
clearWordFrequencies - Boolean
|
|
generatedLabel - String
|
|
clearGeneratedLabel - Boolean
|
|
clusterID - Int
|
|
clearClusterID - Boolean
|
|
clusterLabel - String
|
|
clearClusterLabel - Boolean
|
|
tenantID - ID
|
|
clearTenant - Boolean
|
|
coverID - ID
|
|
clearCover - Boolean
|
|
coverImageID - ID
|
|
clearCoverImage - Boolean
|
|
addUserIDs - [ID!]
|
|
removeUserIDs - [ID!]
|
|
clearUsers - Boolean
|
|
addClassificationIDs - [ID!]
|
|
removeClassificationIDs - [ID!]
|
|
clearClassifications - Boolean
|
|
addPostIDs - [ID!]
|
|
removePostIDs - [ID!]
|
|
clearPosts - Boolean
|
|
addPubmedArticleIDs - [ID!]
|
|
removePubmedArticleIDs - [ID!]
|
|
clearPubmedArticles - Boolean
|
|
addNpiTaxonomyIDs - [ID!]
|
|
removeNpiTaxonomyIDs - [ID!]
|
|
clearNpiTaxonomies - Boolean
|
|
parentID - ID
|
|
clearParent - Boolean
|
|
addChildIDs - [ID!]
|
|
removeChildIDs - [ID!]
|
|
clearChildren - Boolean
|
|
addPubmedTopicClusterIDs - [ID!]
|
|
removePubmedTopicClusterIDs - [ID!]
|
|
clearPubmedTopicClusters - Boolean
|
Example
{}
UpdateUploadInput
Description
UpdateUploadInput is used for update Upload object. Input was generated by ent.
Example
{}
UpdateUserInput
Description
UpdateUserInput is used for update User object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
firstName - String
|
The first name of the user |
clearFirstName - Boolean
|
|
lastName - String
|
The last name of the user |
clearLastName - Boolean
|
|
disabled - Boolean
|
(Deprecated, use status instead) Whether the user is disabled |
status - UserStatus
|
The status of the user |
phone - String
|
The phone number of the user, stored in E.164 format |
clearPhone - Boolean
|
|
email - String
|
The email address of the user |
clearEmail - Boolean
|
|
password - String
|
The password of the user, stored as a bcrypt hash |
clearPassword - Boolean
|
|
username - String
|
The username of the user |
clearUsername - Boolean
|
|
credential - String
|
The credential of the user, ie MD, DO, PA, NP, etc. Note: Credentials are normalized to uppercase and any periods are removed. |
clearCredential - Boolean
|
|
npiNumber - String
|
The NPI number of the user |
clearNpiNumber - Boolean
|
|
npiTaxonomyCode - String
|
The NPI taxonomy code of the user |
clearNpiTaxonomyCode - Boolean
|
|
npiTaxonomyDescription - String
|
The NPI taxonomy description of the user |
clearNpiTaxonomyDescription - Boolean
|
|
bio - String
|
The bio of the user |
clearBio - Boolean
|
|
isStudent - Boolean
|
Whether the user is a student |
hasSubmittedDisclosure - Boolean
|
Whether the user has submitted a disclosure |
hasDisclosuresNeedingReview - Boolean
|
Whether the user has disclosures needing review |
reflectionsOnAuthoredPostsDisabled - Boolean
|
Whether reflections are disabled on posts authored by this user |
role - UserRole
|
The role of the user |
limitedRoles - [String!]
|
The limited roles of the user. Null or Empty array means no limited roles. |
appendLimitedRoles - [String!]
|
|
clearLimitedRoles - Boolean
|
|
createdAt - Time
|
|
updatedAt - Time
|
|
lastLoginAt - Time
|
The last time the user logged in |
clearLastLoginAt - Boolean
|
|
cmeGoalValue - String
|
The CME goal value of the user |
clearCmeGoalValue - Boolean
|
|
cmeGoalDate - Time
|
The CME goal date of the user |
clearCmeGoalDate - Boolean
|
|
totalCmeEarned - Float
|
The total CME earned by the user |
clearTotalCmeEarned - Boolean
|
|
suggested - Boolean
|
Whether the user has should appear in the suggested users list |
financialDisclosures - String
|
The financial disclosures for the user |
clearFinancialDisclosures - Boolean
|
|
isStaff - Boolean
|
Whether the user is an oog staff user |
totalFollowers - Int
|
The total number of followers the user has |
totalFollowing - Int
|
The total number of users the user is following |
addTenantIDs - [ID!]
|
|
removeTenantIDs - [ID!]
|
|
clearTenants - Boolean
|
|
addTopicIDs - [ID!]
|
|
removeTopicIDs - [ID!]
|
|
clearTopics - Boolean
|
|
addFollowerIDs - [ID!]
|
|
removeFollowerIDs - [ID!]
|
|
clearFollowers - Boolean
|
|
addFollowingIDs - [ID!]
|
|
removeFollowingIDs - [ID!]
|
|
clearFollowing - Boolean
|
|
addPostIDs - [ID!]
|
|
removePostIDs - [ID!]
|
|
clearPosts - Boolean
|
|
addLinkIDs - [ID!]
|
|
removeLinkIDs - [ID!]
|
|
clearLinks - Boolean
|
|
addOfficeIDs - [ID!]
|
|
removeOfficeIDs - [ID!]
|
|
clearOffices - Boolean
|
|
addCommentIDs - [ID!]
|
|
removeCommentIDs - [ID!]
|
|
clearComments - Boolean
|
|
addLikedPostIDs - [ID!]
|
|
removeLikedPostIDs - [ID!]
|
|
clearLikedPosts - Boolean
|
|
addLikedCommentIDs - [ID!]
|
|
removeLikedCommentIDs - [ID!]
|
|
clearLikedComments - Boolean
|
|
addBookmarkedPostIDs - [ID!]
|
|
removeBookmarkedPostIDs - [ID!]
|
|
clearBookmarkedPosts - Boolean
|
|
avatarID - ID
|
|
clearAvatar - Boolean
|
|
profileImageID - ID
|
|
clearProfileImage - Boolean
|
|
specialtyID - ID
|
|
clearSpecialty - Boolean
|
|
addWorkHistoryIDs - [ID!]
|
|
removeWorkHistoryIDs - [ID!]
|
|
clearWorkHistory - Boolean
|
|
addEducationHistoryIDs - [ID!]
|
|
removeEducationHistoryIDs - [ID!]
|
|
clearEducationHistory - Boolean
|
|
addLicenseHistoryIDs - [ID!]
|
|
removeLicenseHistoryIDs - [ID!]
|
|
clearLicenseHistory - Boolean
|
|
addEducationCreditIDs - [ID!]
|
|
removeEducationCreditIDs - [ID!]
|
|
clearEducationCredits - Boolean
|
|
addNotificationTokenIDs - [ID!]
|
|
removeNotificationTokenIDs - [ID!]
|
|
clearNotificationTokens - Boolean
|
|
addNotificationIDs - [ID!]
|
|
removeNotificationIDs - [ID!]
|
|
clearNotifications - Boolean
|
|
addOutgoingNotificationIDs - [ID!]
|
|
removeOutgoingNotificationIDs - [ID!]
|
|
clearOutgoingNotifications - Boolean
|
|
addSearchIDs - [ID!]
|
|
removeSearchIDs - [ID!]
|
|
clearSearches - Boolean
|
|
addAPITokenIDs - [ID!]
|
|
removeAPITokenIDs - [ID!]
|
|
clearAPITokens - Boolean
|
|
addUserCompletionIDs - [ID!]
|
|
removeUserCompletionIDs - [ID!]
|
|
clearUserCompletions - Boolean
|
|
financialDisclosureStatementID - ID
|
|
clearFinancialDisclosureStatement - Boolean
|
|
addCoursesCreatedIDs - [ID!]
|
|
removeCoursesCreatedIDs - [ID!]
|
|
clearCoursesCreated - Boolean
|
|
addCoursesReviewedIDs - [ID!]
|
|
removeCoursesReviewedIDs - [ID!]
|
|
clearCoursesReviewed - Boolean
|
|
addCoursesFacultyIDs - [ID!]
|
|
removeCoursesFacultyIDs - [ID!]
|
|
clearCoursesFaculty - Boolean
|
|
addUserReportIDs - [ID!]
|
|
removeUserReportIDs - [ID!]
|
|
clearUserReports - Boolean
|
|
addReportedByIDs - [ID!]
|
|
removeReportedByIDs - [ID!]
|
|
clearReportedBy - Boolean
|
|
addPostReportIDs - [ID!]
|
|
removePostReportIDs - [ID!]
|
|
clearPostReports - Boolean
|
|
addMutedUserIDs - [ID!]
|
|
removeMutedUserIDs - [ID!]
|
|
clearMutedUsers - Boolean
|
|
addBlockedUserIDs - [ID!]
|
|
removeBlockedUserIDs - [ID!]
|
|
clearBlockedUsers - Boolean
|
|
addAccountConnectionIDs - [ID!]
|
|
removeAccountConnectionIDs - [ID!]
|
|
clearAccountConnections - Boolean
|
|
addImportedVideoIDs - [ID!]
|
|
removeImportedVideoIDs - [ID!]
|
|
clearImportedVideos - Boolean
|
Example
{}
UpdateUserLinkInput
UpdateUserReportInput
Description
UpdateUserReportInput is used for update UserReport object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the user report |
clearDescription - Boolean
|
|
createdAt - Time
|
|
reviewedAt - Time
|
The time the report was reviewed |
clearReviewedAt - Boolean
|
|
reportReasonID - ID
|
|
clearReportReason - Boolean
|
|
authorID - ID
|
|
clearAuthor - Boolean
|
|
reportedUserID - ID
|
|
clearReportedUser - Boolean
|
|
reviewedByID - ID
|
|
clearReviewedBy - Boolean
|
Example
{}
UpdateVerificationRequestInput
Description
UpdateVerificationRequestInput is used for update VerificationRequest object. Input was generated by ent.
Example
{}
UpdateWorkExperienceInput
Description
UpdateWorkExperienceInput is used for update WorkExperience object. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
institution - String
|
The institution of the work experience. |
specialty - String
|
The specialty of the work experience. |
title - String
|
The title of the work experience. |
employment - WorkExperienceEmployment
|
The employment type of the work experience. |
startDate - Time
|
The start date of the work experience. |
clearStartDate - Boolean
|
|
endDate - Time
|
The end date of the work experience. |
clearEndDate - Boolean
|
|
city - String
|
The city of the work experience. |
state - String
|
The state of the work experience. |
userID - ID
|
|
clearUser - Boolean
|
Example
{}
Upload
Example
{
"id": "4",
"name": "abc123",
"bucket": "abc123",
"key": "xyz789",
"url": "xyz789",
"contentType": "abc123",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z"
}
UploadConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UploadEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UploadEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UploadEdge
UploadOrder
Description
Ordering options for Upload connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - UploadOrderField!
|
The field by which to order Uploads. |
Example
{}
UploadOrderField
Description
Properties by which Upload connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UploadWhereInput
Description
UploadWhereInput is used for filtering Upload objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UploadWhereInput
|
|
and - [UploadWhereInput!]
|
|
or - [UploadWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
name - String
|
name field predicates |
nameNEQ - String
|
|
nameIn - [String!]
|
|
nameNotIn - [String!]
|
|
nameGT - String
|
|
nameGTE - String
|
|
nameLT - String
|
|
nameLTE - String
|
|
nameContains - String
|
|
nameHasPrefix - String
|
|
nameHasSuffix - String
|
|
nameIsNil - Boolean
|
|
nameNotNil - Boolean
|
|
nameEqualFold - String
|
|
nameContainsFold - String
|
|
bucket - String
|
bucket field predicates |
bucketNEQ - String
|
|
bucketIn - [String!]
|
|
bucketNotIn - [String!]
|
|
bucketGT - String
|
|
bucketGTE - String
|
|
bucketLT - String
|
|
bucketLTE - String
|
|
bucketContains - String
|
|
bucketHasPrefix - String
|
|
bucketHasSuffix - String
|
|
bucketEqualFold - String
|
|
bucketContainsFold - String
|
|
key - String
|
key field predicates |
keyNEQ - String
|
|
keyIn - [String!]
|
|
keyNotIn - [String!]
|
|
keyGT - String
|
|
keyGTE - String
|
|
keyLT - String
|
|
keyLTE - String
|
|
keyContains - String
|
|
keyHasPrefix - String
|
|
keyHasSuffix - String
|
|
keyEqualFold - String
|
|
keyContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlIsNil - Boolean
|
|
urlNotNil - Boolean
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
contentType - String
|
content_type field predicates |
contentTypeNEQ - String
|
|
contentTypeIn - [String!]
|
|
contentTypeNotIn - [String!]
|
|
contentTypeGT - String
|
|
contentTypeGTE - String
|
|
contentTypeLT - String
|
|
contentTypeLTE - String
|
|
contentTypeContains - String
|
|
contentTypeHasPrefix - String
|
|
contentTypeHasSuffix - String
|
|
contentTypeIsNil - Boolean
|
|
contentTypeNotNil - Boolean
|
|
contentTypeEqualFold - String
|
|
contentTypeContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
Example
{}
UpsertPollQuestionInput
UpsertPostCitationInput
User
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
firstName - String
|
The first name of the user |
lastName - String
|
The last name of the user |
disabled - Boolean!
|
(Deprecated, use status instead) Whether the user is disabled |
status - UserStatus!
|
The status of the user |
phone - String
|
The phone number of the user, stored in E.164 format |
email - String
|
The email address of the user |
username - String
|
The username of the user |
credential - String
|
The credential of the user, ie MD, DO, PA, NP, etc. Note: Credentials are normalized to uppercase and any periods are removed. |
npiNumber - String
|
The NPI number of the user |
npiTaxonomyCode - String
|
The NPI taxonomy code of the user |
npiTaxonomyDescription - String
|
The NPI taxonomy description of the user |
bio - String
|
The bio of the user |
isStudent - Boolean!
|
Whether the user is a student |
hasSubmittedDisclosure - Boolean!
|
Whether the user has submitted a disclosure |
hasDisclosuresNeedingReview - Boolean!
|
Whether the user has disclosures needing review |
reflectionsOnAuthoredPostsDisabled - Boolean!
|
Whether reflections are disabled on posts authored by this user |
role - UserRole!
|
The role of the user |
limitedRoles - [String!]
|
The limited roles of the user. Null or Empty array means no limited roles. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
lastLoginAt - Time
|
The last time the user logged in |
cmeGoalValue - String
|
The CME goal value of the user |
cmeGoalDate - Time
|
The CME goal date of the user |
totalCmeEarned - Float
|
The total CME earned by the user |
suggested - Boolean!
|
Whether the user has should appear in the suggested users list |
financialDisclosures - String
|
The financial disclosures for the user |
isStaff - Boolean!
|
Whether the user is an oog staff user |
totalFollowers - Int!
|
The total number of followers the user has |
totalFollowing - Int!
|
The total number of users the user is following |
tenants - [Tenant!]
|
The tenants the user belongs to |
topics - [Topic!]
|
The topics the user follows |
followers - [User!]
|
The users that follow this user |
following - [User!]
|
|
posts - [Post!]
|
The posts the user has made |
links - [UserLink!]
|
The links the user has added |
offices - [Office!]
|
The providers offices |
comments - [Comment!]
|
The comments the user has made |
likedPosts - [Post!]
|
The posts the user has liked |
likedComments - [Comment!]
|
The comments the user has liked |
bookmarkedPosts - [Post!]
|
The posts the user has bookmarked |
avatar - MediaItem
|
(DEPRECATED) The avatar of the user |
profileImage - Image
|
The profile image for the user. Images are hosted using Cloudflare images. Please see https://developers.cloudflare.com/images/cloudflare-images/serve-images/ for details on how to serve images. |
specialty - NpiTaxonomy
|
The NPI taxonomy of the user |
workHistory - [WorkExperience!]
|
The work history of the user |
educationHistory - [EducationHistory!]
|
The education history of the user |
licenseHistory - [LicenseHistory!]
|
The license history of the user |
educationCredits - [EducationCredit!]
|
The education credits of the user |
notificationTokens - [UserNotificationToken!]
|
The notification tokens for the user |
notifications - [Notification!]
|
The notifications for the user: Likes, Comments, etc. |
outgoingNotifications - [Notification!]
|
The notifications the user has generated for other users |
searches - [Search!]
|
The searches the user has made |
apiTokens - [ApiToken!]
|
The API tokens the user has generated |
userCompletions - [UserCollectionCompletion!]
|
The user collection completions |
financialDisclosureStatement - FinancialDisclosureStatement
|
The financial disclosures for the user |
coursesCreated - [Course!]
|
The courses the user has created |
coursesReviewed - [Course!]
|
The courses the user has reviewed |
coursesFaculty - [Course!]
|
The courses the user is faculty for |
userReports - [UserReport!]
|
The user reports this user has created |
reportedBy - [UserReport!]
|
The user reports this user has been reported by |
postReports - [PostReport!]
|
The post reports this user has created |
mutedUsers - [UserMute!]
|
The users this user has muted |
blockedUsers - [UserBlock!]
|
The users this user has blocked |
accountConnections - [AccountConnection!]
|
3rd party account connections |
importedVideos - [ImportedVideo!]
|
The imported videos for the user |
userTenants - [UserTenant!]
|
|
likes - [Like!]
|
|
commentLikes - [CommentLike!]
|
|
bookmarks - [Bookmark!]
|
|
streamToken - String!
|
The Stream (getstream.io) chat token for the current user |
currentTenant - Tenant
|
|
npiTaxonomy - NpiTaxonomy
|
Example
{
"id": "4",
"firstName": "abc123",
"lastName": "abc123",
"disabled": false,
"status": "active",
"phone": "xyz789",
"email": "abc123",
"username": "xyz789",
"credential": "xyz789",
"npiNumber": "abc123",
"npiTaxonomyCode": "xyz789",
"npiTaxonomyDescription": "xyz789",
"bio": "abc123",
"isStudent": true,
"hasSubmittedDisclosure": true,
"hasDisclosuresNeedingReview": true,
"reflectionsOnAuthoredPostsDisabled": true,
"role": "admin",
"limitedRoles": ["abc123"],
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"lastLoginAt": "10:15:30Z",
"cmeGoalValue": "abc123",
"cmeGoalDate": "10:15:30Z",
"totalCmeEarned": 987.65,
"suggested": true,
"financialDisclosures": "xyz789",
"isStaff": true,
"totalFollowers": 987,
"totalFollowing": 987,
"tenants": [Tenant],
"topics": [Topic],
"followers": [User],
"following": [User],
"posts": [Post],
"links": [UserLink],
"offices": [Office],
"comments": [Comment],
"likedPosts": [Post],
"likedComments": [Comment],
"bookmarkedPosts": [Post],
"avatar": MediaItem,
"profileImage": Image,
"specialty": NpiTaxonomy,
"workHistory": [WorkExperience],
"educationHistory": [EducationHistory],
"licenseHistory": [LicenseHistory],
"educationCredits": [EducationCredit],
"notificationTokens": [UserNotificationToken],
"notifications": [Notification],
"outgoingNotifications": [Notification],
"searches": [Search],
"apiTokens": [ApiToken],
"userCompletions": [UserCollectionCompletion],
"financialDisclosureStatement": FinancialDisclosureStatement,
"coursesCreated": [Course],
"coursesReviewed": [Course],
"coursesFaculty": [Course],
"userReports": [UserReport],
"reportedBy": [UserReport],
"postReports": [PostReport],
"mutedUsers": [UserMute],
"blockedUsers": [UserBlock],
"accountConnections": [AccountConnection],
"importedVideos": [ImportedVideo],
"userTenants": [UserTenant],
"likes": [Like],
"commentLikes": [CommentLike],
"bookmarks": [Bookmark],
"streamToken": "xyz789",
"currentTenant": Tenant,
"npiTaxonomy": NpiTaxonomy
}
UserAnalyticsEvent
UserAnalyticsEventWhereInput
Description
UserAnalyticsEventWhereInput is used for filtering UserAnalyticsEvent objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserAnalyticsEventWhereInput
|
|
and - [UserAnalyticsEventWhereInput!]
|
|
or - [UserAnalyticsEventWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
entityID - Int
|
entity_id field predicates |
entityIDNEQ - Int
|
|
entityIDIn - [Int!]
|
|
entityIDNotIn - [Int!]
|
|
entityIDGT - Int
|
|
entityIDGTE - Int
|
|
entityIDLT - Int
|
|
entityIDLTE - Int
|
|
entityName - String
|
entity_name field predicates |
entityNameNEQ - String
|
|
entityNameIn - [String!]
|
|
entityNameNotIn - [String!]
|
|
entityNameGT - String
|
|
entityNameGTE - String
|
|
entityNameLT - String
|
|
entityNameLTE - String
|
|
entityNameContains - String
|
|
entityNameHasPrefix - String
|
|
entityNameHasSuffix - String
|
|
entityNameEqualFold - String
|
|
entityNameContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
UserBlock
UserBlockConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserBlockEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserBlockEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UserBlockEdge
UserBlockOrder
Description
Ordering options for UserBlock connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - UserBlockOrderField!
|
The field by which to order UserBlocks. |
Example
{}
UserBlockOrderField
Description
Properties by which UserBlock connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
UserBlockWhereInput
Description
UserBlockWhereInput is used for filtering UserBlock objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserBlockWhereInput
|
|
and - [UserBlockWhereInput!]
|
|
or - [UserBlockWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasBlockedUser - Boolean
|
blocked_user edge predicates |
hasBlockedUserWith - [UserWhereInput!]
|
|
hasOwner - Boolean
|
owner edge predicates |
hasOwnerWith - [UserWhereInput!]
|
Example
{}
UserCollectionCompletion
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
completedAt - Time
|
The time that the user completed the collection. |
userID - ID!
|
The user that completed the collection. |
collectionID - ID!
|
The collection that the user completed. |
user - User!
|
The user that completed the collection. |
collection - Collection!
|
The collection that the user completed. |
educationCredit - EducationCredit
|
Example
{
"id": "4",
"completedAt": "10:15:30Z",
"userID": "4",
"collectionID": 4,
"user": User,
"collection": Collection,
"educationCredit": EducationCredit
}
UserCollectionCompletionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserCollectionCompletionEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserCollectionCompletionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UserCollectionCompletionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserCollectionCompletion
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": UserCollectionCompletion,
"cursor": Cursor
}
UserCollectionCompletionWhereInput
Description
UserCollectionCompletionWhereInput is used for filtering UserCollectionCompletion objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserCollectionCompletionWhereInput
|
|
and - [UserCollectionCompletionWhereInput!]
|
|
or - [UserCollectionCompletionWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
completedAt - Time
|
completed_at field predicates |
completedAtNEQ - Time
|
|
completedAtIn - [Time!]
|
|
completedAtNotIn - [Time!]
|
|
completedAtGT - Time
|
|
completedAtGTE - Time
|
|
completedAtLT - Time
|
|
completedAtLTE - Time
|
|
completedAtIsNil - Boolean
|
|
completedAtNotNil - Boolean
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
collectionID - ID
|
collection_id field predicates |
collectionIDNEQ - ID
|
|
collectionIDIn - [ID!]
|
|
collectionIDNotIn - [ID!]
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasCollection - Boolean
|
collection edge predicates |
hasCollectionWith - [CollectionWhereInput!]
|
|
hasEducationCredit - Boolean
|
education_credit edge predicates |
hasEducationCreditWith - [EducationCreditWhereInput!]
|
Example
{}
UserConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UserEdge
UserLink
UserLinkConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserLinkEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserLinkEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
UserLinkEdge
UserLinkWhereInput
Description
UserLinkWhereInput is used for filtering UserLink objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserLinkWhereInput
|
|
and - [UserLinkWhereInput!]
|
|
or - [UserLinkWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
ordinal - Int
|
ordinal field predicates |
ordinalNEQ - Int
|
|
ordinalIn - [Int!]
|
|
ordinalNotIn - [Int!]
|
|
ordinalGT - Int
|
|
ordinalGTE - Int
|
|
ordinalLT - Int
|
|
ordinalLTE - Int
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
UserMute
UserMuteConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserMuteEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserMuteEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
UserMuteEdge
UserMuteOrder
Description
Ordering options for UserMute connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - UserMuteOrderField!
|
The field by which to order UserMutes. |
Example
{}
UserMuteOrderField
Description
Properties by which UserMute connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
UserMuteWhereInput
Description
UserMuteWhereInput is used for filtering UserMute objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserMuteWhereInput
|
|
and - [UserMuteWhereInput!]
|
|
or - [UserMuteWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasMutedUser - Boolean
|
muted_user edge predicates |
hasMutedUserWith - [UserWhereInput!]
|
|
hasOwner - Boolean
|
owner edge predicates |
hasOwnerWith - [UserWhereInput!]
|
Example
{}
UserNotificationToken
Example
{
"id": "4",
"token": "xyz789",
"platform": "abc123",
"user": User
}
UserNotificationTokenConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserNotificationTokenEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserNotificationTokenEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
UserNotificationTokenEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserNotificationToken
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": UserNotificationToken,
"cursor": Cursor
}
UserNotificationTokenWhereInput
Description
UserNotificationTokenWhereInput is used for filtering UserNotificationToken objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserNotificationTokenWhereInput
|
|
and - [UserNotificationTokenWhereInput!]
|
|
or - [UserNotificationTokenWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
token - String
|
token field predicates |
tokenNEQ - String
|
|
tokenIn - [String!]
|
|
tokenNotIn - [String!]
|
|
tokenGT - String
|
|
tokenGTE - String
|
|
tokenLT - String
|
|
tokenLTE - String
|
|
tokenContains - String
|
|
tokenHasPrefix - String
|
|
tokenHasSuffix - String
|
|
tokenEqualFold - String
|
|
tokenContainsFold - String
|
|
platform - String
|
platform field predicates |
platformNEQ - String
|
|
platformIn - [String!]
|
|
platformNotIn - [String!]
|
|
platformGT - String
|
|
platformGTE - String
|
|
platformLT - String
|
|
platformLTE - String
|
|
platformContains - String
|
|
platformHasPrefix - String
|
|
platformHasSuffix - String
|
|
platformEqualFold - String
|
|
platformContainsFold - String
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
UserOrder
Description
Ordering options for User connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - UserOrderField!
|
The field by which to order Users. |
Example
{}
UserOrderField
Description
Properties by which User connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UserRelationship
UserReport
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
description - String
|
The description of the user report |
createdAt - Time!
|
|
reviewedAt - Time
|
The time the report was reviewed |
reportReason - ReportReason
|
The reason for the user report |
author - User
|
The author of the user report |
reportedUser - User
|
The user that was reported |
reviewedBy - User
|
The admin user that reviewed the report |
Example
{
"id": "4",
"description": "xyz789",
"createdAt": "10:15:30Z",
"reviewedAt": "10:15:30Z",
"reportReason": ReportReason,
"author": User,
"reportedUser": User,
"reviewedBy": User
}
UserReportConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [UserReportEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [UserReportEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
UserReportEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - UserReport
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": UserReport,
"cursor": Cursor
}
UserReportOrder
Description
Ordering options for UserReport connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - UserReportOrderField!
|
The field by which to order UserReports. |
Example
{}
UserReportOrderField
Description
Properties by which UserReport connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
UserReportWhereInput
Description
UserReportWhereInput is used for filtering UserReport objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserReportWhereInput
|
|
and - [UserReportWhereInput!]
|
|
or - [UserReportWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
description - String
|
description field predicates |
descriptionNEQ - String
|
|
descriptionIn - [String!]
|
|
descriptionNotIn - [String!]
|
|
descriptionGT - String
|
|
descriptionGTE - String
|
|
descriptionLT - String
|
|
descriptionLTE - String
|
|
descriptionContains - String
|
|
descriptionHasPrefix - String
|
|
descriptionHasSuffix - String
|
|
descriptionIsNil - Boolean
|
|
descriptionNotNil - Boolean
|
|
descriptionEqualFold - String
|
|
descriptionContainsFold - String
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
reviewedAt - Time
|
reviewed_at field predicates |
reviewedAtNEQ - Time
|
|
reviewedAtIn - [Time!]
|
|
reviewedAtNotIn - [Time!]
|
|
reviewedAtGT - Time
|
|
reviewedAtGTE - Time
|
|
reviewedAtLT - Time
|
|
reviewedAtLTE - Time
|
|
reviewedAtIsNil - Boolean
|
|
reviewedAtNotNil - Boolean
|
|
hasReportReason - Boolean
|
report_reason edge predicates |
hasReportReasonWith - [ReportReasonWhereInput!]
|
|
hasAuthor - Boolean
|
author edge predicates |
hasAuthorWith - [UserWhereInput!]
|
|
hasReportedUser - Boolean
|
reported_user edge predicates |
hasReportedUserWith - [UserWhereInput!]
|
|
hasReviewedBy - Boolean
|
reviewed_by edge predicates |
hasReviewedByWith - [UserWhereInput!]
|
Example
{}
UserRole
Description
UserRole is enum for the field role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
UserSearchConnection
Fields
| Field Name | Description |
|---|---|
edges - [UserEdge]
|
|
pageInfo - PageInfo!
|
|
totalCount - Int!
|
|
specialties - [NpiTaxonomy]
|
The topics that are present in the search results. |
Example
{
"edges": [UserEdge],
"pageInfo": PageInfo,
"totalCount": 987,
"specialties": [NpiTaxonomy]
}
UserSearchResult
Example
{
"id": "4",
"firstName": "xyz789",
"lastName": "xyz789",
"username": "abc123",
"profileImage": SearchResultImage,
"totalFollowers": 123,
"totalFollowing": 987
}
UserStatus
Description
UserStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
UserTenant
Example
{
"id": "4",
"createdAt": "10:15:30Z",
"userID": "4",
"tenantID": "4",
"user": User,
"tenant": Tenant
}
UserTenantWhereInput
Description
UserTenantWhereInput is used for filtering UserTenant objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserTenantWhereInput
|
|
and - [UserTenantWhereInput!]
|
|
or - [UserTenantWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
Example
{}
UserVideoEvent
UserVideoEventWhereInput
Description
UserVideoEventWhereInput is used for filtering UserVideoEvent objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserVideoEventWhereInput
|
|
and - [UserVideoEventWhereInput!]
|
|
or - [UserVideoEventWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
eventType - String
|
event_type field predicates |
eventTypeNEQ - String
|
|
eventTypeIn - [String!]
|
|
eventTypeNotIn - [String!]
|
|
eventTypeGT - String
|
|
eventTypeGTE - String
|
|
eventTypeLT - String
|
|
eventTypeLTE - String
|
|
eventTypeContains - String
|
|
eventTypeHasPrefix - String
|
|
eventTypeHasSuffix - String
|
|
eventTypeEqualFold - String
|
|
eventTypeContainsFold - String
|
|
userID - ID
|
user_id field predicates |
userIDNEQ - ID
|
|
userIDIn - [ID!]
|
|
userIDNotIn - [ID!]
|
|
videoID - ID
|
video_id field predicates |
videoIDNEQ - ID
|
|
videoIDIn - [ID!]
|
|
videoIDNotIn - [ID!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
UserWhereInput
Description
UserWhereInput is used for filtering User objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - UserWhereInput
|
|
and - [UserWhereInput!]
|
|
or - [UserWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
firstName - String
|
first_name field predicates |
firstNameNEQ - String
|
|
firstNameIn - [String!]
|
|
firstNameNotIn - [String!]
|
|
firstNameGT - String
|
|
firstNameGTE - String
|
|
firstNameLT - String
|
|
firstNameLTE - String
|
|
firstNameContains - String
|
|
firstNameHasPrefix - String
|
|
firstNameHasSuffix - String
|
|
firstNameIsNil - Boolean
|
|
firstNameNotNil - Boolean
|
|
firstNameEqualFold - String
|
|
firstNameContainsFold - String
|
|
lastName - String
|
last_name field predicates |
lastNameNEQ - String
|
|
lastNameIn - [String!]
|
|
lastNameNotIn - [String!]
|
|
lastNameGT - String
|
|
lastNameGTE - String
|
|
lastNameLT - String
|
|
lastNameLTE - String
|
|
lastNameContains - String
|
|
lastNameHasPrefix - String
|
|
lastNameHasSuffix - String
|
|
lastNameIsNil - Boolean
|
|
lastNameNotNil - Boolean
|
|
lastNameEqualFold - String
|
|
lastNameContainsFold - String
|
|
disabled - Boolean
|
disabled field predicates |
disabledNEQ - Boolean
|
|
status - UserStatus
|
status field predicates |
statusNEQ - UserStatus
|
|
statusIn - [UserStatus!]
|
|
statusNotIn - [UserStatus!]
|
|
phone - String
|
phone field predicates |
phoneNEQ - String
|
|
phoneIn - [String!]
|
|
phoneNotIn - [String!]
|
|
phoneGT - String
|
|
phoneGTE - String
|
|
phoneLT - String
|
|
phoneLTE - String
|
|
phoneContains - String
|
|
phoneHasPrefix - String
|
|
phoneHasSuffix - String
|
|
phoneIsNil - Boolean
|
|
phoneNotNil - Boolean
|
|
phoneEqualFold - String
|
|
phoneContainsFold - String
|
|
email - String
|
email field predicates |
emailNEQ - String
|
|
emailIn - [String!]
|
|
emailNotIn - [String!]
|
|
emailGT - String
|
|
emailGTE - String
|
|
emailLT - String
|
|
emailLTE - String
|
|
emailContains - String
|
|
emailHasPrefix - String
|
|
emailHasSuffix - String
|
|
emailIsNil - Boolean
|
|
emailNotNil - Boolean
|
|
emailEqualFold - String
|
|
emailContainsFold - String
|
|
username - String
|
username field predicates |
usernameNEQ - String
|
|
usernameIn - [String!]
|
|
usernameNotIn - [String!]
|
|
usernameGT - String
|
|
usernameGTE - String
|
|
usernameLT - String
|
|
usernameLTE - String
|
|
usernameContains - String
|
|
usernameHasPrefix - String
|
|
usernameHasSuffix - String
|
|
usernameIsNil - Boolean
|
|
usernameNotNil - Boolean
|
|
usernameEqualFold - String
|
|
usernameContainsFold - String
|
|
credential - String
|
credential field predicates |
credentialNEQ - String
|
|
credentialIn - [String!]
|
|
credentialNotIn - [String!]
|
|
credentialGT - String
|
|
credentialGTE - String
|
|
credentialLT - String
|
|
credentialLTE - String
|
|
credentialContains - String
|
|
credentialHasPrefix - String
|
|
credentialHasSuffix - String
|
|
credentialIsNil - Boolean
|
|
credentialNotNil - Boolean
|
|
credentialEqualFold - String
|
|
credentialContainsFold - String
|
|
npiNumber - String
|
npi_number field predicates |
npiNumberNEQ - String
|
|
npiNumberIn - [String!]
|
|
npiNumberNotIn - [String!]
|
|
npiNumberGT - String
|
|
npiNumberGTE - String
|
|
npiNumberLT - String
|
|
npiNumberLTE - String
|
|
npiNumberContains - String
|
|
npiNumberHasPrefix - String
|
|
npiNumberHasSuffix - String
|
|
npiNumberIsNil - Boolean
|
|
npiNumberNotNil - Boolean
|
|
npiNumberEqualFold - String
|
|
npiNumberContainsFold - String
|
|
npiTaxonomyCode - String
|
npi_taxonomy_code field predicates |
npiTaxonomyCodeNEQ - String
|
|
npiTaxonomyCodeIn - [String!]
|
|
npiTaxonomyCodeNotIn - [String!]
|
|
npiTaxonomyCodeGT - String
|
|
npiTaxonomyCodeGTE - String
|
|
npiTaxonomyCodeLT - String
|
|
npiTaxonomyCodeLTE - String
|
|
npiTaxonomyCodeContains - String
|
|
npiTaxonomyCodeHasPrefix - String
|
|
npiTaxonomyCodeHasSuffix - String
|
|
npiTaxonomyCodeIsNil - Boolean
|
|
npiTaxonomyCodeNotNil - Boolean
|
|
npiTaxonomyCodeEqualFold - String
|
|
npiTaxonomyCodeContainsFold - String
|
|
npiTaxonomyDescription - String
|
npi_taxonomy_description field predicates |
npiTaxonomyDescriptionNEQ - String
|
|
npiTaxonomyDescriptionIn - [String!]
|
|
npiTaxonomyDescriptionNotIn - [String!]
|
|
npiTaxonomyDescriptionGT - String
|
|
npiTaxonomyDescriptionGTE - String
|
|
npiTaxonomyDescriptionLT - String
|
|
npiTaxonomyDescriptionLTE - String
|
|
npiTaxonomyDescriptionContains - String
|
|
npiTaxonomyDescriptionHasPrefix - String
|
|
npiTaxonomyDescriptionHasSuffix - String
|
|
npiTaxonomyDescriptionIsNil - Boolean
|
|
npiTaxonomyDescriptionNotNil - Boolean
|
|
npiTaxonomyDescriptionEqualFold - String
|
|
npiTaxonomyDescriptionContainsFold - String
|
|
bio - String
|
bio field predicates |
bioNEQ - String
|
|
bioIn - [String!]
|
|
bioNotIn - [String!]
|
|
bioGT - String
|
|
bioGTE - String
|
|
bioLT - String
|
|
bioLTE - String
|
|
bioContains - String
|
|
bioHasPrefix - String
|
|
bioHasSuffix - String
|
|
bioIsNil - Boolean
|
|
bioNotNil - Boolean
|
|
bioEqualFold - String
|
|
bioContainsFold - String
|
|
isStudent - Boolean
|
is_student field predicates |
isStudentNEQ - Boolean
|
|
hasSubmittedDisclosure - Boolean
|
has_submitted_disclosure field predicates |
hasSubmittedDisclosureNEQ - Boolean
|
|
hasDisclosuresNeedingReview - Boolean
|
has_disclosures_needing_review field predicates |
hasDisclosuresNeedingReviewNEQ - Boolean
|
|
reflectionsOnAuthoredPostsDisabled - Boolean
|
reflections_on_authored_posts_disabled field predicates |
reflectionsOnAuthoredPostsDisabledNEQ - Boolean
|
|
role - UserRole
|
role field predicates |
roleNEQ - UserRole
|
|
roleIn - [UserRole!]
|
|
roleNotIn - [UserRole!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
lastLoginAt - Time
|
last_login_at field predicates |
lastLoginAtNEQ - Time
|
|
lastLoginAtIn - [Time!]
|
|
lastLoginAtNotIn - [Time!]
|
|
lastLoginAtGT - Time
|
|
lastLoginAtGTE - Time
|
|
lastLoginAtLT - Time
|
|
lastLoginAtLTE - Time
|
|
lastLoginAtIsNil - Boolean
|
|
lastLoginAtNotNil - Boolean
|
|
cmeGoalValue - String
|
cme_goal_value field predicates |
cmeGoalValueNEQ - String
|
|
cmeGoalValueIn - [String!]
|
|
cmeGoalValueNotIn - [String!]
|
|
cmeGoalValueGT - String
|
|
cmeGoalValueGTE - String
|
|
cmeGoalValueLT - String
|
|
cmeGoalValueLTE - String
|
|
cmeGoalValueContains - String
|
|
cmeGoalValueHasPrefix - String
|
|
cmeGoalValueHasSuffix - String
|
|
cmeGoalValueIsNil - Boolean
|
|
cmeGoalValueNotNil - Boolean
|
|
cmeGoalValueEqualFold - String
|
|
cmeGoalValueContainsFold - String
|
|
cmeGoalDate - Time
|
cme_goal_date field predicates |
cmeGoalDateNEQ - Time
|
|
cmeGoalDateIn - [Time!]
|
|
cmeGoalDateNotIn - [Time!]
|
|
cmeGoalDateGT - Time
|
|
cmeGoalDateGTE - Time
|
|
cmeGoalDateLT - Time
|
|
cmeGoalDateLTE - Time
|
|
cmeGoalDateIsNil - Boolean
|
|
cmeGoalDateNotNil - Boolean
|
|
totalCmeEarned - Float
|
total_cme_earned field predicates |
totalCmeEarnedNEQ - Float
|
|
totalCmeEarnedIn - [Float!]
|
|
totalCmeEarnedNotIn - [Float!]
|
|
totalCmeEarnedGT - Float
|
|
totalCmeEarnedGTE - Float
|
|
totalCmeEarnedLT - Float
|
|
totalCmeEarnedLTE - Float
|
|
totalCmeEarnedIsNil - Boolean
|
|
totalCmeEarnedNotNil - Boolean
|
|
suggested - Boolean
|
suggested field predicates |
suggestedNEQ - Boolean
|
|
financialDisclosures - String
|
financial_disclosures field predicates |
financialDisclosuresNEQ - String
|
|
financialDisclosuresIn - [String!]
|
|
financialDisclosuresNotIn - [String!]
|
|
financialDisclosuresGT - String
|
|
financialDisclosuresGTE - String
|
|
financialDisclosuresLT - String
|
|
financialDisclosuresLTE - String
|
|
financialDisclosuresContains - String
|
|
financialDisclosuresHasPrefix - String
|
|
financialDisclosuresHasSuffix - String
|
|
financialDisclosuresIsNil - Boolean
|
|
financialDisclosuresNotNil - Boolean
|
|
financialDisclosuresEqualFold - String
|
|
financialDisclosuresContainsFold - String
|
|
isStaff - Boolean
|
is_staff field predicates |
isStaffNEQ - Boolean
|
|
totalFollowers - Int
|
total_followers field predicates |
totalFollowersNEQ - Int
|
|
totalFollowersIn - [Int!]
|
|
totalFollowersNotIn - [Int!]
|
|
totalFollowersGT - Int
|
|
totalFollowersGTE - Int
|
|
totalFollowersLT - Int
|
|
totalFollowersLTE - Int
|
|
totalFollowing - Int
|
total_following field predicates |
totalFollowingNEQ - Int
|
|
totalFollowingIn - [Int!]
|
|
totalFollowingNotIn - [Int!]
|
|
totalFollowingGT - Int
|
|
totalFollowingGTE - Int
|
|
totalFollowingLT - Int
|
|
totalFollowingLTE - Int
|
|
hasTenants - Boolean
|
tenants edge predicates |
hasTenantsWith - [TenantWhereInput!]
|
|
hasTopics - Boolean
|
topics edge predicates |
hasTopicsWith - [TopicWhereInput!]
|
|
hasFollowers - Boolean
|
followers edge predicates |
hasFollowersWith - [UserWhereInput!]
|
|
hasFollowing - Boolean
|
following edge predicates |
hasFollowingWith - [UserWhereInput!]
|
|
hasPosts - Boolean
|
posts edge predicates |
hasPostsWith - [PostWhereInput!]
|
|
hasLinks - Boolean
|
links edge predicates |
hasLinksWith - [UserLinkWhereInput!]
|
|
hasOffices - Boolean
|
offices edge predicates |
hasOfficesWith - [OfficeWhereInput!]
|
|
hasComments - Boolean
|
comments edge predicates |
hasCommentsWith - [CommentWhereInput!]
|
|
hasLikedPosts - Boolean
|
liked_posts edge predicates |
hasLikedPostsWith - [PostWhereInput!]
|
|
hasLikedComments - Boolean
|
liked_comments edge predicates |
hasLikedCommentsWith - [CommentWhereInput!]
|
|
hasBookmarkedPosts - Boolean
|
bookmarked_posts edge predicates |
hasBookmarkedPostsWith - [PostWhereInput!]
|
|
hasAvatar - Boolean
|
avatar edge predicates |
hasAvatarWith - [MediaItemWhereInput!]
|
|
hasProfileImage - Boolean
|
profile_image edge predicates |
hasProfileImageWith - [ImageWhereInput!]
|
|
hasSpecialty - Boolean
|
specialty edge predicates |
hasSpecialtyWith - [NpiTaxonomyWhereInput!]
|
|
hasWorkHistory - Boolean
|
work_history edge predicates |
hasWorkHistoryWith - [WorkExperienceWhereInput!]
|
|
hasEducationHistory - Boolean
|
education_history edge predicates |
hasEducationHistoryWith - [EducationHistoryWhereInput!]
|
|
hasLicenseHistory - Boolean
|
license_history edge predicates |
hasLicenseHistoryWith - [LicenseHistoryWhereInput!]
|
|
hasEducationCredits - Boolean
|
education_credits edge predicates |
hasEducationCreditsWith - [EducationCreditWhereInput!]
|
|
hasNotificationTokens - Boolean
|
notification_tokens edge predicates |
hasNotificationTokensWith - [UserNotificationTokenWhereInput!]
|
|
hasNotifications - Boolean
|
notifications edge predicates |
hasNotificationsWith - [NotificationWhereInput!]
|
|
hasOutgoingNotifications - Boolean
|
outgoing_notifications edge predicates |
hasOutgoingNotificationsWith - [NotificationWhereInput!]
|
|
hasSearches - Boolean
|
searches edge predicates |
hasSearchesWith - [SearchWhereInput!]
|
|
hasAPITokens - Boolean
|
api_tokens edge predicates |
hasAPITokensWith - [ApiTokenWhereInput!]
|
|
hasUserCompletions - Boolean
|
user_completions edge predicates |
hasUserCompletionsWith - [UserCollectionCompletionWhereInput!]
|
|
hasFinancialDisclosureStatement - Boolean
|
financial_disclosure_statement edge predicates |
hasFinancialDisclosureStatementWith - [FinancialDisclosureStatementWhereInput!]
|
|
hasCoursesCreated - Boolean
|
courses_created edge predicates |
hasCoursesCreatedWith - [CourseWhereInput!]
|
|
hasCoursesReviewed - Boolean
|
courses_reviewed edge predicates |
hasCoursesReviewedWith - [CourseWhereInput!]
|
|
hasCoursesFaculty - Boolean
|
courses_faculty edge predicates |
hasCoursesFacultyWith - [CourseWhereInput!]
|
|
hasUserReports - Boolean
|
user_reports edge predicates |
hasUserReportsWith - [UserReportWhereInput!]
|
|
hasReportedBy - Boolean
|
reported_by edge predicates |
hasReportedByWith - [UserReportWhereInput!]
|
|
hasPostReports - Boolean
|
post_reports edge predicates |
hasPostReportsWith - [PostReportWhereInput!]
|
|
hasMutedUsers - Boolean
|
muted_users edge predicates |
hasMutedUsersWith - [UserMuteWhereInput!]
|
|
hasBlockedUsers - Boolean
|
blocked_users edge predicates |
hasBlockedUsersWith - [UserBlockWhereInput!]
|
|
hasAccountConnections - Boolean
|
account_connections edge predicates |
hasAccountConnectionsWith - [AccountConnectionWhereInput!]
|
|
hasImportedVideos - Boolean
|
imported_videos edge predicates |
hasImportedVideosWith - [ImportedVideoWhereInput!]
|
|
hasUserTenants - Boolean
|
user_tenants edge predicates |
hasUserTenantsWith - [UserTenantWhereInput!]
|
|
hasLikes - Boolean
|
likes edge predicates |
hasLikesWith - [LikeWhereInput!]
|
|
hasCommentLikes - Boolean
|
comment_likes edge predicates |
hasCommentLikesWith - [CommentLikeWhereInput!]
|
|
hasBookmarks - Boolean
|
bookmarks edge predicates |
hasBookmarksWith - [BookmarkWhereInput!]
|
|
search - String
|
Example
{}
VerificationRequest
Example
{
"id": 4,
"dob": "xyz789",
"zip": "abc123",
"storageKey": "xyz789",
"url": "abc123",
"status": "waiting",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"user": User
}
VerificationRequestConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [VerificationRequestEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [VerificationRequestEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VerificationRequestEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - VerificationRequest
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": VerificationRequest,
"cursor": Cursor
}
VerificationRequestOrder
Description
Ordering options for VerificationRequest connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - VerificationRequestOrderField!
|
The field by which to order VerificationRequests. |
Example
{}
VerificationRequestOrderField
Description
Properties by which VerificationRequest connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
VerificationRequestResult
Fields
| Field Name | Description |
|---|---|
url - String!
|
|
verificationRequest - VerificationRequest!
|
Example
{
"url": "xyz789",
"verificationRequest": VerificationRequest
}
VerificationRequestStatus
Description
VerificationRequestStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
VerificationRequestWhereInput
Description
VerificationRequestWhereInput is used for filtering VerificationRequest objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - VerificationRequestWhereInput
|
|
and - [VerificationRequestWhereInput!]
|
|
or - [VerificationRequestWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
dob - String
|
dob field predicates |
dobNEQ - String
|
|
dobIn - [String!]
|
|
dobNotIn - [String!]
|
|
dobGT - String
|
|
dobGTE - String
|
|
dobLT - String
|
|
dobLTE - String
|
|
dobContains - String
|
|
dobHasPrefix - String
|
|
dobHasSuffix - String
|
|
dobIsNil - Boolean
|
|
dobNotNil - Boolean
|
|
dobEqualFold - String
|
|
dobContainsFold - String
|
|
zip - String
|
zip field predicates |
zipNEQ - String
|
|
zipIn - [String!]
|
|
zipNotIn - [String!]
|
|
zipGT - String
|
|
zipGTE - String
|
|
zipLT - String
|
|
zipLTE - String
|
|
zipContains - String
|
|
zipHasPrefix - String
|
|
zipHasSuffix - String
|
|
zipIsNil - Boolean
|
|
zipNotNil - Boolean
|
|
zipEqualFold - String
|
|
zipContainsFold - String
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
status - VerificationRequestStatus
|
status field predicates |
statusNEQ - VerificationRequestStatus
|
|
statusIn - [VerificationRequestStatus!]
|
|
statusNotIn - [VerificationRequestStatus!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}
Video
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
storageKey - String
|
The storage key of the video. |
width - Int
|
The width of the video in pixels. |
height - Int
|
The height of the video in pixels. |
duration - Int
|
The duration of the video in seconds. |
thumbnailURL - String
|
The URL of the thumbnail image of the video. |
hlsURL - String
|
The URL of the HLS stream of the video. |
dashURL - String
|
The URL of the DASH stream of the video. |
verticalUID - String
|
The vertical UID of the video. |
verticalThumbnailURL - String
|
The vertical thumbnail URL of the video. |
verticalHlsURL - String
|
The vertical HLS URL of the video. |
verticalDashURL - String
|
The vertical DASH URL of the video. |
verticalWidth - Int
|
The vertical width of the video in pixels. |
verticalHeight - Int
|
The vertical height of the video in pixels. |
status - VideoStatus!
|
The processing status of the video. |
createdAt - Time!
|
|
updatedAt - Time!
|
|
transcription - String
|
The transcription of the video. |
suggestedTitle - String
|
A suggested title based on the audio transcription |
suggestedBody - String
|
A suggested body based on the audio transcription |
discussionPoints - [String!]
|
The main discussion points for this post |
topLearningObjectives - [String!]
|
The top learning objectives for this post |
insightsGeneratedAt - Time
|
The time when the insights were last generated |
cloudflareUploadStartedAt - Time
|
The time when the video was uploaded to Cloudflare |
cloudflareUploadEndedAt - Time
|
The time when the video was uploaded to Cloudflare |
cloudflareUploadUID - String
|
The Cloudflare upload UID |
cloudflareUploadStatus - VideoCloudflareUploadStatus
|
The processing status of the video. |
cloudflareUploadError - String
|
The error message if the upload failed |
transcodeStartedAt - Time
|
The time when the video was transcoded |
transcodeEndedAt - Time
|
The time when the video was transcoded |
transcodeStatus - VideoTranscodeStatus
|
The processing status of the video. |
transcodeError - String
|
The error message if the transcode failed |
transcribeStartedAt - Time
|
The time when the video was transcribed |
transcribeEndedAt - Time
|
The time when the video was transcribed |
transcribeStatus - VideoTranscribeStatus
|
The processing status of the video. |
transcribeError - String
|
The error message if the transcribe failed |
generateInsightsStartedAt - Time
|
The time when the video insights were generated |
generateInsightsEndedAt - Time
|
The time when the video insights were generated |
generateInsightsStatus - VideoGenerateInsightsStatus
|
The processing status of the video. |
generateInsightsError - String
|
The error message if the generate insights failed |
likelyAudience - String
|
The likely audience for this video |
terms - [String!]
|
|
termFrequencies - Map
|
|
wordcloud - String
|
|
termsPerMinute - Float!
|
The number of terms per minute in the video |
speakMediaID - String
|
The media ID of the video in SpeakAI |
workflowID - String
|
|
workflowRunID - String
|
|
post - Post
|
The post that the video belongs to. |
suggestedLearningObjectives - [LearningObjective!]
|
The topics this post is associated with |
userVideoEvents - [UserVideoEvent!]
|
The user video events for this video. |
course - [Course!]
|
|
googleDriveFile - GoogleDriveFile
|
The Google Drive file that the video was imported from. |
faceDetectionRequest - [FaceDetectRequest!]
|
|
images - [Image!]
|
|
frames - [VideoFrame!]
|
|
importedVideo - ImportedVideo
|
The imported video record. |
alternatePlaylists - [AlternatePlaylist!]!
|
|
suggestedTopics - [Topic!]
|
|
topicClassifications - [TopicClassification!]
|
|
completedAt - Time
|
|
transcriptionRequest - TranscriptionRequest
|
|
Example
{
"id": 4,
"storageKey": "xyz789",
"width": 987,
"height": 123,
"duration": 987,
"thumbnailURL": "xyz789",
"hlsURL": "abc123",
"dashURL": "xyz789",
"verticalUID": "xyz789",
"verticalThumbnailURL": "abc123",
"verticalHlsURL": "xyz789",
"verticalDashURL": "abc123",
"verticalWidth": 987,
"verticalHeight": 987,
"status": "waiting",
"createdAt": "10:15:30Z",
"updatedAt": "10:15:30Z",
"transcription": "xyz789",
"suggestedTitle": "xyz789",
"suggestedBody": "abc123",
"discussionPoints": ["abc123"],
"topLearningObjectives": ["xyz789"],
"insightsGeneratedAt": "10:15:30Z",
"cloudflareUploadStartedAt": "10:15:30Z",
"cloudflareUploadEndedAt": "10:15:30Z",
"cloudflareUploadUID": "abc123",
"cloudflareUploadStatus": "started",
"cloudflareUploadError": "xyz789",
"transcodeStartedAt": "10:15:30Z",
"transcodeEndedAt": "10:15:30Z",
"transcodeStatus": "started",
"transcodeError": "xyz789",
"transcribeStartedAt": "10:15:30Z",
"transcribeEndedAt": "10:15:30Z",
"transcribeStatus": "started",
"transcribeError": "abc123",
"generateInsightsStartedAt": "10:15:30Z",
"generateInsightsEndedAt": "10:15:30Z",
"generateInsightsStatus": "started",
"generateInsightsError": "xyz789",
"likelyAudience": "xyz789",
"terms": ["abc123"],
"termFrequencies": Map,
"wordcloud": "xyz789",
"termsPerMinute": 987.65,
"speakMediaID": "abc123",
"workflowID": "abc123",
"workflowRunID": "xyz789",
"post": Post,
"suggestedLearningObjectives": [LearningObjective],
"userVideoEvents": [UserVideoEvent],
"course": [Course],
"googleDriveFile": GoogleDriveFile,
"faceDetectionRequest": [FaceDetectRequest],
"images": [Image],
"frames": [VideoFrame],
"importedVideo": ImportedVideo,
"alternatePlaylists": [AlternatePlaylist],
"suggestedTopics": [Topic],
"topicClassifications": [TopicClassification],
"completedAt": "10:15:30Z",
"transcriptionRequest": TranscriptionRequest
}
VideoCloudflareUploadStatus
Description
VideoCloudflareUploadStatus is enum for the field cloudflare_upload_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
VideoConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [VideoEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [VideoEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VideoEdge
VideoEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
VideoFrame
VideoFrameWhereInput
Description
VideoFrameWhereInput is used for filtering VideoFrame objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - VideoFrameWhereInput
|
|
and - [VideoFrameWhereInput!]
|
|
or - [VideoFrameWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
key - String
|
key field predicates |
keyNEQ - String
|
|
keyIn - [String!]
|
|
keyNotIn - [String!]
|
|
keyGT - String
|
|
keyGTE - String
|
|
keyLT - String
|
|
keyLTE - String
|
|
keyContains - String
|
|
keyHasPrefix - String
|
|
keyHasSuffix - String
|
|
keyEqualFold - String
|
|
keyContainsFold - String
|
|
bucket - String
|
bucket field predicates |
bucketNEQ - String
|
|
bucketIn - [String!]
|
|
bucketNotIn - [String!]
|
|
bucketGT - String
|
|
bucketGTE - String
|
|
bucketLT - String
|
|
bucketLTE - String
|
|
bucketContains - String
|
|
bucketHasPrefix - String
|
|
bucketHasSuffix - String
|
|
bucketEqualFold - String
|
|
bucketContainsFold - String
|
|
url - String
|
url field predicates |
urlNEQ - String
|
|
urlIn - [String!]
|
|
urlNotIn - [String!]
|
|
urlGT - String
|
|
urlGTE - String
|
|
urlLT - String
|
|
urlLTE - String
|
|
urlContains - String
|
|
urlHasPrefix - String
|
|
urlHasSuffix - String
|
|
urlIsNil - Boolean
|
|
urlNotNil - Boolean
|
|
urlEqualFold - String
|
|
urlContainsFold - String
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
VideoGenerateInsightsStatus
Description
VideoGenerateInsightsStatus is enum for the field generate_insights_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
VideoOrder
Description
Ordering options for Video connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - VideoOrderField!
|
The field by which to order Videos. |
Example
{}
VideoOrderField
Description
Properties by which Video connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
{}
VideoPipeline
VideoPipelineConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [VideoPipelineEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [VideoPipelineEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
VideoPipelineEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - VideoPipeline
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": VideoPipeline,
"cursor": Cursor
}
VideoPipelineOrder
Description
Ordering options for VideoPipeline connections
Fields
| Input Field | Description |
|---|---|
direction - OrderDirection!
|
The ordering direction. Default = ASC |
field - VideoPipelineOrderField!
|
The field by which to order VideoPipelines. |
Example
{}
VideoPipelineOrderField
Description
Properties by which VideoPipeline connections can be ordered.
Values
| Enum Value | Description |
|---|---|
|
|
Example
{}
VideoPipelineWhereInput
Description
VideoPipelineWhereInput is used for filtering VideoPipeline objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - VideoPipelineWhereInput
|
|
and - [VideoPipelineWhereInput!]
|
|
or - [VideoPipelineWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
hasVideo - Boolean
|
video edge predicates |
hasVideoWith - [VideoWhereInput!]
|
Example
{}
VideoStatus
Description
VideoStatus is enum for the field status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
VideoTranscodeStatus
Description
VideoTranscodeStatus is enum for the field transcode_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
VideoTranscribeStatus
Description
VideoTranscribeStatus is enum for the field transcribe_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
{}
VideoUploadResponse
VideoWhereInput
Description
VideoWhereInput is used for filtering Video objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - VideoWhereInput
|
|
and - [VideoWhereInput!]
|
|
or - [VideoWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
storageKey - String
|
storage_key field predicates |
storageKeyNEQ - String
|
|
storageKeyIn - [String!]
|
|
storageKeyNotIn - [String!]
|
|
storageKeyGT - String
|
|
storageKeyGTE - String
|
|
storageKeyLT - String
|
|
storageKeyLTE - String
|
|
storageKeyContains - String
|
|
storageKeyHasPrefix - String
|
|
storageKeyHasSuffix - String
|
|
storageKeyIsNil - Boolean
|
|
storageKeyNotNil - Boolean
|
|
storageKeyEqualFold - String
|
|
storageKeyContainsFold - String
|
|
width - Int
|
width field predicates |
widthNEQ - Int
|
|
widthIn - [Int!]
|
|
widthNotIn - [Int!]
|
|
widthGT - Int
|
|
widthGTE - Int
|
|
widthLT - Int
|
|
widthLTE - Int
|
|
widthIsNil - Boolean
|
|
widthNotNil - Boolean
|
|
height - Int
|
height field predicates |
heightNEQ - Int
|
|
heightIn - [Int!]
|
|
heightNotIn - [Int!]
|
|
heightGT - Int
|
|
heightGTE - Int
|
|
heightLT - Int
|
|
heightLTE - Int
|
|
heightIsNil - Boolean
|
|
heightNotNil - Boolean
|
|
duration - Int
|
duration field predicates |
durationNEQ - Int
|
|
durationIn - [Int!]
|
|
durationNotIn - [Int!]
|
|
durationGT - Int
|
|
durationGTE - Int
|
|
durationLT - Int
|
|
durationLTE - Int
|
|
durationIsNil - Boolean
|
|
durationNotNil - Boolean
|
|
thumbnailURL - String
|
thumbnail_url field predicates |
thumbnailURLNEQ - String
|
|
thumbnailURLIn - [String!]
|
|
thumbnailURLNotIn - [String!]
|
|
thumbnailURLGT - String
|
|
thumbnailURLGTE - String
|
|
thumbnailURLLT - String
|
|
thumbnailURLLTE - String
|
|
thumbnailURLContains - String
|
|
thumbnailURLHasPrefix - String
|
|
thumbnailURLHasSuffix - String
|
|
thumbnailURLIsNil - Boolean
|
|
thumbnailURLNotNil - Boolean
|
|
thumbnailURLEqualFold - String
|
|
thumbnailURLContainsFold - String
|
|
hlsURL - String
|
hls_url field predicates |
hlsURLNEQ - String
|
|
hlsURLIn - [String!]
|
|
hlsURLNotIn - [String!]
|
|
hlsURLGT - String
|
|
hlsURLGTE - String
|
|
hlsURLLT - String
|
|
hlsURLLTE - String
|
|
hlsURLContains - String
|
|
hlsURLHasPrefix - String
|
|
hlsURLHasSuffix - String
|
|
hlsURLIsNil - Boolean
|
|
hlsURLNotNil - Boolean
|
|
hlsURLEqualFold - String
|
|
hlsURLContainsFold - String
|
|
dashURL - String
|
dash_url field predicates |
dashURLNEQ - String
|
|
dashURLIn - [String!]
|
|
dashURLNotIn - [String!]
|
|
dashURLGT - String
|
|
dashURLGTE - String
|
|
dashURLLT - String
|
|
dashURLLTE - String
|
|
dashURLContains - String
|
|
dashURLHasPrefix - String
|
|
dashURLHasSuffix - String
|
|
dashURLIsNil - Boolean
|
|
dashURLNotNil - Boolean
|
|
dashURLEqualFold - String
|
|
dashURLContainsFold - String
|
|
verticalUID - String
|
vertical_uid field predicates |
verticalUIDNEQ - String
|
|
verticalUIDIn - [String!]
|
|
verticalUIDNotIn - [String!]
|
|
verticalUIDGT - String
|
|
verticalUIDGTE - String
|
|
verticalUIDLT - String
|
|
verticalUIDLTE - String
|
|
verticalUIDContains - String
|
|
verticalUIDHasPrefix - String
|
|
verticalUIDHasSuffix - String
|
|
verticalUIDIsNil - Boolean
|
|
verticalUIDNotNil - Boolean
|
|
verticalUIDEqualFold - String
|
|
verticalUIDContainsFold - String
|
|
verticalThumbnailURL - String
|
vertical_thumbnail_url field predicates |
verticalThumbnailURLNEQ - String
|
|
verticalThumbnailURLIn - [String!]
|
|
verticalThumbnailURLNotIn - [String!]
|
|
verticalThumbnailURLGT - String
|
|
verticalThumbnailURLGTE - String
|
|
verticalThumbnailURLLT - String
|
|
verticalThumbnailURLLTE - String
|
|
verticalThumbnailURLContains - String
|
|
verticalThumbnailURLHasPrefix - String
|
|
verticalThumbnailURLHasSuffix - String
|
|
verticalThumbnailURLIsNil - Boolean
|
|
verticalThumbnailURLNotNil - Boolean
|
|
verticalThumbnailURLEqualFold - String
|
|
verticalThumbnailURLContainsFold - String
|
|
verticalHlsURL - String
|
vertical_hls_url field predicates |
verticalHlsURLNEQ - String
|
|
verticalHlsURLIn - [String!]
|
|
verticalHlsURLNotIn - [String!]
|
|
verticalHlsURLGT - String
|
|
verticalHlsURLGTE - String
|
|
verticalHlsURLLT - String
|
|
verticalHlsURLLTE - String
|
|
verticalHlsURLContains - String
|
|
verticalHlsURLHasPrefix - String
|
|
verticalHlsURLHasSuffix - String
|
|
verticalHlsURLIsNil - Boolean
|
|
verticalHlsURLNotNil - Boolean
|
|
verticalHlsURLEqualFold - String
|
|
verticalHlsURLContainsFold - String
|
|
verticalDashURL - String
|
vertical_dash_url field predicates |
verticalDashURLNEQ - String
|
|
verticalDashURLIn - [String!]
|
|
verticalDashURLNotIn - [String!]
|
|
verticalDashURLGT - String
|
|
verticalDashURLGTE - String
|
|
verticalDashURLLT - String
|
|
verticalDashURLLTE - String
|
|
verticalDashURLContains - String
|
|
verticalDashURLHasPrefix - String
|
|
verticalDashURLHasSuffix - String
|
|
verticalDashURLIsNil - Boolean
|
|
verticalDashURLNotNil - Boolean
|
|
verticalDashURLEqualFold - String
|
|
verticalDashURLContainsFold - String
|
|
verticalWidth - Int
|
vertical_width field predicates |
verticalWidthNEQ - Int
|
|
verticalWidthIn - [Int!]
|
|
verticalWidthNotIn - [Int!]
|
|
verticalWidthGT - Int
|
|
verticalWidthGTE - Int
|
|
verticalWidthLT - Int
|
|
verticalWidthLTE - Int
|
|
verticalWidthIsNil - Boolean
|
|
verticalWidthNotNil - Boolean
|
|
verticalHeight - Int
|
vertical_height field predicates |
verticalHeightNEQ - Int
|
|
verticalHeightIn - [Int!]
|
|
verticalHeightNotIn - [Int!]
|
|
verticalHeightGT - Int
|
|
verticalHeightGTE - Int
|
|
verticalHeightLT - Int
|
|
verticalHeightLTE - Int
|
|
verticalHeightIsNil - Boolean
|
|
verticalHeightNotNil - Boolean
|
|
status - VideoStatus
|
status field predicates |
statusNEQ - VideoStatus
|
|
statusIn - [VideoStatus!]
|
|
statusNotIn - [VideoStatus!]
|
|
createdAt - Time
|
created_at field predicates |
createdAtNEQ - Time
|
|
createdAtIn - [Time!]
|
|
createdAtNotIn - [Time!]
|
|
createdAtGT - Time
|
|
createdAtGTE - Time
|
|
createdAtLT - Time
|
|
createdAtLTE - Time
|
|
updatedAt - Time
|
updated_at field predicates |
updatedAtNEQ - Time
|
|
updatedAtIn - [Time!]
|
|
updatedAtNotIn - [Time!]
|
|
updatedAtGT - Time
|
|
updatedAtGTE - Time
|
|
updatedAtLT - Time
|
|
updatedAtLTE - Time
|
|
transcription - String
|
transcription field predicates |
transcriptionNEQ - String
|
|
transcriptionIn - [String!]
|
|
transcriptionNotIn - [String!]
|
|
transcriptionGT - String
|
|
transcriptionGTE - String
|
|
transcriptionLT - String
|
|
transcriptionLTE - String
|
|
transcriptionContains - String
|
|
transcriptionHasPrefix - String
|
|
transcriptionHasSuffix - String
|
|
transcriptionIsNil - Boolean
|
|
transcriptionNotNil - Boolean
|
|
transcriptionEqualFold - String
|
|
transcriptionContainsFold - String
|
|
suggestedTitle - String
|
suggested_title field predicates |
suggestedTitleNEQ - String
|
|
suggestedTitleIn - [String!]
|
|
suggestedTitleNotIn - [String!]
|
|
suggestedTitleGT - String
|
|
suggestedTitleGTE - String
|
|
suggestedTitleLT - String
|
|
suggestedTitleLTE - String
|
|
suggestedTitleContains - String
|
|
suggestedTitleHasPrefix - String
|
|
suggestedTitleHasSuffix - String
|
|
suggestedTitleIsNil - Boolean
|
|
suggestedTitleNotNil - Boolean
|
|
suggestedTitleEqualFold - String
|
|
suggestedTitleContainsFold - String
|
|
suggestedBody - String
|
suggested_body field predicates |
suggestedBodyNEQ - String
|
|
suggestedBodyIn - [String!]
|
|
suggestedBodyNotIn - [String!]
|
|
suggestedBodyGT - String
|
|
suggestedBodyGTE - String
|
|
suggestedBodyLT - String
|
|
suggestedBodyLTE - String
|
|
suggestedBodyContains - String
|
|
suggestedBodyHasPrefix - String
|
|
suggestedBodyHasSuffix - String
|
|
suggestedBodyIsNil - Boolean
|
|
suggestedBodyNotNil - Boolean
|
|
suggestedBodyEqualFold - String
|
|
suggestedBodyContainsFold - String
|
|
insightsGeneratedAt - Time
|
insights_generated_at field predicates |
insightsGeneratedAtNEQ - Time
|
|
insightsGeneratedAtIn - [Time!]
|
|
insightsGeneratedAtNotIn - [Time!]
|
|
insightsGeneratedAtGT - Time
|
|
insightsGeneratedAtGTE - Time
|
|
insightsGeneratedAtLT - Time
|
|
insightsGeneratedAtLTE - Time
|
|
insightsGeneratedAtIsNil - Boolean
|
|
insightsGeneratedAtNotNil - Boolean
|
|
cloudflareUploadStartedAt - Time
|
cloudflare_upload_started_at field predicates |
cloudflareUploadStartedAtNEQ - Time
|
|
cloudflareUploadStartedAtIn - [Time!]
|
|
cloudflareUploadStartedAtNotIn - [Time!]
|
|
cloudflareUploadStartedAtGT - Time
|
|
cloudflareUploadStartedAtGTE - Time
|
|
cloudflareUploadStartedAtLT - Time
|
|
cloudflareUploadStartedAtLTE - Time
|
|
cloudflareUploadStartedAtIsNil - Boolean
|
|
cloudflareUploadStartedAtNotNil - Boolean
|
|
cloudflareUploadEndedAt - Time
|
cloudflare_upload_ended_at field predicates |
cloudflareUploadEndedAtNEQ - Time
|
|
cloudflareUploadEndedAtIn - [Time!]
|
|
cloudflareUploadEndedAtNotIn - [Time!]
|
|
cloudflareUploadEndedAtGT - Time
|
|
cloudflareUploadEndedAtGTE - Time
|
|
cloudflareUploadEndedAtLT - Time
|
|
cloudflareUploadEndedAtLTE - Time
|
|
cloudflareUploadEndedAtIsNil - Boolean
|
|
cloudflareUploadEndedAtNotNil - Boolean
|
|
cloudflareUploadUID - String
|
cloudflare_upload_uid field predicates |
cloudflareUploadUIDNEQ - String
|
|
cloudflareUploadUIDIn - [String!]
|
|
cloudflareUploadUIDNotIn - [String!]
|
|
cloudflareUploadUIDGT - String
|
|
cloudflareUploadUIDGTE - String
|
|
cloudflareUploadUIDLT - String
|
|
cloudflareUploadUIDLTE - String
|
|
cloudflareUploadUIDContains - String
|
|
cloudflareUploadUIDHasPrefix - String
|
|
cloudflareUploadUIDHasSuffix - String
|
|
cloudflareUploadUIDIsNil - Boolean
|
|
cloudflareUploadUIDNotNil - Boolean
|
|
cloudflareUploadUIDEqualFold - String
|
|
cloudflareUploadUIDContainsFold - String
|
|
cloudflareUploadStatus - VideoCloudflareUploadStatus
|
cloudflare_upload_status field predicates |
cloudflareUploadStatusNEQ - VideoCloudflareUploadStatus
|
|
cloudflareUploadStatusIn - [VideoCloudflareUploadStatus!]
|
|
cloudflareUploadStatusNotIn - [VideoCloudflareUploadStatus!]
|
|
cloudflareUploadStatusIsNil - Boolean
|
|
cloudflareUploadStatusNotNil - Boolean
|
|
cloudflareUploadError - String
|
cloudflare_upload_error field predicates |
cloudflareUploadErrorNEQ - String
|
|
cloudflareUploadErrorIn - [String!]
|
|
cloudflareUploadErrorNotIn - [String!]
|
|
cloudflareUploadErrorGT - String
|
|
cloudflareUploadErrorGTE - String
|
|
cloudflareUploadErrorLT - String
|
|
cloudflareUploadErrorLTE - String
|
|
cloudflareUploadErrorContains - String
|
|
cloudflareUploadErrorHasPrefix - String
|
|
cloudflareUploadErrorHasSuffix - String
|
|
cloudflareUploadErrorIsNil - Boolean
|
|
cloudflareUploadErrorNotNil - Boolean
|
|
cloudflareUploadErrorEqualFold - String
|
|
cloudflareUploadErrorContainsFold - String
|
|
transcodeStartedAt - Time
|
transcode_started_at field predicates |
transcodeStartedAtNEQ - Time
|
|
transcodeStartedAtIn - [Time!]
|
|
transcodeStartedAtNotIn - [Time!]
|
|
transcodeStartedAtGT - Time
|
|
transcodeStartedAtGTE - Time
|
|
transcodeStartedAtLT - Time
|
|
transcodeStartedAtLTE - Time
|
|
transcodeStartedAtIsNil - Boolean
|
|
transcodeStartedAtNotNil - Boolean
|
|
transcodeEndedAt - Time
|
transcode_ended_at field predicates |
transcodeEndedAtNEQ - Time
|
|
transcodeEndedAtIn - [Time!]
|
|
transcodeEndedAtNotIn - [Time!]
|
|
transcodeEndedAtGT - Time
|
|
transcodeEndedAtGTE - Time
|
|
transcodeEndedAtLT - Time
|
|
transcodeEndedAtLTE - Time
|
|
transcodeEndedAtIsNil - Boolean
|
|
transcodeEndedAtNotNil - Boolean
|
|
transcodeStatus - VideoTranscodeStatus
|
transcode_status field predicates |
transcodeStatusNEQ - VideoTranscodeStatus
|
|
transcodeStatusIn - [VideoTranscodeStatus!]
|
|
transcodeStatusNotIn - [VideoTranscodeStatus!]
|
|
transcodeStatusIsNil - Boolean
|
|
transcodeStatusNotNil - Boolean
|
|
transcodeError - String
|
transcode_error field predicates |
transcodeErrorNEQ - String
|
|
transcodeErrorIn - [String!]
|
|
transcodeErrorNotIn - [String!]
|
|
transcodeErrorGT - String
|
|
transcodeErrorGTE - String
|
|
transcodeErrorLT - String
|
|
transcodeErrorLTE - String
|
|
transcodeErrorContains - String
|
|
transcodeErrorHasPrefix - String
|
|
transcodeErrorHasSuffix - String
|
|
transcodeErrorIsNil - Boolean
|
|
transcodeErrorNotNil - Boolean
|
|
transcodeErrorEqualFold - String
|
|
transcodeErrorContainsFold - String
|
|
transcribeStartedAt - Time
|
transcribe_started_at field predicates |
transcribeStartedAtNEQ - Time
|
|
transcribeStartedAtIn - [Time!]
|
|
transcribeStartedAtNotIn - [Time!]
|
|
transcribeStartedAtGT - Time
|
|
transcribeStartedAtGTE - Time
|
|
transcribeStartedAtLT - Time
|
|
transcribeStartedAtLTE - Time
|
|
transcribeStartedAtIsNil - Boolean
|
|
transcribeStartedAtNotNil - Boolean
|
|
transcribeEndedAt - Time
|
transcribe_ended_at field predicates |
transcribeEndedAtNEQ - Time
|
|
transcribeEndedAtIn - [Time!]
|
|
transcribeEndedAtNotIn - [Time!]
|
|
transcribeEndedAtGT - Time
|
|
transcribeEndedAtGTE - Time
|
|
transcribeEndedAtLT - Time
|
|
transcribeEndedAtLTE - Time
|
|
transcribeEndedAtIsNil - Boolean
|
|
transcribeEndedAtNotNil - Boolean
|
|
transcribeStatus - VideoTranscribeStatus
|
transcribe_status field predicates |
transcribeStatusNEQ - VideoTranscribeStatus
|
|
transcribeStatusIn - [VideoTranscribeStatus!]
|
|
transcribeStatusNotIn - [VideoTranscribeStatus!]
|
|
transcribeStatusIsNil - Boolean
|
|
transcribeStatusNotNil - Boolean
|
|
transcribeError - String
|
transcribe_error field predicates |
transcribeErrorNEQ - String
|
|
transcribeErrorIn - [String!]
|
|
transcribeErrorNotIn - [String!]
|
|
transcribeErrorGT - String
|
|
transcribeErrorGTE - String
|
|
transcribeErrorLT - String
|
|
transcribeErrorLTE - String
|
|
transcribeErrorContains - String
|
|
transcribeErrorHasPrefix - String
|
|
transcribeErrorHasSuffix - String
|
|
transcribeErrorIsNil - Boolean
|
|
transcribeErrorNotNil - Boolean
|
|
transcribeErrorEqualFold - String
|
|
transcribeErrorContainsFold - String
|
|
generateInsightsStartedAt - Time
|
generate_insights_started_at field predicates |
generateInsightsStartedAtNEQ - Time
|
|
generateInsightsStartedAtIn - [Time!]
|
|
generateInsightsStartedAtNotIn - [Time!]
|
|
generateInsightsStartedAtGT - Time
|
|
generateInsightsStartedAtGTE - Time
|
|
generateInsightsStartedAtLT - Time
|
|
generateInsightsStartedAtLTE - Time
|
|
generateInsightsStartedAtIsNil - Boolean
|
|
generateInsightsStartedAtNotNil - Boolean
|
|
generateInsightsEndedAt - Time
|
generate_insights_ended_at field predicates |
generateInsightsEndedAtNEQ - Time
|
|
generateInsightsEndedAtIn - [Time!]
|
|
generateInsightsEndedAtNotIn - [Time!]
|
|
generateInsightsEndedAtGT - Time
|
|
generateInsightsEndedAtGTE - Time
|
|
generateInsightsEndedAtLT - Time
|
|
generateInsightsEndedAtLTE - Time
|
|
generateInsightsEndedAtIsNil - Boolean
|
|
generateInsightsEndedAtNotNil - Boolean
|
|
generateInsightsStatus - VideoGenerateInsightsStatus
|
generate_insights_status field predicates |
generateInsightsStatusNEQ - VideoGenerateInsightsStatus
|
|
generateInsightsStatusIn - [VideoGenerateInsightsStatus!]
|
|
generateInsightsStatusNotIn - [VideoGenerateInsightsStatus!]
|
|
generateInsightsStatusIsNil - Boolean
|
|
generateInsightsStatusNotNil - Boolean
|
|
generateInsightsError - String
|
generate_insights_error field predicates |
generateInsightsErrorNEQ - String
|
|
generateInsightsErrorIn - [String!]
|
|
generateInsightsErrorNotIn - [String!]
|
|
generateInsightsErrorGT - String
|
|
generateInsightsErrorGTE - String
|
|
generateInsightsErrorLT - String
|
|
generateInsightsErrorLTE - String
|
|
generateInsightsErrorContains - String
|
|
generateInsightsErrorHasPrefix - String
|
|
generateInsightsErrorHasSuffix - String
|
|
generateInsightsErrorIsNil - Boolean
|
|
generateInsightsErrorNotNil - Boolean
|
|
generateInsightsErrorEqualFold - String
|
|
generateInsightsErrorContainsFold - String
|
|
likelyAudience - String
|
likely_audience field predicates |
likelyAudienceNEQ - String
|
|
likelyAudienceIn - [String!]
|
|
likelyAudienceNotIn - [String!]
|
|
likelyAudienceGT - String
|
|
likelyAudienceGTE - String
|
|
likelyAudienceLT - String
|
|
likelyAudienceLTE - String
|
|
likelyAudienceContains - String
|
|
likelyAudienceHasPrefix - String
|
|
likelyAudienceHasSuffix - String
|
|
likelyAudienceIsNil - Boolean
|
|
likelyAudienceNotNil - Boolean
|
|
likelyAudienceEqualFold - String
|
|
likelyAudienceContainsFold - String
|
|
wordcloud - String
|
wordcloud field predicates |
wordcloudNEQ - String
|
|
wordcloudIn - [String!]
|
|
wordcloudNotIn - [String!]
|
|
wordcloudGT - String
|
|
wordcloudGTE - String
|
|
wordcloudLT - String
|
|
wordcloudLTE - String
|
|
wordcloudContains - String
|
|
wordcloudHasPrefix - String
|
|
wordcloudHasSuffix - String
|
|
wordcloudIsNil - Boolean
|
|
wordcloudNotNil - Boolean
|
|
wordcloudEqualFold - String
|
|
wordcloudContainsFold - String
|
|
termsPerMinute - Float
|
terms_per_minute field predicates |
termsPerMinuteNEQ - Float
|
|
termsPerMinuteIn - [Float!]
|
|
termsPerMinuteNotIn - [Float!]
|
|
termsPerMinuteGT - Float
|
|
termsPerMinuteGTE - Float
|
|
termsPerMinuteLT - Float
|
|
termsPerMinuteLTE - Float
|
|
speakMediaID - String
|
speak_media_id field predicates |
speakMediaIDNEQ - String
|
|
speakMediaIDIn - [String!]
|
|
speakMediaIDNotIn - [String!]
|
|
speakMediaIDGT - String
|
|
speakMediaIDGTE - String
|
|
speakMediaIDLT - String
|
|
speakMediaIDLTE - String
|
|
speakMediaIDContains - String
|
|
speakMediaIDHasPrefix - String
|
|
speakMediaIDHasSuffix - String
|
|
speakMediaIDIsNil - Boolean
|
|
speakMediaIDNotNil - Boolean
|
|
speakMediaIDEqualFold - String
|
|
speakMediaIDContainsFold - String
|
|
workflowID - String
|
workflow_id field predicates |
workflowIDNEQ - String
|
|
workflowIDIn - [String!]
|
|
workflowIDNotIn - [String!]
|
|
workflowIDGT - String
|
|
workflowIDGTE - String
|
|
workflowIDLT - String
|
|
workflowIDLTE - String
|
|
workflowIDContains - String
|
|
workflowIDHasPrefix - String
|
|
workflowIDHasSuffix - String
|
|
workflowIDIsNil - Boolean
|
|
workflowIDNotNil - Boolean
|
|
workflowIDEqualFold - String
|
|
workflowIDContainsFold - String
|
|
workflowRunID - String
|
workflow_run_id field predicates |
workflowRunIDNEQ - String
|
|
workflowRunIDIn - [String!]
|
|
workflowRunIDNotIn - [String!]
|
|
workflowRunIDGT - String
|
|
workflowRunIDGTE - String
|
|
workflowRunIDLT - String
|
|
workflowRunIDLTE - String
|
|
workflowRunIDContains - String
|
|
workflowRunIDHasPrefix - String
|
|
workflowRunIDHasSuffix - String
|
|
workflowRunIDIsNil - Boolean
|
|
workflowRunIDNotNil - Boolean
|
|
workflowRunIDEqualFold - String
|
|
workflowRunIDContainsFold - String
|
|
hasPost - Boolean
|
post edge predicates |
hasPostWith - [PostWhereInput!]
|
|
hasSuggestedLearningObjectives - Boolean
|
suggested_learning_objectives edge predicates |
hasSuggestedLearningObjectivesWith - [LearningObjectiveWhereInput!]
|
|
hasUserVideoEvents - Boolean
|
user_video_events edge predicates |
hasUserVideoEventsWith - [UserVideoEventWhereInput!]
|
|
hasCourse - Boolean
|
course edge predicates |
hasCourseWith - [CourseWhereInput!]
|
|
hasGoogleDriveFile - Boolean
|
google_drive_file edge predicates |
hasGoogleDriveFileWith - [GoogleDriveFileWhereInput!]
|
|
hasFaceDetectionRequest - Boolean
|
face_detection_request edge predicates |
hasFaceDetectionRequestWith - [FaceDetectRequestWhereInput!]
|
|
hasImages - Boolean
|
images edge predicates |
hasImagesWith - [ImageWhereInput!]
|
|
hasFrames - Boolean
|
frames edge predicates |
hasFramesWith - [VideoFrameWhereInput!]
|
|
hasImportedVideo - Boolean
|
imported_video edge predicates |
hasImportedVideoWith - [ImportedVideoWhereInput!]
|
Example
{}
WatchHistoryForLearningObjective
Fields
| Field Name | Description |
|---|---|
learningObjective - LearningObjective!
|
|
totalVideos - Int!
|
|
totalCredits - Float!
|
|
educationCredits - [EducationCredit!]!
|
|
surveyQuestions - [CertificateSurveyQuestion!]!
|
Example
{
"learningObjective": LearningObjective,
"totalVideos": 987,
"totalCredits": 123.45,
"educationCredits": [EducationCredit],
"surveyQuestions": [CertificateSurveyQuestion]
}
WorkExperience
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
institution - String!
|
The institution of the work experience. |
specialty - String!
|
The specialty of the work experience. |
title - String!
|
The title of the work experience. |
employment - WorkExperienceEmployment!
|
The employment type of the work experience. |
startDate - Time
|
The start date of the work experience. |
endDate - Time
|
The end date of the work experience. |
city - String!
|
The city of the work experience. |
state - String!
|
The state of the work experience. |
user - User
|
The user that the work experience is for. |
Example
{
"id": "4",
"institution": "abc123",
"specialty": "abc123",
"title": "xyz789",
"employment": "full_time",
"startDate": "10:15:30Z",
"endDate": "10:15:30Z",
"city": "xyz789",
"state": "abc123",
"user": User
}
WorkExperienceConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges - [WorkExperienceEdge]
|
A list of edges. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Identifies the total count of items in the connection. |
Example
{
"edges": [WorkExperienceEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
WorkExperienceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - WorkExperience
|
The item at the end of the edge. |
cursor - Cursor!
|
A cursor for use in pagination. |
Example
{
"node": WorkExperience,
"cursor": Cursor
}
WorkExperienceEmployment
Description
WorkExperienceEmployment is enum for the field employment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
{}
WorkExperienceWhereInput
Description
WorkExperienceWhereInput is used for filtering WorkExperience objects. Input was generated by ent.
Fields
| Input Field | Description |
|---|---|
not - WorkExperienceWhereInput
|
|
and - [WorkExperienceWhereInput!]
|
|
or - [WorkExperienceWhereInput!]
|
|
id - ID
|
id field predicates |
idNEQ - ID
|
|
idIn - [ID!]
|
|
idNotIn - [ID!]
|
|
idGT - ID
|
|
idGTE - ID
|
|
idLT - ID
|
|
idLTE - ID
|
|
institution - String
|
institution field predicates |
institutionNEQ - String
|
|
institutionIn - [String!]
|
|
institutionNotIn - [String!]
|
|
institutionGT - String
|
|
institutionGTE - String
|
|
institutionLT - String
|
|
institutionLTE - String
|
|
institutionContains - String
|
|
institutionHasPrefix - String
|
|
institutionHasSuffix - String
|
|
institutionEqualFold - String
|
|
institutionContainsFold - String
|
|
specialty - String
|
specialty field predicates |
specialtyNEQ - String
|
|
specialtyIn - [String!]
|
|
specialtyNotIn - [String!]
|
|
specialtyGT - String
|
|
specialtyGTE - String
|
|
specialtyLT - String
|
|
specialtyLTE - String
|
|
specialtyContains - String
|
|
specialtyHasPrefix - String
|
|
specialtyHasSuffix - String
|
|
specialtyEqualFold - String
|
|
specialtyContainsFold - String
|
|
title - String
|
title field predicates |
titleNEQ - String
|
|
titleIn - [String!]
|
|
titleNotIn - [String!]
|
|
titleGT - String
|
|
titleGTE - String
|
|
titleLT - String
|
|
titleLTE - String
|
|
titleContains - String
|
|
titleHasPrefix - String
|
|
titleHasSuffix - String
|
|
titleEqualFold - String
|
|
titleContainsFold - String
|
|
employment - WorkExperienceEmployment
|
employment field predicates |
employmentNEQ - WorkExperienceEmployment
|
|
employmentIn - [WorkExperienceEmployment!]
|
|
employmentNotIn - [WorkExperienceEmployment!]
|
|
startDate - Time
|
start_date field predicates |
startDateNEQ - Time
|
|
startDateIn - [Time!]
|
|
startDateNotIn - [Time!]
|
|
startDateGT - Time
|
|
startDateGTE - Time
|
|
startDateLT - Time
|
|
startDateLTE - Time
|
|
startDateIsNil - Boolean
|
|
startDateNotNil - Boolean
|
|
endDate - Time
|
end_date field predicates |
endDateNEQ - Time
|
|
endDateIn - [Time!]
|
|
endDateNotIn - [Time!]
|
|
endDateGT - Time
|
|
endDateGTE - Time
|
|
endDateLT - Time
|
|
endDateLTE - Time
|
|
endDateIsNil - Boolean
|
|
endDateNotNil - Boolean
|
|
city - String
|
city field predicates |
cityNEQ - String
|
|
cityIn - [String!]
|
|
cityNotIn - [String!]
|
|
cityGT - String
|
|
cityGTE - String
|
|
cityLT - String
|
|
cityLTE - String
|
|
cityContains - String
|
|
cityHasPrefix - String
|
|
cityHasSuffix - String
|
|
cityEqualFold - String
|
|
cityContainsFold - String
|
|
state - String
|
state field predicates |
stateNEQ - String
|
|
stateIn - [String!]
|
|
stateNotIn - [String!]
|
|
stateGT - String
|
|
stateGTE - String
|
|
stateLT - String
|
|
stateLTE - String
|
|
stateContains - String
|
|
stateHasPrefix - String
|
|
stateHasSuffix - String
|
|
stateEqualFold - String
|
|
stateContainsFold - String
|
|
hasUser - Boolean
|
user edge predicates |
hasUserWith - [UserWhereInput!]
|
Example
{}