SMObject

Fields

`absence`

Type: Absence

Absence linked to this object. Returns null when the object is not of the matching SysType.

`accessGroup`

Type: AccessGroup

Access group linked to this object. Returns null when the object is not of the matching SysType.

`accessStates`

Type: [ObjectAccessRightState!]!

Access states linked to this object. Returns null when the object is not of the matching SysType.

Arguments

accessRights: [AccessRight!] — default: [] — Get state of this rights. If empty, all rights are returned.

`accountingItems`

Type: [CurrentAccountingItem!]

Lists all available accounting items with the current value (if any).

Arguments

filterUnset: Boolean — default: false — Filter accounting items where the user has not set and values valid at current date / time.
hideHiddenTypes: Boolean — default: false — Filter accounting items where the itemType is set hidden

`accountingItemsAsText`

Type: String

Lists all available accounting items with the current value as text

`aclInherit`

Type: Boolean

`acls`

Type: [ObjectAcl!]!

Acls linked to this object. Returns null when the object is not of the matching SysType.

Arguments

showInherited: Boolean — default: false — Show inherited for the operation.

`address`

Type: Address

Address linked to this object. Returns null when the object is not of the matching SysType.

`announcement`

Type: Announcement

Announcement linked to this object. Returns null when the object is not of the matching SysType.

`announcementCategory`

Type: AnnouncementCategory

Announcement category linked to this object. Returns null when the object is not of the matching SysType.

`apprenticeshipContract`

Type: ApprenticeshipContract

Apprenticeship contract linked to this object. Returns null when the object is not of the matching SysType.

`article`

Type: Article

Article linked to this object. Returns null when the object is not of the matching SysType.

`assignment`

Type: Assignment

Assignment linked to this object. Returns null when the object is not of the matching SysType.

`attachedToObjectMember`

Type: Member

Attached to object member linked to this object. Returns null when the object is not of the matching SysType.

`availableActions`

Type: ObjectActions!

Available actions linked to this object. Returns null when the object is not of the matching SysType.

`availableBulkMailings`

Type: [AvailableBulkMailing!]!

Available bulk mailings linked to this object. Returns null when the object is not of the matching SysType. Pass contextID (e.g. the course a teacher list is opened in) to include context-bound bulk mailings.

Arguments

contextID: UID — Object the selection happens in (e.g. the open course).

`availableProcessSteps`

Type: [AvailableProcessStep!]!

Available process steps linked to this object. Returns null when the object is not of the matching SysType.

`availableReports`

Type: [Report!]!

Available reports linked to this object. Returns null when the object is not of the matching SysType.

`bankAccount`

Type: BankAccount

Number of bank ac for this smobject.

`bill`

Type: Bill

Bill linked to this object. Returns null when the object is not of the matching SysType.

`bulkMailing`

Type: BulkMailing

Bulk mailing linked to this object. Returns null when the object is not of the matching SysType.

`campaign`

Type: Campaign

Campaign linked to this object. Returns null when the object is not of the matching SysType.

`case`

Type: Case

Case detail of this object. Returns null when the object is not of the matching SysType.

`categories`

Type: [ObjectCurrentCategory!]

Arguments

hideHidden: Boolean — default: true — Hide hidden for the operation.
onlyChecked: Boolean! — default: true — Only checked for the operation.

`categoriesAsString`

Type: String

Arguments

hideHidden: Boolean — default: true — Hide hidden for the operation.

`certificate`

Type: Certificate

Certificate linked to this object. Returns null when the object is not of the matching SysType.

`certificateType`

Type: CertificateType

Certificate type linked to this object. Returns null when the object is not of the matching SysType.

`cmsContent`

Type: CmsContent

Cms content linked to this object. Returns null when the object is not of the matching SysType.

`code`

Type: String

`company`

Type: Company

Company linked to this object. Returns null when the object is not of the matching SysType.

`contract`

Type: Contract

Contract linked to this object. Returns null when the object is not of the matching SysType.

`course`

Type: Course

Course linked to this object. Returns null when the object is not of the matching SysType.

`courseFramework`

Type: CourseFramework

Course framework linked to this object. Returns null when the object is not of the matching SysType.

`courseListing`

Type: CourseListing

Course listing linked to this object. Returns null when the object is not of the matching SysType.

`courseParticipant`

Type: CourseParticipant

Course participant linked to this object. Returns null when the object is not of the matching SysType.

`createdAt`

Type: DateTimeISO

`createdBy`

Type: Person

Person that created the object.

