Queries

List of available queries.

apiLog (

id: UUID!,

userId: UUID,

tenantId: UUID,

): ApiLog!
This query allows for the return of a single status and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include status name and values and associated workflow detials. **Returns:** Returns all specified status details from searched ID
apiLogs (

filterBy: [ApiLogFilterInput!],

sortBy: [ApiLogSortInput!],

limitBy: LimitInput,

userId: UUID,

tenantId: UUID,

): PagingResultOfApiLog!
This query allows for the return of staff members and all of their associated details based on search criteria.The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include... **Returns:** Returns an array of staff member information.
aspect (

aspectId: UUID!,

): Aspect!
This query allows for the return of a single aspect and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each aspect can include Organizational Units Assignations, Staff Member inforamtion and workflow details. **Returns:** Returns all specified aspect details from searched ID
aspects (

filterBy: [AspectFilterInput!],

sortBy: [AspectSortInput!],

limitBy: LimitInput,

): PagingResultOfAspect!
This query allows for the return of aspects and all of their associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each aspect can include Organizational Units Assignations, Staff Member inforamtion and workflow details. **Returns:** Returns an array of aspect information.
assignableReports (

filterBy: [AssignableReportFilterInput!],

sortBy: [AssignableReportSortInput!],

limitBy: LimitInput,

): PagingResultOfAssignableReport!
availableWorkflows (

organizationalUnitId: UUID!,

filterBy: [WorkflowFilterInput!],

sortBy: [WorkflowSortInput!],

limitBy: LimitInput,

): PagingResultOfWorkflow!
This query allows for the return of available workflows for a specific organizational unit and all of their associated details based on search criteria.The returned list is limited based on the permissions of the customers API Token. The information returned for each workflow can include information about aspects, clients, cases, organizations, reports, and tenants. **Returns:** Returns an array of available workflow information.
calendarEvent (

calendarEventId: UUID!,

): CalendarEvent!
This query allows for the return of a single calendar event and all of its associated details based on a search of calendarEventId. The returned list is limited based on the permissions of the customers API Token. The information returned for the calander event will be specific to the event, no additional information can be displayed with this query. **Returns:** Returns all specified Calendar Event details from searched ID.
calendarEvents (

filterBy: [CalendarEventFilterInput!],

limitBy: LimitInput,

): PagingResultOfCalendarEvent!
This query allows for the return of calendar events and all of the associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each calander event will be specific to the events in the filter, no additional information can be displayed with this query. **Returns:** Returns an array of calendar events and their information.
case (

caseId: UUID!,

): Case!
This query allows for the return of a single case and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include information about aspects, clients, form submission, organizations, reports, tenants and workflows. **Returns:** Returns all specified case details from searched ID.
caseFormSubmissionRequest (

caseFormSubmissionRequestId: UUID!,

includeNotOwned: Boolean!,

): CaseFormSubmissionRequest!
caseFormSubmissionRequests (

filterBy: [CaseFormSubmissionRequestFilterInput!],

sortBy: [CaseFormSubmissionRequestSortInput!],

limitBy: LimitInput,

includeNotOwned: Boolean!,

): PagingResultOfCaseFormSubmissionRequest!
cases (

filterBy: [CaseFilterInput!],

sortBy: [CaseSortInput!],

limitBy: LimitInput,

): PagingResultOfCase!
This query allows for the return of cases and all of their associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include information about aspects, clients, form submission, organizations, reports, tenants and workflows. **Returns:** Returns an array of case information.
client (

clientId: UUID!,

): Client!
This query allows for the return of a single clients and their details from a search of ID. The returned result is limited based on the permissions of the customers API Token. The information returned for each client can include demographics, contact information, information related to cases and tools. **Returns:** Returns an array of client information.
clientMergeProcess (

processId: UUID!,

): MergeClientsProcess!
clientMergeProcesses (

filterBy: [MergeClientsProcessFilterInput!],

sortBy: [MergeClientsProcessSortInput!],

limitBy: LimitInput,

): PagingResultOfMergeClientsProcess!
clientMergeProcessesLogs (

filterBy: [MergeClientsProcessLogFilterInput!],

sortBy: [MergeClientsProcessLogSortInput!],

limitBy: LimitInput,

): PagingResultOfMergeClientsProcessLog!
clientMergeProcessLog (

processLogId: UUID!,

): BackgroundJobLogEntry!
clients (

filterBy: [ClientFilterInput!],

sortBy: ClientSortInput,

limitBy: LimitInput,

): PagingResultOfClient!
This query returns list of clients and their details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each client can include demographics, contact information, information related to cases and tools. **Returns:** Returns an array of client information.
decodePublicReference (

reference: String!,

): PublicReference!
emailMessageToClientProcess (

processId: UUID!,

): BackgroundJob!
emailMessageToClientProcesses (

filterBy: [EmailMessageToClientProcessFilterInput!],

sortBy: [EmailMessageToClientProcessSortInput!],

limitBy: LimitInput,

): PagingResultOfBackgroundJob!
emailMessageToClientProcessesLogs (

filterBy: [EmailMessageToClientProcessLogFilterInput!],

sortBy: [EmailMessageToClientProcessLogSortInput!],

limitBy: LimitInput,

): PagingResultOfBackgroundJobLogEntry!
emailMessageToClientProcessLog (

processLogId: UUID!,

): BackgroundJobLogEntry!
environment: Environment
formConfiguration (

formConfigurationId: UUID!,

): FormConfiguration!
This query allows for the return of a single form configuration and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each form configurations can include aspect details, form definition and workflow details. **Returns:** Returns all specified Form Configurations and details from searched ID.
formConfigurations (

filterBy: [FormConfigurationFilterInput!],

sortBy: [FormConfigurationSortInput!],

limitBy: LimitInput,

): PagingResultOfFormConfiguration!
This query allows for the return of form configurations and all of their associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each form configurations can include aspect details, form definition and workflow details. **Returns:** Returns an array of form configurations and their information.
formDefinition (

formDefinitionId: UUID,

formDefinitionVersionId: UUID,

): FormDefinition!
formDefinitions (

filterBy: [FormDefinitionFilterInput!],

sortBy: [FormDefinitionSortInput!],

limitBy: LimitInput,

): PagingResultOfFormDefinition!
importDataTransformations: [DataTransformationInfo!]!
importDefinition (

definitionId: UUID!,

): ImportDefinition!
importDefinitions (

filterBy: [ImportDefinitionFilterInput!],

sortBy: [ImportDefinitionSortInput!],

limitBy: LimitInput,

): PagingResultOfImportDefinition!
importer (

id: UUID!,

userId: UUID,

tenantId: UUID,

): Importer!
This query allows for the return of a single status and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include status name and values and associated workflow detials. **Returns:** Returns all specified status details from searched ID
importers (

filterBy: [ImporterFilterInput!],

sortBy: [ImporterSortInput!],

limitBy: LimitInput,

userId: UUID,

tenantId: UUID,

): PagingResultOfImporter!
This query allows for the return of staff members and all of their associated details based on search criteria.The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include... **Returns:** Returns an array of staff member information.
importJob (

jobId: UUID!,

): ImportJob!
importJobs (

filterBy: [ImportJobFilterInput!],

sortBy: [ImportJobSortInput!],

limitBy: LimitInput,

): PagingResultOfImportJob!
importSources: [DataImportSourceInfo!]!
importTargetExecuteConditions: [ExecutionConditionInfo!]!
importTargets: [DataImportTargetInfo!]!
knownAutomationActions: [AutomationActionInfo!]!
knownConditions: [ConditionInfo!]!
knownDomainMessages (

caseEventOnly: Boolean!,

): [DomainMessageInfo]!
knownUserInteractions: [String!]!
lookup (

lookupId: UUID!,

): Lookup!
lookups (

filterBy: [LookupFilterInput!],

sortBy: [LookupSortInput!],

limitBy: LimitInput,

): PagingResultOfLookup!
lookupValues (

lookupId: UUID!,

lookupVersionId: UUID,

filterBy: [LookupValueFilterInput!],

sortBy: [LookupValueSortInput!],

limitBy: LimitInput,

): PagingResultOfLookupValue!
message (

messageId: UUID!,

): Message!
messages (

filterBy: [MessageFilterInput!],

sortBy: [MessageSortInput!],

limitBy: LimitInput,

): PagingResultOfMessage!
notifications (

filterBy: [NotificationFilterInput!],

sortBy: [NotificationSortInput!],

limitBy: LimitInput,

userId: UUID,

tenantId: UUID,

): PagingResultOfNotification!
This query allows for the return of Notifications and all of the associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each Notification can include notification details and information regarding the user. **Returns:** Returns an array of notification information.
notificationsSettings (

userId: UUID,

tenantId: UUID,

): [UserNotificationTypeSetting!]!
This query allows for the return of notification settings of a user and all of the associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token.The information returned for the notification settings will be specific to the user profile, no additional information can be displayed with this query. **Returns:** Returns all specified notification settings of a user or tenant.
organizationalUnit (

organizationalUnitId: UUID,

tenantId: UUID,

): OrganizationalUnit!
This query allows for the return of a single organizational unit and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token.The information returned for each case can include information about staff members, cases, clients, organizations, tenants and workflow information. **Returns:** Returns all specified organizational unit details from searched ID.
organizationalUnits (

filterBy: [OrganizationalUnitFilterInput!],

sortBy: [OrganizationalUnitSortInput!],

limitBy: LimitInput,

): PagingResultOfOrganizationalUnit!
This query allows for the return of organizational units and all of their associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include information about staff members, cases, clients, organizations, tenants and workflow information. **Returns:** Returns an array of organizational unit information.
permissionsDefinitions: CasesManagementPermissionsSheet!
Lists all possible permissions in the Qualo Cases Management permissions sheet.
publicApiClient (

apiClientId: UUID!,

): PublicApiClient!
publicApiClients (

filterBy: [PublicApiClientFilterInput!],

sortBy: [PublicApiClientSortInput!],

limitBy: LimitInput,

): PagingResultOfPublicApiClient!
publicReference (

id: UUID!,

): PublicReference!
reportToken (

reportId: UUID!,

tenantId: UUID,

): EmbedResult!
restrictedClient (

clientId: UUID!,

): RestrictedClient!
This query return a single client and their details from a search of ID. The returned result is limited based on the permissions of the customers API Token. It searches in all organizational units where client has View or RestrictedView permission. **Returns:** Returns an array of client information.
restrictedClients (

filterBy: RestrictedClientFilterInput!,

sortBy: [RestrictedClientSortInput!],

limitBy: LimitInput,

): PagingResultOfRestrictedClient!
This query returns list of clients and their basic details based on search criteria. The returned list is limited based on the permissions of the customers API Token. It searches in all organizational units where client has View or RestrictedView permission. **Returns:** Returns an array of client information.
roleDefinitions (

filterBy: [RoleFilterInput!],

sortBy: [RoleSortInput!],

limitBy: LimitInput,

): PagingResultOfRole!
This query returns all available roles based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include role name, definition, statuses and tenantID **Returns:** Returns an array of role information.
smsMessageToClientProcess (

processId: UUID!,

): SmsMessageToClientsProcess!
smsMessageToClientProcesses (

filterBy: [SmsMessageToClientsProcessFilterInput!],

sortBy: [SmsMessageToClientsProcessSortInput!],

limitBy: LimitInput,

): PagingResultOfSmsMessageToClientsProcess!
smsMessageToClientProcessesLogs (

filterBy: [SmsMessageToClientsProcessLogFilterInput!],

sortBy: [SmsMessageToClientsProcessLogSortInput!],

limitBy: LimitInput,

): PagingResultOfSmsMessageToClientsProcessLog!
smsMessageToClientProcessLog (

processLogId: UUID!,

): SmsMessageToClientsProcessLog!
staffMember (

staffMemberId: UUID!,

): StaffMember!
This query allows for the return of a single staff members and all of their associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include **Returns:** Returns all specified staff member details from searched ID
staffMembers (

filterBy: [StaffMemberFilterInput!],

sortBy: StaffMemberSortInput,

limitBy: LimitInput,

): PagingResultOfStaffMember!
This query allows for the return of staff members and all of their associated details based on search criteria.The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include... **Returns:** Returns an array of staff member information.
status (

statusId: UUID!,

): Status!
This query allows for the return of a single status and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include status name and values and associated workflow detials. **Returns:** Returns all specified status details from searched ID
statuses (

filterBy: [StatusFilterInput!],

sortBy: [StatusSortInput!],

limitBy: LimitInput,

): PagingResultOfStatus!
This query returns all available statuses based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each case can include status name and values and associated workflow detials **Returns:** Returns an array of statuses information.
workflow (

workflowId: UUID!,

): Workflow!
This query allows for the return of a single workflow and all of its associated details based on a search of ID. The returned list is limited based on the permissions of the customers API Token. The information returned for each workflow can include information about aspects, clients, cases, organizations, reports, and tenants. **Returns:** Returns all specified workflow details from searched ID.
workflows (

filterBy: [WorkflowFilterInput!],

sortBy: [WorkflowSortInput!],

limitBy: LimitInput,

): PagingResultOfWorkflow!
This query allows for the return of workflows and all of their associated details based on search criteria. The returned list is limited based on the permissions of the customers API Token. The information returned for each workflow can include information about aspects, clients, cases, organizations, reports, and tenants. **Returns:** Returns an array of workflow information.