`currentLink`

Type: ObjectLink

The link that the current object is linked to the selected parent object. Only available if parentID is set in the query.

`customField`

Type: CustomFieldOnObject

Select one specific custom field by its custom field type id

Arguments

id: Int! — Id of the custom field definition type to select.

`customFields`

Type: [CustomFieldOnObject!]!

Custom fields linked to this object. Returns null when the object is not of the matching SysType.

`customNumber`

Type: String

`customer`

Type: Customer

Customer linked to this object. Returns null when the object is not of the matching SysType.

`customers`

Type: [Customer!]

Returns all customers for a object

`dashboard`

Type: Dashboard

Dashboard linked to this object. Returns null when the object is not of the matching SysType.

`deletionInfo`

Type: ObjectDeletionInfo

When and by whom the object was deleted. Null when the object was never set to status DELETED.

`disposeTemplate`

Type: DisposeTemplate

Dispose template linked to this object. Returns null when the object is not of the matching SysType.

`dossier`

Type: Dossier

Dossier linked to this object. Returns null when the object is not of the matching SysType.

`enrollmentForm`

Type: EnrollmentForm

Enrollment form linked to this object. Returns null when the object is not of the matching SysType.

`entry`

Type: Entry

Entry linked to this object. Returns null when the object is not of the matching SysType.

`event`

Type: Event

Event linked to this object. Returns null when the object is not of the matching SysType.

`eventSchedule`

Type: EventSchedule

Event schedule linked to this object. Returns null when the object is not of the matching SysType.

`exam`

Type: Exam

Exam linked to this object. Returns null when the object is not of the matching SysType.

`file`

Type: File

File linked to this object. Returns null when the object is not of the matching SysType.

`fileTag`

Type: FileTag

File tag linked to this object. Returns null when the object is not of the matching SysType.

`financialAccount`

Type: FinancialAccount

Number of financial ac for this smobject.

`folder`

Type: Folder

Folder linked to this object. Returns null when the object is not of the matching SysType.

`goal`

Type: Goal

Goal linked to this object. Returns null when the object is not of the matching SysType.

`group`

Type: Group

Group linked to this object. Returns null when the object is not of the matching SysType.

`hasChildren`

Type: Boolean!

Whether the smobject children.

Arguments

ignoreTreeHide: Boolean! — default: false — If true, treeHide children are also included

`hasJournalEntries`

Type: Boolean!

Whether the smobject journal entries.

`hasReports`

Type: Boolean!

Whether the smobject reports.

`history`

Type: [ObjectHistory!]!

History entries of changes on the object

`icon`

Type: ObjectIcon!

Get the icon of a object-type. If the object-type has no icon, it will return the sys-type or a default icon.

`id`

Type: ID!

ObjectID as a string

`importID`

Type: String

Custom ID of an import form a third-party system, for example.

`internship`

Type: Internship

Internship linked to this object. Returns null when the object is not of the matching SysType.

`isFavorite`

Type: Boolean!

Whether the smobject favorite.

`isMember`

Type: MembershipCheckResult!

Whether the smobject member.

Arguments

id: UID! — ID of the object to check membership for

`isSubscribed`

Type: Boolean!

Whether the smobject subscribed.

`journal`

Type: JournalEntry

Journal linked to this object. Returns null when the object is not of the matching SysType.

`journalEntries`

Type: [JournalEntry!]!

Journal entries linked to this object. Returns null when the object is not of the matching SysType.

`journalEntriesAsText`

Type: String!

Journal entries as formatted text for this smobject.

`journalEntry`

Type: JournalEntry

Journal entry linked to this object. Returns null when the object is not of the matching SysType.

`lastChange`

Type: ObjectHistory

Last change linked to this object. Returns null when the object is not of the matching SysType.

`lastChangedAt`

Type: DateTimeISO

Last changed date of the object. If includeCreate is true and no modifications are made, the creation date is returned.

Arguments

includeCreate: Boolean — default: false — Include create for the operation.

`lastChangedBy`

Type: Person

Person that has made the last change.

`lead`

Type: Lead

Lead linked to this object. Returns null when the object is not of the matching SysType.

`learnModule`

Type: LearnModule

Learn module linked to this object. Returns null when the object is not of the matching SysType.

`learningPath`

Type: LearningPath

Learning path linked to this object. Returns null when the object is not of the matching SysType.

`lessonSketch`

Type: LessonSketch

Lesson sketch linked to this object. Returns null when the object is not of the matching SysType.

`library`

Type: Library

Library linked to this object. Returns null when the object is not of the matching SysType.

`links`

Type: [ObjectLink!]!

Arguments

linkType: LinkTypeInput — Link type for the operation.
objectType: String — Object type identifier for the new or filtered object.

`listAcls`

Type: [AclObjectListResult!]!

List acls linked to this object. Returns null when the object is not of the matching SysType.

Arguments

personID: UID! — The objectID (UID) of the person to check ACLs for
right: AccessRight! — The access right to check (e.g., Read, Update, Delete)

`listView`

Type: ListView

List view linked to this object. Returns null when the object is not of the matching SysType.

`listingPlatform`

Type: ListingPlatform

Listing platform linked to this object. Returns null when the object is not of the matching SysType.

`locks`

Type: [ObjectLock!]!

`longName`

Type: String!

`mailTemplate`

Type: MailTemplate

Mail template linked to this object. Returns null when the object is not of the matching SysType.

`mailbox`

Type: Mailbox

Mailbox linked to this object. Returns null when the object is not of the matching SysType.

`managedByNgSchema`

Type: NgSchema

`mark`

Type: Mark

Mark linked to this object. Returns null when the object is not of the matching SysType.

`material`

Type: Material

Material linked to this object. Returns null when the object is not of the matching SysType.

`media`

Type: Media

Media linked to this object. Returns null when the object is not of the matching SysType.

`memberModels`

Type: [MemberModel!]!

Member models linked to this object. Returns null when the object is not of the matching SysType.

Arguments

id: Int — UID of the object to retrieve.

`memberResults`

Type: MemberResults!

List members of a object or attachedObjectID as results. This is the modern way.

Arguments

filter: MemberFilter! — default: "OnlyActive" — Filter for the operation.
noHiddenMemberTypes: Boolean! — default: false — No hidden member types for the operation.
options: MemberResultOptions — Filtering, sorting and paging options.

`memberShipModels`

Type: [MemberShipModel!]!

Member ship models linked to this object. Returns null when the object is not of the matching SysType.

Arguments

id: Int — UID of the object to retrieve.

`members`

Type: [Member!]!

List members of a object or attachedObjectID.

Arguments

filter: MemberFilter! — default: "OnlyActive" — Filter for the operation.
limit: Int — default: 100 — Maximum number of results to return.

`membersAsText`

Type: String!

Returns the members of this object as a string

Arguments

filter: MemberFilter! — default: "OnlyActive" — Filter for the operation.
limit: Int! — default: 10 — Maximum number of results to return.

`memberships`

Type: MemberResults!

Memberships linked to this object as paged results.

Arguments

filter: MembershipFilter! — default: "OnlyActive" — Filter for the operation.
filterUnimportantMembers: Boolean! — default: false — Filter unimportant members. Currently memberships from Dossier, Task are filtered.
noHiddenMemberTypes: Boolean! — default: false — No hidden member types for the operation.
options: MemberResultOptions — Paging options. Without options all memberships are returned; a person can have thousands (e.g. auto-generated instructor memberships), so list views should always page.

`menu`

Type: [MenuItem!]!

Menu linked to this object. Returns null when the object is not of the matching SysType.

`message`

Type: Message

Message linked to this object. Returns null when the object is not of the matching SysType.

`messageFolder`

Type: MessageFolder

Message folder linked to this object. Returns null when the object is not of the matching SysType.

`name`

Type: String!

`numbering`

Type: Numbering

`objectGuid`

Type: String!

`objectID`

Type: String!

`objectName`

Type: String

Object name linked to this object. Returns null when the object is not of the matching SysType.

Arguments

language: String — Language for the operation.
type: String! — Type for the operation.

`objectType`

Type: SMObjectType!

`objectTypeID`

Type: String!

`opportunityGroup`

Type: OpportunityGroup

Opportunity group linked to this object. Returns null when the object is not of the matching SysType.

`orderNr`

Type: Float

`orderType`

Type: OrderType

`owner`

Type: Person

The owner person of the object. The creator of a object is the default owner.

`parent`

Type: SMObject

`parentObjectID`

Type: Int!

`parents`

Type: [ObjectParent!]!

`payment`

Type: Payment

Payment linked to this object. Returns null when the object is not of the matching SysType.

`paymentRun`

Type: PaymentRun

Payment run linked to this object. Returns null when the object is not of the matching SysType.

`person`

Type: Person

Person linked to this object. Returns null when the object is not of the matching SysType.

`personLeave`

Type: PersonLeave

Person leave linked to this object. Returns null when the object is not of the matching SysType.

`plannedCourseSlot`

Type: PlannedCourseSlot

Planned course slot linked to this object. Returns null when the object is not of the matching SysType.

`plannedOffering`

Type: PlannedOffering

Planned offering linked to this object. Returns null when the object is not of the matching SysType.

`planningPeriod`

Type: PlanningPeriod

Planning period linked to this object. Returns null when the object is not of the matching SysType.

`planningScenario`

Type: PlanningScenario

Planning scenario linked to this object. Returns null when the object is not of the matching SysType.

Protocol of the task runs executed on this object, newest first.

`query`

Type: ObjectQuery

Query linked to this object. Returns null when the object is not of the matching SysType.

`queryPrecalc`

Type: QueryPrecalc

Query precalc linked to this object. Returns null when the object is not of the matching SysType.

`question`

Type: Question

Question linked to this object. Returns null when the object is not of the matching SysType.

`questionPool`

Type: QuestionPool

Question pool linked to this object. Returns null when the object is not of the matching SysType.

`quiz`

Type: Quiz

Quiz linked to this object. Returns null when the object is not of the matching SysType.

`quizSession`

Type: QuizSession

Quiz session linked to this object. Returns null when the object is not of the matching SysType.

`remarks`

Type: String

`report`

Type: Report

Report linked to this object. Returns null when the object is not of the matching SysType.

`resourceBusyByTerms`

Type: BusyLevel!

Indicates whether this object (resource) is busy during the specified time period. Checks for existing terms and returns the busy level. Optionally excludes a specific object from the check.

Arguments

excludeObjectID: Int — ObjectID to exclude from busy check (e.g., the current event being edited)
from: DateTimeISO — Start of the time period
to: DateTimeISO — End of the time period

`room`

Type: Room

Room linked to this object. Returns null when the object is not of the matching SysType.

`schoolReport`

Type: SchoolReport

School report linked to this object. Returns null when the object is not of the matching SysType.

`schoolReportTemplate`

Type: SchoolReportTemplate

School report template linked to this object. Returns null when the object is not of the matching SysType.

`screen`

Type: Screen

Screen linked to this object. Returns null when the object is not of the matching SysType.

`shortName`

Type: String

`site`

Type: Site

Site linked to this object. Returns null when the object is not of the matching SysType.

`specialType`

Type: String

Unique special ID of the object. Usefull to find predefined objects.

`sponsor`

Type: Sponsor

Sponsor linked to this object. Returns null when the object is not of the matching SysType.

`status`

Type: ObjectStatus

Status linked to this object. Returns null when the object is not of the matching SysType.

`statusHistory`

Type: [ObjectStatusHistory!]!

`subject`

Type: Subject

Subject linked to this object. Returns null when the object is not of the matching SysType.

`suffix`

Type: String

`suffixManual`

Type: Boolean

`survey`

Type: Survey

Survey linked to this object. Returns null when the object is not of the matching SysType.

`task`

Type: Task

Task linked to this object. Returns null when the object is not of the matching SysType.

`tenant`

Type: Tenant!

Tenant of the object

`tenantDetail`

Type: Tenant

Tenant detail linked to this object. Returns null when the object is not of the matching SysType.

`term`

Type: Term

Term linked to this object. Returns null when the object is not of the matching SysType.

`text`

Type: Text

Text linked to this object. Returns null when the object is not of the matching SysType.

`thumbnail`

Type: String!

Thumbnail linked to this object. Returns null when the object is not of the matching SysType.

`timePeriodRaster`

Type: TimePeriodRaster

Time period raster linked to this object. Returns null when the object is not of the matching SysType.

`timePeriodRasterItem`

Type: TimePeriodRasterItem

Time period raster item linked to this object. Returns null when the object is not of the matching SysType.

`training`

Type: Training

Training linked to this object. Returns null when the object is not of the matching SysType.

`trainingItem`

Type: TrainingItem

Training item linked to this object. Returns null when the object is not of the matching SysType.

`trainingParticipant`

Type: TrainingParticipant

Training participant linked to this object. Returns null when the object is not of the matching SysType.

`urlLink`

Type: UrlLink

Url link linked to this object. Returns null when the object is not of the matching SysType.

`validFrom`

Type: DateTimeISO

`validTo`

Type: DateTimeISO

`variant`

Type: Variant

Reusable variant definition for this object.

`yearPlan`

Type: YearPlan

Year plan linked to this object. Returns null when the object is not of the matching SysType.