WeSoar API Documentation v2.2.11
This document is intended to provide developers with the necessary information to interact with the APIs used in the WeSoar platform. The WeSoar platform is designed to provide conversational performance management and employee engagement surveys for organizations. It is built using the MERN stack, which is a popular technology stack for building web applications using MongoDB, Express.js, React.js, and Node.js.
The APIs used in the WeSoar platform are built using GraphQL, which is a query language for APIs that was developed by Facebook. GraphQL provides a flexible and efficient way to request data from APIs, which is essential for the performance management and engagement surveys provided by WeSoar. The WeSoar platform is hosted on Microsoft Azure using Kubernetes, which is a container orchestration platform that allows for easy scaling and management of the resources of the platform. In this documentation, we will provide an overview of the WeSoar APIs, including what endpoints are available, what parameters are required, and what responses can be expected. We hope this documentation will help you integrate the WeSoar platform into your own projects and improve the performance management and employee engagement of your organization.
API Endpoints
https://live.wesoar.appQueries
alarm
Example
Query
query alarm($_id: String!) {
alarm(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"alarm": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 123,
"isActive": true
}
}
}
alarmsPage
Response
Returns an AlarmsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query alarmsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
alarmsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...AlarmFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"alarmsPage": {
"docs": [Alarm],
"pageInfo": PageInfo
}
}
}
appraisal
Response
Returns an Appraisal!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query appraisal($_id: ObjectID!) {
appraisal(_id: $_id) {
_id
termProgramId
appraisalRating {
...AppraisalRatingFragment
}
appraisalDate
name
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
appraisalGoalsPage {
...GoalsPageFragment
}
priority
appraisalStatus
appraisalCalculation
isDeleted
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"appraisal": {
"_id": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"appraisalRating": AppraisalRating,
"appraisalDate": 1592577642,
"name": "abc123",
"commentsPage": CommentsPage,
"comment": Comment,
"appraisalGoalsPage": GoalsPage,
"priority": 987,
"appraisalStatus": "xyz789",
"appraisalCalculation": "xyz789",
"isDeleted": true
}
}
}
appraisalsFact
Response
Returns [Fact]
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
factsOptions - FactOptions
|
Example
Query
query appraisalsFact(
$searchOptions: SearchOptions,
$factsOptions: FactOptions
) {
appraisalsFact(
searchOptions: $searchOptions,
factsOptions: $factsOptions
) {
key
values
}
}
Variables
{
"searchOptions": SearchOptions,
"factsOptions": FactOptions
}
Response
{
"data": {
"appraisalsFact": [
{"key": "abc123", "values": [{}]}
]
}
}
appraisalsPage
Response
Returns an AppraisalsPage!
Arguments
| Name | Description |
|---|---|
params - SearchOptions
|
|
options - ListOptions
|
Example
Query
query appraisalsPage(
$params: SearchOptions,
$options: ListOptions
) {
appraisalsPage(
params: $params,
options: $options
) {
docs {
...AppraisalFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"params": SearchOptions,
"options": ListOptions
}
Response
{
"data": {
"appraisalsPage": {
"docs": [Appraisal],
"pageInfo": PageInfo
}
}
}
attendance
Response
Returns an Attendance!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query attendance($_id: ObjectID!) {
attendance(_id: $_id) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
userId
attendanceLogs {
...AttendanceLogFragment
}
isActive
isDeleted
attendanceLogsPage {
...AttendanceLogsPageFragment
}
attendanceLogForDate {
...AttendanceLogFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"attendance": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": false,
"isDeleted": false,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
}
}
attendancesPage
Response
Returns an AttendancesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query attendancesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
attendancesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...AttendanceFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"attendancesPage": {
"docs": [Attendance],
"pageInfo": PageInfo
}
}
}
checkIn
Example
Query
query checkIn($_id: ObjectID!) {
checkIn(_id: $_id) {
_id
name
checkInType
termProgramId
userId
programId
checkInSetting {
...CheckInSettingFragment
}
checkInDate
checkInRatings {
...CheckInRatingFragment
}
priority
checkInStatus
user {
...UserFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
competencies {
...SurveyQuestionFragment
}
competenciesFPage {
...SurveyQuestionFragment
}
competenciesPage {
...SurveyQuestionsPageFragment
}
isDeleted
latestRating {
...CheckInRatingFragment
}
checkInRatingsPage {
...CheckInRatingsPageFragment
}
checkInRatingsFPage {
...CheckInRatingFragment
}
checkInRatingsFOne {
...CheckInRatingFragment
}
commentTrailId
isActiveForEmp
isActiveForManager
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"checkIn": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"checkInType": "abc123",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 987,
"checkInStatus": "abc123",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": true,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": false,
"isActiveForManager": true
}
}
}
checkInsFact
Response
Returns [Fact]
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
factsOptions - FactOptions
|
Example
Query
query checkInsFact(
$searchOptions: SearchOptions,
$factsOptions: FactOptions
) {
checkInsFact(
searchOptions: $searchOptions,
factsOptions: $factsOptions
) {
key
values
}
}
Variables
{
"searchOptions": SearchOptions,
"factsOptions": FactOptions
}
Response
{
"data": {
"checkInsFact": [
{"key": "abc123", "values": [{}]}
]
}
}
checkInsPage
Response
Returns a CheckInsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query checkInsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
checkInsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...CheckInFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"checkInsPage": {
"docs": [CheckIn],
"pageInfo": PageInfo
}
}
}
comment
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
|
rootOptions - RootOptions
|
Example
Query
query comment(
$_id: ObjectID!,
$rootOptions: RootOptions
) {
comment(
_id: $_id,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"_id": "5e5677d71bdc2ae76344968c",
"rootOptions": RootOptions
}
Response
{
"data": {
"comment": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": false,
"isDeleted": false,
"commentDate": 1592577642,
"type": "xyz789",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
commentTrail
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
_id - ObjectID
|
|
rootOptions - RootOptions
|
Example
Query
query commentTrail(
$_id: ObjectID,
$rootOptions: RootOptions
) {
commentTrail(
_id: $_id,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"_id": "5e5677d71bdc2ae76344968c",
"rootOptions": RootOptions
}
Response
{
"data": {
"commentTrail": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": true,
"isDeleted": true,
"commentDate": 1592577642,
"type": "xyz789",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
commentTrailsPage
Response
Returns a CommentsPage
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
|
rootOptions - RootOptions
|
Example
Query
query commentTrailsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions,
$rootOptions: RootOptions
) {
commentTrailsPage(
searchOptions: $searchOptions,
listOptions: $listOptions,
rootOptions: $rootOptions
) {
docs {
...CommentFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions,
"rootOptions": RootOptions
}
Response
{
"data": {
"commentTrailsPage": {
"docs": [Comment],
"pageInfo": PageInfo
}
}
}
commentsPage
Response
Returns a CommentsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
|
rootOptions - RootOptions
|
Example
Query
query commentsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions,
$rootOptions: RootOptions
) {
commentsPage(
searchOptions: $searchOptions,
listOptions: $listOptions,
rootOptions: $rootOptions
) {
docs {
...CommentFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions,
"rootOptions": RootOptions
}
Response
{
"data": {
"commentsPage": {
"docs": [Comment],
"pageInfo": PageInfo
}
}
}
communicationEvent
Response
Returns a CommunicationEvent!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query communicationEvent($_id: ObjectID!) {
communicationEvent(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"communicationEvent": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 123,
"isActive": false
}
}
}
communicationEventsPage
Response
Returns a CommunicationEventsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query communicationEventsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
communicationEventsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...CommunicationEventFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"communicationEventsPage": {
"docs": [CommunicationEvent],
"pageInfo": PageInfo
}
}
}
communityGoal
Response
Returns a CommunityGoal!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query communityGoal($_id: ObjectID!) {
communityGoal(_id: $_id) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"communityGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "xyz789",
"trackingStatus": "xyz789",
"achievement": "xyz789",
"isCompanyGoal": true,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 987,
"goalProgress": 987.65,
"keyName": "xyz789",
"priority": 123,
"isActive": true,
"isDeleted": true,
"hash": "abc123",
"isParticipant": true,
"isSubscriber": false,
"isAdmin": false,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
}
}
communityGoalsPage
Response
Returns a CommunityGoalsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query communityGoalsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
communityGoalsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...CommunityGoalFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"communityGoalsPage": {
"docs": [CommunityGoal],
"pageInfo": PageInfo
}
}
}
conversation
Response
Returns a Conversation!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query conversation($_id: ObjectID!) {
conversation(_id: $_id) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"conversation": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"description": "xyz789",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "abc123",
"fldName": "abc123",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 123,
"isActive": false,
"isDeleted": false,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 987
}
}
}
conversationsPage
Response
Returns a ConversationsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query conversationsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
conversationsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ConversationFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"conversationsPage": {
"docs": [Conversation],
"pageInfo": PageInfo
}
}
}
dummy
Response
Returns a Boolean
Example
Query
query dummy {
dummy
}
Response
{"data": {"dummy": false}}
file
Response
Returns a File
Arguments
| Name | Description |
|---|---|
fileInput - File_Input
|
Example
Query
query file($fileInput: File_Input) {
file(fileInput: $fileInput) {
_id
fileName
fileKeyName
contentType
fileDate
fileUrl
fileSize
}
}
Variables
{"fileInput": File_Input}
Response
{
"data": {
"file": {
"_id": "5e5677d71bdc2ae76344968c",
"fileName": "xyz789",
"fileKeyName": "xyz789",
"contentType": "abc123",
"fileDate": 1592577642,
"fileUrl": "xyz789",
"fileSize": 987.65
}
}
}
goal
Example
Query
query goal($_id: ObjectID!) {
goal(_id: $_id) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"goal": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "abc123",
"goalType": "xyz789",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 123,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "xyz789",
"goalProgress": 987,
"priority": 123,
"isActive": true,
"isShowInPlannedTask": true,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
goalCategoriesPage
Response
Returns a GoalCategoriesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query goalCategoriesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
goalCategoriesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...GoalCategoryFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"goalCategoriesPage": {
"docs": [GoalCategory],
"pageInfo": PageInfo
}
}
}
goalCategory
Response
Returns a GoalCategory!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query goalCategory($_id: ObjectID!) {
goalCategory(_id: $_id) {
_id
name
keyName
iconUrl
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"goalCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"iconUrl": "xyz789",
"priority": 987,
"isActive": true
}
}
}
goalsPage
Response
Returns a GoalsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query goalsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
goalsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...GoalFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"goalsPage": {
"docs": [Goal],
"pageInfo": PageInfo
}
}
}
label
Example
Query
query label($_id: ObjectID!) {
label(_id: $_id) {
_id
name
keyName
isShowInPlannedTask
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"label": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"isShowInPlannedTask": true,
"priority": 123,
"isActive": true
}
}
}
labelsPage
Response
Returns a LabelsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query labelsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
labelsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...LabelFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"labelsPage": {
"docs": [Label],
"pageInfo": PageInfo
}
}
}
language
Example
Query
query language($_id: ObjectID!) {
language(_id: $_id) {
_id
name
keyName
priority
isActive
isRTL
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"language": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 123,
"isActive": true,
"isRTL": false
}
}
}
languagesPage
Response
Returns a LanguagesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query languagesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
languagesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...LanguageFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"languagesPage": {
"docs": [Language],
"pageInfo": PageInfo
}
}
}
managerType
Response
Returns a ManagerType!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query managerType($_id: ObjectID!) {
managerType(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"managerType": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 987,
"isActive": false
}
}
}
managerTypesPage
Response
Returns a ManagerTypesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query managerTypesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
managerTypesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ManagerTypeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"managerTypesPage": {
"docs": [ManagerType],
"pageInfo": PageInfo
}
}
}
masters
Response
Returns a Masters
Example
Query
query masters {
masters {
_id
yearsPage {
...YearsPageFragment
}
goalCategoriesPage {
...GoalCategoriesPageFragment
}
trackingStatusesPage {
...TrackingStatusesPageFragment
}
alarmsPage {
...AlarmsPageFragment
}
observationsPage {
...ObservationsPageFragment
}
labelsPage {
...LabelsPageFragment
}
tagsPage {
...TagsPageFragment
}
moduleCategoriesPage {
...ModuleCategoriesPageFragment
}
}
}
Response
{
"data": {
"masters": {
"_id": "5e5677d71bdc2ae76344968c",
"yearsPage": YearsPage,
"goalCategoriesPage": GoalCategoriesPage,
"trackingStatusesPage": TrackingStatusesPage,
"alarmsPage": AlarmsPage,
"observationsPage": ObservationsPage,
"labelsPage": LabelsPage,
"tagsPage": TagsPage,
"moduleCategoriesPage": ModuleCategoriesPage
}
}
}
me
Example
Query
query me($accessToken: String) {
me(accessToken: $accessToken) {
name
firstName
lastName
email
tenants {
...TenantFragment
}
}
}
Variables
{"accessToken": "xyz789"}
Response
{
"data": {
"me": {
"name": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"email": "abc123",
"tenants": [Tenant]
}
}
}
message
Example
Query
query message($_id: ObjectID!) {
message(_id: $_id) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"message": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "abc123",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": true,
"isDeleted": false,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
messagesPage
Response
Returns a MessagesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query messagesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
messagesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...MessageFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"messagesPage": {
"docs": [Message],
"pageInfo": PageInfo
}
}
}
module
Example
Query
query module($_id: ObjectID!) {
module(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"module": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 123,
"isActive": false
}
}
}
moduleCategoriesPage
Response
Returns a ModuleCategoriesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query moduleCategoriesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
moduleCategoriesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ModuleCategoryFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"moduleCategoriesPage": {
"docs": [ModuleCategory],
"pageInfo": PageInfo
}
}
}
moduleCategory
Response
Returns a ModuleCategory!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query moduleCategory($_id: ObjectID!) {
moduleCategory(_id: $_id) {
_id
name
keyName
modules {
...ModuleFragment
}
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"moduleCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"modules": [Module],
"priority": 987,
"isActive": true
}
}
}
modulesPage
Response
Returns a ModulesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query modulesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
modulesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ModuleFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"modulesPage": {
"docs": [Module],
"pageInfo": PageInfo
}
}
}
notification
Response
Returns a Notification!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query notification($_id: ObjectID!) {
notification(_id: $_id) {
_id
userId
termProgramId
notificationDate
messageData
payload
isOpened
messageText
messageTitle
messageUri
isActive
isDeleted
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"notification": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"notificationDate": 1592577642,
"messageData": {},
"payload": {},
"isOpened": false,
"messageText": "abc123",
"messageTitle": "abc123",
"messageUri": "abc123",
"isActive": false,
"isDeleted": true
}
}
}
notificationsPage
Response
Returns a NotificationsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query notificationsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
notificationsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...NotificationFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"notificationsPage": {
"docs": [Notification],
"pageInfo": PageInfo
}
}
}
observation
Response
Returns an Observation!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query observation($_id: ObjectID!) {
observation(_id: $_id) {
_id
name
keyName
isShowInPlannedTask
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"observation": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"isShowInPlannedTask": false,
"priority": 987,
"isActive": true
}
}
}
observationsPage
Response
Returns an ObservationsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query observationsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
observationsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ObservationFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"observationsPage": {
"docs": [Observation],
"pageInfo": PageInfo
}
}
}
orgUnit
Example
Query
query orgUnit($_id: ObjectID!) {
orgUnit(_id: $_id) {
_id
name
pid
keyName
priority
isActive
myRootOrg {
...OrgUnitFragment
}
childUnitsPage {
...OrgUnitsPageFragment
}
surveyReportWithPrevSurveyReport {
...SurveyReportFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"orgUnit": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"pid": "5e5677d71bdc2ae76344968c",
"keyName": "abc123",
"priority": 123,
"isActive": false,
"myRootOrg": OrgUnit,
"childUnitsPage": OrgUnitsPage,
"surveyReportWithPrevSurveyReport": SurveyReport
}
}
}
orgUnitsPage
Response
Returns an OrgUnitsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query orgUnitsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
orgUnitsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...OrgUnitFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"orgUnitsPage": {
"docs": [OrgUnit],
"pageInfo": PageInfo
}
}
}
organisation
Response
Returns an Organisation!
Arguments
| Name | Description |
|---|---|
id - ObjectID!
|
Example
Query
query organisation($id: ObjectID!) {
organisation(id: $id) {
_id
name
keyName
wesoarDomain
organisationGroup
contactPerson {
...Organisation_PersonFragment
}
registeredAddress {
...Organisation_AddressFragment
}
website
profilePicUrl
organisationSize
organisationIndustry
organisationType
organisationStatus
yearOfEstablishment
totalRevenue
objectives
activationCode
contractDetails {
...Organisation_ContractDetailsFragment
}
subscriptions {
...Organisation_SubscriptionFragment
}
defaultFieldMapping
technicalData {
...Organisation_TechnicalDataFragment
}
designSetting {
...Organisation_DesignSettingFragment
}
}
}
Variables
{"id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"organisation": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"wesoarDomain": "xyz789",
"organisationGroup": "xyz789",
"contactPerson": Organisation_Person,
"registeredAddress": Organisation_Address,
"website": "xyz789",
"profilePicUrl": "xyz789",
"organisationSize": "abc123",
"organisationIndustry": "xyz789",
"organisationType": "abc123",
"organisationStatus": "xyz789",
"yearOfEstablishment": 123,
"totalRevenue": 987,
"objectives": "xyz789",
"activationCode": "xyz789",
"contractDetails": [Organisation_ContractDetails],
"subscriptions": [Organisation_Subscription],
"defaultFieldMapping": "xyz789",
"technicalData": Organisation_TechnicalData,
"designSetting": Organisation_DesignSetting
}
}
}
organisationOverviewByDomain
Response
Returns an OrganisationOverviewByDomain!
Arguments
| Name | Description |
|---|---|
params - OrganisationOverviewByDomainParams!
|
Example
Query
query organisationOverviewByDomain($params: OrganisationOverviewByDomainParams!) {
organisationOverviewByDomain(params: $params) {
id
name
keyName
wesoarDomain
organisationGroup
contactPerson {
...Organisation_PersonFragment
}
registeredAddress {
...Organisation_AddressFragment
}
website
profilePicUrl
organisationSize
organisationIndustry
organisationType
organisationStatus
yearOfEstablishment
objectives
clientId
designSetting {
...Organisation_DesignSettingFragment
}
technicalData {
...Organisation_TechnicalDataFragment
}
}
}
Variables
{"params": OrganisationOverviewByDomainParams}
Response
{
"data": {
"organisationOverviewByDomain": {
"id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"wesoarDomain": "xyz789",
"organisationGroup": "abc123",
"contactPerson": Organisation_Person,
"registeredAddress": Organisation_Address,
"website": "abc123",
"profilePicUrl": "abc123",
"organisationSize": "xyz789",
"organisationIndustry": "abc123",
"organisationType": "abc123",
"organisationStatus": "abc123",
"yearOfEstablishment": 123,
"objectives": "abc123",
"clientId": "xyz789",
"designSetting": Organisation_DesignSetting,
"technicalData": Organisation_TechnicalData
}
}
}
organisations
Response
Returns an Organisations!
Example
Query
query organisations(
$search: String,
$cursor: String,
$limit: Int
) {
organisations(
search: $search,
cursor: $cursor,
limit: $limit
) {
edges {
...OrganisationFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"search": "abc123",
"cursor": "abc123",
"limit": 123
}
Response
{
"data": {
"organisations": {
"edges": [Organisation],
"pageInfo": PageInfo
}
}
}
plannedTask
Description
This is a query to retrive planned task from system access is only to employees.
Response
Returns a PlannedTask!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query plannedTask($_id: ObjectID!) {
plannedTask(_id: $_id) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"plannedTask": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "abc123",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "xyz789",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "abc123",
"priority": 123,
"isActive": true,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 987
}
}
}
plannedTasksPage
Response
Returns a PlannedTasksPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query plannedTasksPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
plannedTasksPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...PlannedTaskFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"plannedTasksPage": {
"docs": [PlannedTask],
"pageInfo": PageInfo
}
}
}
program
Example
Query
query program($_id: ObjectID!) {
program(_id: $_id) {
_id
yearId
programCategoryId
name
keyName
moduleKeyName
moduleCategoryKeyName
startDate
endDate
goalSetting {
...GoalSettingFragment
}
plannedTaskSetting {
...PlannedTaskSettingFragment
}
unplannedTaskSetting {
...UnplannedTaskSettingFragment
}
surveySetting {
...SurveySettingFragment
}
userFilterRules
status
programLabels
priority
isActive
isDeleted
year {
...YearFragment
}
programCategory {
...ProgramCategoryFragment
}
kanbanStage {
...KanbanStageFragment
}
impactStage {
...ImpactStageFragment
}
timelineStage {
...TimelineStageFragment
}
unplannedImpactStage {
...ImpactStageFragment
}
previousProgram {
...ProgramFragment
}
surveyReportsPage {
...SurveyReportsPageFragment
}
surveyReportsCount
surveyReport {
...SurveyReportFragment
}
filterOptions {
...FilterOptionFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"program": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programCategoryId": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"moduleKeyName": "abc123",
"moduleCategoryKeyName": "xyz789",
"startDate": 1592577642,
"endDate": 1592577642,
"goalSetting": GoalSetting,
"plannedTaskSetting": PlannedTaskSetting,
"unplannedTaskSetting": UnplannedTaskSetting,
"surveySetting": SurveySetting,
"userFilterRules": [{}],
"status": "abc123",
"programLabels": ["abc123"],
"priority": 123,
"isActive": false,
"isDeleted": true,
"year": Year,
"programCategory": ProgramCategory,
"kanbanStage": KanbanStage,
"impactStage": ImpactStage,
"timelineStage": TimelineStage,
"unplannedImpactStage": ImpactStage,
"previousProgram": Program,
"surveyReportsPage": SurveyReportsPage,
"surveyReportsCount": 123,
"surveyReport": SurveyReport,
"filterOptions": [FilterOption]
}
}
}
programCategoriesPage
Response
Returns a ProgramCategoriesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query programCategoriesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
programCategoriesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ProgramCategoryFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"programCategoriesPage": {
"docs": [ProgramCategory],
"pageInfo": PageInfo
}
}
}
programCategory
Response
Returns a ProgramCategory!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query programCategory($_id: ObjectID!) {
programCategory(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"programCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 987,
"isActive": true
}
}
}
programType
Response
Returns a ProgramType!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query programType($_id: ObjectID!) {
programType(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"programType": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 123,
"isActive": true
}
}
}
programTypesPage
Response
Returns a ProgramTypesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query programTypesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
programTypesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ProgramTypeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"programTypesPage": {
"docs": [ProgramType],
"pageInfo": PageInfo
}
}
}
programsPage
Response
Returns a ProgramsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query programsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
programsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ProgramFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"programsPage": {
"docs": [Program],
"pageInfo": PageInfo
}
}
}
report
Example
Query
query report($_id: ObjectID!) {
report(_id: $_id) {
_id
name
keyName
priority
isActive
isRTL
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"report": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 987,
"isActive": true,
"isRTL": true
}
}
}
reportsPage
Response
Returns a ReportsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query reportsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
reportsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...ReportFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"reportsPage": {
"docs": [Report],
"pageInfo": PageInfo
}
}
}
role
Example
Query
query role($_id: ObjectID!) {
role(_id: $_id) {
_id
name
keyName
parentRoleKeyName
ability {
...AbilityFragment
}
features
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"role": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"parentRoleKeyName": "xyz789",
"ability": [Ability],
"features": ["abc123"],
"priority": 123,
"isActive": true
}
}
}
rolesPage
Response
Returns a RolesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query rolesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
rolesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...RoleFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"rolesPage": {
"docs": [Role],
"pageInfo": PageInfo
}
}
}
startJob
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
jobQueueName - String
|
|
jobType - String
|
|
jobName - String
|
|
params - JSONObject
|
Example
Query
query startJob(
$jobQueueName: String,
$jobType: String,
$jobName: String,
$params: JSONObject
) {
startJob(
jobQueueName: $jobQueueName,
jobType: $jobType,
jobName: $jobName,
params: $params
)
}
Variables
{
"jobQueueName": "xyz789",
"jobType": "xyz789",
"jobName": "xyz789",
"params": {}
}
Response
{"data": {"startJob": true}}
supportTicket
Response
Returns a SupportTicket!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query supportTicket($_id: ObjectID!) {
supportTicket(_id: $_id) {
_id
userId
ticketType
comments {
...CommentFragment
}
ticketStatus
priority
isActive
commentsPage {
...CommentsPageFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"supportTicket": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"ticketType": "abc123",
"comments": [Comment],
"ticketStatus": "abc123",
"priority": 123,
"isActive": true,
"commentsPage": CommentsPage
}
}
}
supportTicketsPage
Response
Returns a SupportTicketsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query supportTicketsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
supportTicketsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SupportTicketFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"supportTicketsPage": {
"docs": [SupportTicket],
"pageInfo": PageInfo
}
}
}
surveyAnswerCategoriesPage
Response
Returns a SurveyAnswerCategoriesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyAnswerCategoriesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyAnswerCategoriesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyAnswerCategoryFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyAnswerCategoriesPage": {
"docs": [SurveyAnswerCategory],
"pageInfo": PageInfo
}
}
}
surveyAnswerCategory
Response
Returns a SurveyAnswerCategory!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveyAnswerCategory($_id: ObjectID!) {
surveyAnswerCategory(_id: $_id) {
_id
name
keyName
color
percentage
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveyAnswerCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"color": "abc123",
"percentage": 123.45,
"priority": 123,
"isActive": false
}
}
}
surveyLibrariesPage
Response
Returns a SurveyLibrariesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyLibrariesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyLibrariesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyLibraryFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyLibrariesPage": {
"docs": [SurveyLibrary],
"pageInfo": PageInfo
}
}
}
surveyLibrary
Response
Returns a SurveyLibrary!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveyLibrary($_id: ObjectID!) {
surveyLibrary(_id: $_id) {
_id
name
keyName
version
isSystem
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveyLibrary": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"version": "abc123",
"isSystem": true,
"priority": 987,
"isActive": true
}
}
}
surveyQuestion
Response
Returns a SurveyQuestion!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveyQuestion($_id: ObjectID!) {
surveyQuestion(_id: $_id) {
_id
surveyLibraryQuestionId
question {
...QuestionFragment
}
responseBySpecimenKey {
...SurveyResponseFragment
}
responseBySpecimenId {
...SurveyResponseFragment
}
isLibraryQuestion
conversion
stdDev
countResponses
scaleResponseSummary {
...ScaleResponseSummaryFragment
}
responsesByCheckInId {
...ResponseByCheckInFragment
}
sentiments {
...SentimentFragment
}
summary
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveyQuestion": {
"_id": "5e5677d71bdc2ae76344968c",
"surveyLibraryQuestionId": "5e5677d71bdc2ae76344968c",
"question": Question,
"responseBySpecimenKey": SurveyResponse,
"responseBySpecimenId": SurveyResponse,
"isLibraryQuestion": false,
"conversion": 987.65,
"stdDev": 987.65,
"countResponses": 987,
"scaleResponseSummary": [ScaleResponseSummary],
"responsesByCheckInId": [ResponseByCheckIn],
"sentiments": [Sentiment],
"summary": ["abc123"]
}
}
}
surveyQuestionFactor
Response
Returns a SurveyQuestionFactor!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveyQuestionFactor($_id: ObjectID!) {
surveyQuestionFactor(_id: $_id) {
_id
name
keyName
priority
isActive
conversion
stdDev
countQuestions
surveyAnswerCategories {
...SurveyAnswerCategoryFragment
}
overallRankWithGap {
...RankWithGapFragment
}
overallRank
overallGap
wordCloudWords {
...WordCloudWordFragment
}
sentiments {
...SentimentFragment
}
surveyAnswerCompositions {
...SurveyAnswerCategoryFragment
}
summary
responsesByCheckInId {
...ResponseByCheckInFragment
}
responsesTillCheckInId {
...ResponseByCheckInFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveyQuestionFactor": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 123,
"isActive": true,
"conversion": 987.65,
"stdDev": 123.45,
"countQuestions": 123,
"surveyAnswerCategories": [SurveyAnswerCategory],
"overallRankWithGap": RankWithGap,
"overallRank": 123,
"overallGap": 987.65,
"wordCloudWords": [WordCloudWord],
"sentiments": [Sentiment],
"surveyAnswerCompositions": [SurveyAnswerCategory],
"summary": ["abc123"],
"responsesByCheckInId": [ResponseByCheckIn],
"responsesTillCheckInId": [ResponseByCheckIn]
}
}
}
surveyQuestionFactorsPage
Response
Returns a SurveyQuestionFactorsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyQuestionFactorsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyQuestionFactorsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyQuestionFactorFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyQuestionFactorsPage": {
"docs": [SurveyQuestionFactor],
"pageInfo": PageInfo
}
}
}
surveyQuestionsByUserIdPage
Response
Returns a SurveyQuestionsPage!
Arguments
| Name | Description |
|---|---|
userId - ObjectID
|
|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyQuestionsByUserIdPage(
$userId: ObjectID,
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyQuestionsByUserIdPage(
userId: $userId,
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyQuestionFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"userId": "5e5677d71bdc2ae76344968c",
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyQuestionsByUserIdPage": {
"docs": [SurveyQuestion],
"pageInfo": PageInfo
}
}
}
surveyQuestionsPage
Response
Returns a SurveyQuestionsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyQuestionsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyQuestionsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyQuestionFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyQuestionsPage": {
"docs": [SurveyQuestion],
"pageInfo": PageInfo
}
}
}
surveyReport
Response
Returns a SurveyReport!
Example
Query
query surveyReport(
$programId: ObjectID!,
$userManagerId: ObjectID
) {
surveyReport(
programId: $programId,
userManagerId: $userManagerId
) {
reportMode
programId
userManagerId
orgUnitId
filters {
...SurveyReportFiltersFragment
}
grpFld
options {
...SurveyReportOptionsFragment
}
program {
...ProgramFragment
}
previousProgram {
...ProgramFragment
}
myEngReport {
...EngReportFragment
}
myPrevEngReport {
...EngReportFragment
}
myDDEngReport {
...EngReportFragment
}
myDDPrevEngReport {
...EngReportFragment
}
deptEngReport {
...EngReportFragment
}
deptPrevEngReport {
...EngReportFragment
}
deptDDEngReport {
...EngReportFragment
}
deptDDPrevEngReport {
...EngReportFragment
}
orgDDEngReport {
...EngReportFragment
}
orgDDPrevEngReport {
...EngReportFragment
}
}
}
Variables
{
"programId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c"
}
Response
{
"data": {
"surveyReport": {
"reportMode": "xyz789",
"programId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c",
"orgUnitId": "5e5677d71bdc2ae76344968c",
"filters": SurveyReportFilters,
"grpFld": "abc123",
"options": SurveyReportOptions,
"program": Program,
"previousProgram": Program,
"myEngReport": [EngReport],
"myPrevEngReport": [EngReport],
"myDDEngReport": [EngReport],
"myDDPrevEngReport": [EngReport],
"deptEngReport": [EngReport],
"deptPrevEngReport": [EngReport],
"deptDDEngReport": [EngReport],
"deptDDPrevEngReport": [EngReport],
"orgDDEngReport": [EngReport],
"orgDDPrevEngReport": [EngReport]
}
}
}
surveyReportsPage
Response
Returns a SurveyReportsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyReportsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyReportsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyReportFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyReportsPage": {
"docs": [SurveyReport],
"pageInfo": PageInfo
}
}
}
surveyResponse
Response
Returns a SurveyResponse!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveyResponse($_id: ObjectID!) {
surveyResponse(_id: $_id) {
_id
surveyForUserId
surveyQuestionId
choiceAnswers
scaleAnswer
textAnswer
isNotApplicable
remark
isActive
isDeleted
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveyResponse": {
"_id": "5e5677d71bdc2ae76344968c",
"surveyForUserId": "5e5677d71bdc2ae76344968c",
"surveyQuestionId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["xyz789"],
"scaleAnswer": 123,
"textAnswer": "xyz789",
"isNotApplicable": false,
"remark": "abc123",
"isActive": false,
"isDeleted": false
}
}
}
surveyResponsesByUserIdPage
Response
Returns a SurveyResponsesPage!
Arguments
| Name | Description |
|---|---|
userId - ObjectID
|
|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyResponsesByUserIdPage(
$userId: ObjectID,
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyResponsesByUserIdPage(
userId: $userId,
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyResponseFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"userId": "5e5677d71bdc2ae76344968c",
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyResponsesByUserIdPage": {
"docs": [SurveyResponse],
"pageInfo": PageInfo
}
}
}
surveyResponsesPage
Response
Returns a SurveyResponsesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyResponsesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyResponsesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyResponseFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyResponsesPage": {
"docs": [SurveyResponse],
"pageInfo": PageInfo
}
}
}
surveySpecimen
Response
Returns a SurveySpecimen!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveySpecimen($_id: ObjectID!) {
surveySpecimen(_id: $_id) {
_id
programId
program {
...ProgramFragment
}
userId
user {
...UserFragment
}
isOpen
isActive
responses {
...SurveyResponseFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
surveySpecimenKey
participants {
...UserFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveySpecimen": {
"_id": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"user": User,
"isOpen": true,
"isActive": false,
"responses": [SurveyResponse],
"surveyQuestions": [SurveyQuestion],
"surveySpecimenKey": "xyz789",
"participants": [User]
}
}
}
surveySpecimenByKey
Response
Returns a SurveySpecimen
Arguments
| Name | Description |
|---|---|
specimenKey - String!
|
Example
Query
query surveySpecimenByKey($specimenKey: String!) {
surveySpecimenByKey(specimenKey: $specimenKey) {
_id
programId
program {
...ProgramFragment
}
userId
user {
...UserFragment
}
isOpen
isActive
responses {
...SurveyResponseFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
surveySpecimenKey
participants {
...UserFragment
}
}
}
Variables
{"specimenKey": "xyz789"}
Response
{
"data": {
"surveySpecimenByKey": {
"_id": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"user": User,
"isOpen": true,
"isActive": false,
"responses": [SurveyResponse],
"surveyQuestions": [SurveyQuestion],
"surveySpecimenKey": "xyz789",
"participants": [User]
}
}
}
surveySpecimensByUserIdPage
Response
Returns a SurveySpecimensPage!
Arguments
| Name | Description |
|---|---|
userId - ObjectID
|
|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveySpecimensByUserIdPage(
$userId: ObjectID,
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveySpecimensByUserIdPage(
userId: $userId,
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveySpecimenFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"userId": "5e5677d71bdc2ae76344968c",
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveySpecimensByUserIdPage": {
"docs": [SurveySpecimen],
"pageInfo": PageInfo
}
}
}
surveySpecimensPage
Response
Returns a SurveySpecimensPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveySpecimensPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveySpecimensPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveySpecimenFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveySpecimensPage": {
"docs": [SurveySpecimen],
"pageInfo": PageInfo
}
}
}
surveyType
Response
Returns a SurveyType!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query surveyType($_id: ObjectID!) {
surveyType(_id: $_id) {
_id
name
keyName
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"surveyType": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 123,
"isActive": true
}
}
}
surveyTypesPage
Response
Returns a SurveyTypesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query surveyTypesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
surveyTypesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...SurveyTypeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"surveyTypesPage": {
"docs": [SurveyType],
"pageInfo": PageInfo
}
}
}
tag
Example
Query
query tag($_id: ObjectID!) {
tag(_id: $_id) {
_id
name
keyName
type
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"tag": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"type": "xyz789",
"priority": 987,
"isActive": true
}
}
}
termProgram
Response
Returns a TermProgram!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query termProgram($_id: ObjectID!) {
termProgram(_id: $_id) {
_id
name
userId
programId
assignDate
deAssignDate
isOpen
isActive
isDeleted
user {
...UserFragment
}
program {
...ProgramFragment
}
myCompanyGoalsPage {
...CommunityGoalsPageFragment
}
myCommunityGoalsPage {
...CommunityGoalsPageFragment
}
approvedGoalsPage {
...GoalsPageFragment
}
withObstacleGoalsPage {
...GoalsPageFragment
}
draftGoalsPage {
...GoalsPageFragment
}
trashedGoalsPage {
...GoalsPageFragment
}
taggedGoalsPage {
...GoalsPageFragment
}
checkInGoalsPage {
...GoalsPageFragment
}
approvedGoalsFacts {
...FactFragment
}
draftGoalsFacts {
...FactFragment
}
trashedGoalsFacts {
...FactFragment
}
taggedGoalsFacts {
...FactFragment
}
submittedGoalsFacts {
...FactFragment
}
goalsFacts {
...FactFragment
}
plannedTasksPage {
...PlannedTasksPageFragment
}
plannedTasksFacts {
...FactFragment
}
taggedPlannedTasksPage {
...PlannedTasksPageFragment
}
taggedPlannedTasksFacts {
...FactFragment
}
unplannedTasksPage {
...UnplannedTasksPageFragment
}
unplannedTasksFacts {
...FactFragment
}
attendancesPage {
...AttendancesPageFragment
}
attendancesFacts {
...FactFragment
}
checkInsPage {
...CheckInsPageFragment
}
checkInsFacts {
...FactFragment
}
appraisalsPage {
...AppraisalsPageFragment
}
appraisalsFacts {
...FactFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"termProgram": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"assignDate": 1592577642,
"deAssignDate": 1592577642,
"isOpen": true,
"isActive": false,
"isDeleted": false,
"user": User,
"program": Program,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"withObstacleGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"checkInGoalsPage": GoalsPage,
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"checkInsPage": CheckInsPage,
"checkInsFacts": [Fact],
"appraisalsPage": AppraisalsPage,
"appraisalsFacts": [Fact]
}
}
}
termProgramsByUserIdPage
Response
Returns a TermProgramsPage!
Arguments
| Name | Description |
|---|---|
userId - ObjectID
|
|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query termProgramsByUserIdPage(
$userId: ObjectID,
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
termProgramsByUserIdPage(
userId: $userId,
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...TermProgramFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"userId": "5e5677d71bdc2ae76344968c",
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"termProgramsByUserIdPage": {
"docs": [TermProgram],
"pageInfo": PageInfo
}
}
}
termprogramsPage
Response
Returns a TermProgramsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query termprogramsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
termprogramsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...TermProgramFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"termprogramsPage": {
"docs": [TermProgram],
"pageInfo": PageInfo
}
}
}
trackingStatus
Response
Returns a TrackingStatus!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query trackingStatus($_id: ObjectID!) {
trackingStatus(_id: $_id) {
_id
name
keyName
isGoalTrackingStatus
isTaskTrackingStatus
priority
isActive
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"trackingStatus": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"isGoalTrackingStatus": false,
"isTaskTrackingStatus": false,
"priority": 123,
"isActive": true
}
}
}
trackingStatusesPage
Response
Returns a TrackingStatusesPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query trackingStatusesPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
trackingStatusesPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...TrackingStatusFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"trackingStatusesPage": {
"docs": [TrackingStatus],
"pageInfo": PageInfo
}
}
}
unplannedTask
Response
Returns an UnplannedTask!
Arguments
| Name | Description |
|---|---|
_id - ObjectID!
|
Example
Query
query unplannedTask($_id: ObjectID!) {
unplannedTask(_id: $_id) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
unplannedTaskType
unplannedTaskDetail {
...UnplannedTaskDetailFragment
}
comments {
...CommentFragment
}
reactions {
...ReactionFragment
}
impactStageId
impactStage {
...ImpactStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
unplannedTaskCommentsFacts {
...FactFragment
}
myUnplannedTaskReaction {
...ReactionFragment
}
unplannedTaskReactionsFacts {
...FactFragment
}
unplannedTaskReactionsPage {
...ReactionsPageFragment
}
unplannedTasksFacts {
...FactFragment
}
views
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"unplannedTask": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "xyz789",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "abc123",
"priority": 123,
"isActive": true,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 123
}
}
}
unplannedTasksPage
Response
Returns an UnplannedTasksPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query unplannedTasksPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
unplannedTasksPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...UnplannedTaskFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"unplannedTasksPage": {
"docs": [UnplannedTask],
"pageInfo": PageInfo
}
}
}
user
Example
Query
query user($userNameOrId: String) {
user(userNameOrId: $userNameOrId) {
_id
userName
empCode
preferredName
firstName
lastName
email
mobileNumber
isEmailVerified
isMobileNumberVerified
imageUrl
profilePic {
...FileFragment
}
managers {
...ManagerFragment
}
orgUnits
designation
path
aboutMe
myStatus
isReportAppDiagnosticData
isActive
dummy
progress
overallGoalProgress
ytdRating
teamOverallGoalProgress
peersOverallGoalProgress
isManager
managerId
myRoles {
...ManagerTypeFragment
}
cognitoInfo {
...User_CognitoInfoFragment
}
cognitoGroups {
...User_CognitoGroupFragment
}
tokenRoles
tokenAbility {
...AbilityFragment
}
roles {
...RoleFragment
}
ability {
...AbilityFragment
}
rbacRoles
permissions {
...User_PermissionFragment
}
terms {
...TermFragment
}
isMFAEnabled
years {
...YearFragment
}
moduleCategories {
...UserModuelCategoryFragment
}
termPrograms {
...TermProgramFragment
}
termProgramsPage {
...TermProgramsPageFragment
}
termsPage {
...TermsPageFragment
}
termsFacts {
...FactFragment
}
latestSupportTicket {
...SupportTicketFragment
}
peersPage {
...UsersPageFragment
}
myManager {
...UserFragment
}
myEvaluator {
...UserFragment
}
directReportsPage {
...UsersPageFragment
}
directReportsFact {
...FactFragment
}
managersInMyDirectReportsPage {
...UsersPageFragment
}
orgUnit
organizationUnit {
...OrgUnitFragment
}
myCEO {
...UserFragment
}
inDirectReportsPage {
...UsersPageFragment
}
termProgram {
...TermProgramFragment
}
latestTermProgram {
...TermProgramFragment
}
userFilterOptions {
...UserFilterOptionFragment
}
subUsersPage {
...UsersPageFragment
}
myCompanyGoalsPage {
...CommunityGoalsPageFragment
}
myCommunityGoalsPage {
...CommunityGoalsPageFragment
}
approvedGoalsPage {
...GoalsPageFragment
}
completedGoalsPage {
...GoalsPageFragment
}
canceledGoalsPage {
...GoalsPageFragment
}
draftGoalsPage {
...GoalsPageFragment
}
trashedGoalsPage {
...GoalsPageFragment
}
taggedGoalsPage {
...GoalsPageFragment
}
goalCreationStatus
goalCreationStatusFacts {
...FactFragment
}
approvedGoalsFacts {
...FactFragment
}
draftGoalsFacts {
...FactFragment
}
trashedGoalsFacts {
...FactFragment
}
taggedGoalsFacts {
...FactFragment
}
submittedGoalsFacts {
...FactFragment
}
goalsFacts {
...FactFragment
}
plannedTasksPage {
...PlannedTasksPageFragment
}
plannedTasksFacts {
...FactFragment
}
taggedPlannedTasksPage {
...PlannedTasksPageFragment
}
taggedPlannedTasksFacts {
...FactFragment
}
unplannedTasksPage {
...UnplannedTasksPageFragment
}
unplannedTasksFacts {
...FactFragment
}
attendancesPage {
...AttendancesPageFragment
}
attendancesFacts {
...FactFragment
}
notificationsPage {
...NotificationsPageFragment
}
surveyScore
surveySpecimensPage {
...SurveySpecimensPageFragment
}
socketUrl
programsOfDirectReportsPage {
...ProgramsPageFragment
}
surveyReport {
...SurveyReportFragment
}
surveyReportWithPrevSurveyReport {
...SurveyReportFragment
}
}
}
Variables
{"userNameOrId": "xyz789"}
Response
{
"data": {
"user": {
"_id": "5e5677d71bdc2ae76344968c",
"userName": "abc123",
"empCode": "abc123",
"preferredName": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"mobileNumber": "abc123",
"isEmailVerified": false,
"isMobileNumberVerified": true,
"imageUrl": "xyz789",
"profilePic": File,
"managers": [Manager],
"orgUnits": [
"5e5677d71bdc2ae76344968c"
],
"designation": "abc123",
"path": "xyz789",
"aboutMe": "xyz789",
"myStatus": "xyz789",
"isReportAppDiagnosticData": false,
"isActive": true,
"dummy": "abc123",
"progress": 987.65,
"overallGoalProgress": 123.45,
"ytdRating": 987.65,
"teamOverallGoalProgress": 123.45,
"peersOverallGoalProgress": 123.45,
"isManager": false,
"managerId": "abc123",
"myRoles": [ManagerType],
"cognitoInfo": User_CognitoInfo,
"cognitoGroups": [User_CognitoGroup],
"tokenRoles": ["xyz789"],
"tokenAbility": [Ability],
"roles": [Role],
"ability": [Ability],
"rbacRoles": ["xyz789"],
"permissions": [User_Permission],
"terms": [Term],
"isMFAEnabled": false,
"years": [Year],
"moduleCategories": [UserModuelCategory],
"termPrograms": [TermProgram],
"termProgramsPage": TermProgramsPage,
"termsPage": TermsPage,
"termsFacts": [Fact],
"latestSupportTicket": SupportTicket,
"peersPage": UsersPage,
"myManager": User,
"myEvaluator": User,
"directReportsPage": UsersPage,
"directReportsFact": [Fact],
"managersInMyDirectReportsPage": UsersPage,
"orgUnit": "abc123",
"organizationUnit": OrgUnit,
"myCEO": User,
"inDirectReportsPage": UsersPage,
"termProgram": TermProgram,
"latestTermProgram": TermProgram,
"userFilterOptions": [UserFilterOption],
"subUsersPage": UsersPage,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"completedGoalsPage": GoalsPage,
"canceledGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"goalCreationStatus": "xyz789",
"goalCreationStatusFacts": [Fact],
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"notificationsPage": NotificationsPage,
"surveyScore": "abc123",
"surveySpecimensPage": SurveySpecimensPage,
"socketUrl": "xyz789",
"programsOfDirectReportsPage": ProgramsPage,
"surveyReport": SurveyReport,
"surveyReportWithPrevSurveyReport": SurveyReport
}
}
}
usersPage
Response
Returns a UsersPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query usersPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
usersPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...UserFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"usersPage": {
"docs": [User],
"pageInfo": PageInfo
}
}
}
year
Example
Query
query year($_id: ObjectID!) {
year(_id: $_id) {
_id
userId
name
keyName
priority
isActive
userModuleCategories {
...UserModuelCategoryFragment
}
}
}
Variables
{"_id": "5e5677d71bdc2ae76344968c"}
Response
{
"data": {
"year": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 123,
"isActive": true,
"userModuleCategories": [UserModuelCategory]
}
}
}
years
Response
Returns [Year]
Arguments
| Name | Description |
|---|---|
search - JSONString
|
Example
Query
query years($search: JSONString) {
years(search: $search) {
_id
userId
name
keyName
priority
isActive
userModuleCategories {
...UserModuelCategoryFragment
}
}
}
Variables
{"search": JSONString}
Response
{
"data": {
"years": [
{
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 123,
"isActive": false,
"userModuleCategories": [UserModuelCategory]
}
]
}
}
yearsPage
Response
Returns a YearsPage!
Arguments
| Name | Description |
|---|---|
searchOptions - SearchOptions
|
|
listOptions - ListOptions
|
Example
Query
query yearsPage(
$searchOptions: SearchOptions,
$listOptions: ListOptions
) {
yearsPage(
searchOptions: $searchOptions,
listOptions: $listOptions
) {
docs {
...YearFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"searchOptions": SearchOptions,
"listOptions": ListOptions
}
Response
{
"data": {
"yearsPage": {
"docs": [Year],
"pageInfo": PageInfo
}
}
}
Mutations
addAttendanceLog
Description
DEPRECATED To add an attendance entry. Access allowed to WeSoar Super Admin.
Response
Returns an Attendance
Arguments
| Name | Description |
|---|---|
params - AddAttendanceLogParams!
|
|
options - AddAttendanceLogOptions
|
Example
Query
mutation addAttendanceLog(
$params: AddAttendanceLogParams!,
$options: AddAttendanceLogOptions
) {
addAttendanceLog(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
userId
attendanceLogs {
...AttendanceLogFragment
}
isActive
isDeleted
attendanceLogsPage {
...AttendanceLogsPageFragment
}
attendanceLogForDate {
...AttendanceLogFragment
}
}
}
Variables
{
"params": AddAttendanceLogParams,
"options": AddAttendanceLogOptions
}
Response
{
"data": {
"addAttendanceLog": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": false,
"isDeleted": false,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
}
}
addComment
Description
To add a comment. Access allowed to authenticated user.
Response
Returns a CommentsPage
Arguments
| Name | Description |
|---|---|
params - AddCommentParams!
|
|
rootOptions - RootOptions
|
Example
Query
mutation addComment(
$params: AddCommentParams!,
$rootOptions: RootOptions
) {
addComment(
params: $params,
rootOptions: $rootOptions
) {
docs {
...CommentFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"params": AddCommentParams,
"rootOptions": RootOptions
}
Response
{
"data": {
"addComment": {
"docs": [Comment],
"pageInfo": PageInfo
}
}
}
addCommentReaction
Description
To add a comment reaction. Access allowed to authenticated user.
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
params - AddCommentReactionParams!
|
|
rootOptions - RootOptions
|
Example
Query
mutation addCommentReaction(
$params: AddCommentReactionParams!,
$rootOptions: RootOptions
) {
addCommentReaction(
params: $params,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"params": AddCommentReactionParams,
"rootOptions": RootOptions
}
Response
{
"data": {
"addCommentReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": false,
"isDeleted": false,
"commentDate": 1592577642,
"type": "abc123",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
addConversationMetas
Description
To add Conversation Metas. Access allowed to Authenticated User.
Response
Returns a Conversation
Arguments
| Name | Description |
|---|---|
params - AddConversationMetasParams!
|
|
options - AddConversationMetasOptions
|
Example
Query
mutation addConversationMetas(
$params: AddConversationMetasParams!,
$options: AddConversationMetasOptions
) {
addConversationMetas(
params: $params,
options: $options
) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{
"params": AddConversationMetasParams,
"options": AddConversationMetasOptions
}
Response
{
"data": {
"addConversationMetas": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"description": "abc123",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "xyz789",
"fldName": "xyz789",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 123,
"isActive": true,
"isDeleted": false,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 123
}
}
}
addConversationSubscribers
Description
To add Conversation Subscribers. Access allowed to Authenticated User.
Response
Returns a Conversation
Arguments
| Name | Description |
|---|---|
params - AddConversationSubscribersParams!
|
|
options - AddConversationSubscribersOptions
|
Example
Query
mutation addConversationSubscribers(
$params: AddConversationSubscribersParams!,
$options: AddConversationSubscribersOptions
) {
addConversationSubscribers(
params: $params,
options: $options
) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{
"params": AddConversationSubscribersParams,
"options": AddConversationSubscribersOptions
}
Response
{
"data": {
"addConversationSubscribers": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"description": "xyz789",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "abc123",
"fldName": "xyz789",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 987,
"isActive": true,
"isDeleted": false,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 987
}
}
}
addGoalAppraisal
Description
DEPRECATED To add Goal Appraisal. Access allowed to WeSoar Super Admin.
Response
Returns a Goal
Arguments
| Name | Description |
|---|---|
params - AddGoalAppraisalParams!
|
|
options - AddGoalAppraisalOptions
|
Example
Query
mutation addGoalAppraisal(
$params: AddGoalAppraisalParams!,
$options: AddGoalAppraisalOptions
) {
addGoalAppraisal(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": AddGoalAppraisalParams,
"options": AddGoalAppraisalOptions
}
Response
{
"data": {
"addGoalAppraisal": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "abc123",
"goalType": "abc123",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 987,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "xyz789",
"goalProgress": 123,
"priority": 987,
"isActive": true,
"isShowInPlannedTask": false,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
addGoalCheckIn
Description
DEPRECATED To add Goal CheckIn. Access allowed to WeSoar Super Admin.
Response
Returns a Goal
Arguments
| Name | Description |
|---|---|
params - AddGoalCheckInParams!
|
|
options - AddGoalCheckInOptions
|
Example
Query
mutation addGoalCheckIn(
$params: AddGoalCheckInParams!,
$options: AddGoalCheckInOptions
) {
addGoalCheckIn(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": AddGoalCheckInParams,
"options": AddGoalCheckInOptions
}
Response
{
"data": {
"addGoalCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "xyz789",
"goalType": "abc123",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "xyz789",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 123,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "xyz789",
"achievement": "xyz789",
"goalProgress": 987,
"priority": 987,
"isActive": false,
"isShowInPlannedTask": true,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
addMessage
Response
Returns a Message
Arguments
| Name | Description |
|---|---|
params - AddMessageParams!
|
Example
Query
mutation addMessage($params: AddMessageParams!) {
addMessage(params: $params) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"params": AddMessageParams}
Response
{
"data": {
"addMessage": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "abc123",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": false,
"isDeleted": false,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
addMessageReaction
Response
Returns a Message
Arguments
| Name | Description |
|---|---|
params - AddMessageReactionParams!
|
Example
Query
mutation addMessageReaction($params: AddMessageReactionParams!) {
addMessageReaction(params: $params) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"params": AddMessageReactionParams}
Response
{
"data": {
"addMessageReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "abc123",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": false,
"isDeleted": false,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
addPlannedTaskFollowUp
Description
To add Planned Task follow up. Access allowed to Authenticated User as per business logic.
Response
Returns a PlannedTask!
Arguments
| Name | Description |
|---|---|
params - AddPlannedTaskFollowUpParams!
|
|
options - AddPlannedTaskFollowUpOptions
|
Example
Query
mutation addPlannedTaskFollowUp(
$params: AddPlannedTaskFollowUpParams!,
$options: AddPlannedTaskFollowUpOptions
) {
addPlannedTaskFollowUp(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{
"params": AddPlannedTaskFollowUpParams,
"options": AddPlannedTaskFollowUpOptions
}
Response
{
"data": {
"addPlannedTaskFollowUp": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "abc123",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "xyz789",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "abc123",
"priority": 123,
"isActive": true,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 123
}
}
}
addPlannedTaskFollowUps
Description
To add Planned Task Follow ups. Access allowed to Authenticated User as per business logic.
Response
Returns a PlannedTask!
Arguments
| Name | Description |
|---|---|
params - AddPlannedTaskFollowUpsParams!
|
|
options - AddPlannedTaskFollowUpsOptions
|
Example
Query
mutation addPlannedTaskFollowUps(
$params: AddPlannedTaskFollowUpsParams!,
$options: AddPlannedTaskFollowUpsOptions
) {
addPlannedTaskFollowUps(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{
"params": AddPlannedTaskFollowUpsParams,
"options": AddPlannedTaskFollowUpsOptions
}
Response
{
"data": {
"addPlannedTaskFollowUps": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "abc123",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "abc123",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "xyz789",
"priority": 987,
"isActive": false,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 123
}
}
}
addUnplannedTaskReaction
Description
To add Unplanned Task Reaction. Access allowed to Authenticated User as per business logic.
Response
Returns an UnplannedTask!
Arguments
| Name | Description |
|---|---|
params - AddUnplannedTaskReactionParams!
|
|
options - AddUnplannedTaskReactionOptions
|
Example
Query
mutation addUnplannedTaskReaction(
$params: AddUnplannedTaskReactionParams!,
$options: AddUnplannedTaskReactionOptions
) {
addUnplannedTaskReaction(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
unplannedTaskType
unplannedTaskDetail {
...UnplannedTaskDetailFragment
}
comments {
...CommentFragment
}
reactions {
...ReactionFragment
}
impactStageId
impactStage {
...ImpactStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
unplannedTaskCommentsFacts {
...FactFragment
}
myUnplannedTaskReaction {
...ReactionFragment
}
unplannedTaskReactionsFacts {
...FactFragment
}
unplannedTaskReactionsPage {
...ReactionsPageFragment
}
unplannedTasksFacts {
...FactFragment
}
views
}
}
Variables
{
"params": AddUnplannedTaskReactionParams,
"options": AddUnplannedTaskReactionOptions
}
Response
{
"data": {
"addUnplannedTaskReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "xyz789",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "xyz789",
"priority": 123,
"isActive": true,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 123
}
}
}
adminDisableMfa
Description
DEPRECATED To Admin Disable MFA. Access allowed to WeSoar Super Admin.
Response
Returns an AdminDisableMfaPayload
Arguments
| Name | Description |
|---|---|
params - String
|
Example
Query
mutation adminDisableMfa($params: String) {
adminDisableMfa(params: $params) {
status
}
}
Variables
{"params": "xyz789"}
Response
{"data": {"adminDisableMfa": {"status": false}}}
adminEnableMfa
Description
DEPRECATED To Admin Enable MFA. Access allowed to WeSoar Super Admin.
Response
Returns an AdminEnableMfaPayload
Arguments
| Name | Description |
|---|---|
params - String
|
Example
Query
mutation adminEnableMfa($params: String) {
adminEnableMfa(params: $params) {
status
}
}
Variables
{"params": "abc123"}
Response
{"data": {"adminEnableMfa": {"status": false}}}
analyseComments
Description
To analyse Comments. Access allowed to WeSoar Super Admin.
assignFeaturesToUser
Description
To assign features to user. Access allowed to WeSoar Super Admin.
Response
Returns an AssignFeaturesToUserPayload
Arguments
| Name | Description |
|---|---|
params - AssignFeaturesToUserParams!
|
|
options - AssignFeaturesToUserOptions
|
Example
Query
mutation assignFeaturesToUser(
$params: AssignFeaturesToUserParams!,
$options: AssignFeaturesToUserOptions
) {
assignFeaturesToUser(
params: $params,
options: $options
) {
success
}
}
Variables
{
"params": AssignFeaturesToUserParams,
"options": AssignFeaturesToUserOptions
}
Response
{"data": {"assignFeaturesToUser": {"success": true}}}
assignFeaturesToUsers
Description
To assign features to users. Access allowed to WeSoar Super Admin.
Response
Returns an AssignFeaturesToUsersPayload
Arguments
| Name | Description |
|---|---|
params - AssignFeaturesToUsersParams!
|
|
options - AssignFeaturesToUsersOptions
|
Example
Query
mutation assignFeaturesToUsers(
$params: AssignFeaturesToUsersParams!,
$options: AssignFeaturesToUsersOptions
) {
assignFeaturesToUsers(
params: $params,
options: $options
) {
success
}
}
Variables
{
"params": AssignFeaturesToUsersParams,
"options": AssignFeaturesToUsersOptions
}
Response
{"data": {"assignFeaturesToUsers": {"success": false}}}
assignManagerToUser
Description
To assign manager to user. Access allowed to WeSoar Super Admin.
Response
Returns an AssignManagerToUserPayload
Arguments
| Name | Description |
|---|---|
params - AssignManagerToUserParams!
|
|
options - AssignManagerToUserOptions
|
Example
Query
mutation assignManagerToUser(
$params: AssignManagerToUserParams!,
$options: AssignManagerToUserOptions
) {
assignManagerToUser(
params: $params,
options: $options
) {
success
}
}
Variables
{
"params": AssignManagerToUserParams,
"options": AssignManagerToUserOptions
}
Response
{"data": {"assignManagerToUser": {"success": false}}}
assignRolesToUser
Description
To assign roles to user. Access allowed to WeSoar Super Admin.
Response
Returns an AssignRolesToUserPayload
Arguments
| Name | Description |
|---|---|
params - AssignRolesToUserParams!
|
|
options - AssignRolesToUserOptions
|
Example
Query
mutation assignRolesToUser(
$params: AssignRolesToUserParams!,
$options: AssignRolesToUserOptions
) {
assignRolesToUser(
params: $params,
options: $options
) {
success
}
}
Variables
{
"params": AssignRolesToUserParams,
"options": AssignRolesToUserOptions
}
Response
{"data": {"assignRolesToUser": {"success": false}}}
assignRolesToUsers
Description
To assign roles to users. Access allowed to WeSoar Super Admin.
Response
Returns an AssignRolesToUsersPayload
Arguments
| Name | Description |
|---|---|
params - AssignRolesToUsersParams!
|
|
options - AssignRolesToUsersOptions
|
Example
Query
mutation assignRolesToUsers(
$params: AssignRolesToUsersParams!,
$options: AssignRolesToUsersOptions
) {
assignRolesToUsers(
params: $params,
options: $options
) {
success
}
}
Variables
{
"params": AssignRolesToUsersParams,
"options": AssignRolesToUsersOptions
}
Response
{"data": {"assignRolesToUsers": {"success": false}}}
changePassword
Description
DEPRECATED To change password. Access allowed to WeSoar Super Admin.
Response
Returns a ChangePasswordPayload
Arguments
| Name | Description |
|---|---|
params - ChangePasswordParams
|
|
options - ChangePasswordOptions
|
Example
Query
mutation changePassword(
$params: ChangePasswordParams,
$options: ChangePasswordOptions
) {
changePassword(
params: $params,
options: $options
) {
status
}
}
Variables
{
"params": ChangePasswordParams,
"options": ChangePasswordOptions
}
Response
{"data": {"changePassword": {"status": true}}}
closeSurvey
Description
To close Survey. Access allowed to WeSoar Super Admin.
confirmForgotPassword
Description
DEPRECATED To confirm forgot password OTP. Access allowed to WeSoar Super Admin.
Response
Returns a ConfirmForgotPasswordPayload
Arguments
| Name | Description |
|---|---|
params - ConfirmForgotPasswordParams
|
|
options - ConfirmForgotPasswordOptions
|
Example
Query
mutation confirmForgotPassword(
$params: ConfirmForgotPasswordParams,
$options: ConfirmForgotPasswordOptions
) {
confirmForgotPassword(
params: $params,
options: $options
) {
tokens {
...TokensFragment
}
challenge {
...ChallengeFragment
}
}
}
Variables
{
"params": ConfirmForgotPasswordParams,
"options": ConfirmForgotPasswordOptions
}
Response
{
"data": {
"confirmForgotPassword": {
"tokens": Tokens,
"challenge": Challenge
}
}
}
copyCommunityGoals
Description
To copy Community Goal. Access allowed to authenticated user.
Response
Returns [Goal]
Arguments
| Name | Description |
|---|---|
params - CopyCommunityGoalsParams!
|
|
options - CopyCommunityGoalsOptions
|
Example
Query
mutation copyCommunityGoals(
$params: CopyCommunityGoalsParams!,
$options: CopyCommunityGoalsOptions
) {
copyCommunityGoals(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": CopyCommunityGoalsParams,
"options": CopyCommunityGoalsOptions
}
Response
{
"data": {
"copyCommunityGoals": [
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "xyz789",
"goalType": "xyz789",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 987,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "xyz789",
"goalProgress": 123,
"priority": 987,
"isActive": true,
"isShowInPlannedTask": true,
"isShowInUnplannedTask": true,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
]
}
}
createAlarm
Description
To create Alarm. Access allowed to WeSoar Super Admin.
Response
Returns an Alarm
Arguments
| Name | Description |
|---|---|
params - CreateAlarmParams!
|
|
options - CreateAlarmOptions
|
Example
Query
mutation createAlarm(
$params: CreateAlarmParams!,
$options: CreateAlarmOptions
) {
createAlarm(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": CreateAlarmParams,
"options": CreateAlarmOptions
}
Response
{
"data": {
"createAlarm": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 123,
"isActive": false
}
}
}
createAppraisal
Description
To create an appraisal. Access allowed to WeSoar Super Admin.
Response
Returns an Appraisal
Arguments
| Name | Description |
|---|---|
params - CreateAppraisalParams!
|
|
options - CreateAppraisalOptions
|
Example
Query
mutation createAppraisal(
$params: CreateAppraisalParams!,
$options: CreateAppraisalOptions
) {
createAppraisal(
params: $params,
options: $options
) {
_id
termProgramId
appraisalRating {
...AppraisalRatingFragment
}
appraisalDate
name
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
appraisalGoalsPage {
...GoalsPageFragment
}
priority
appraisalStatus
appraisalCalculation
isDeleted
}
}
Variables
{
"params": CreateAppraisalParams,
"options": CreateAppraisalOptions
}
Response
{
"data": {
"createAppraisal": {
"_id": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"appraisalRating": AppraisalRating,
"appraisalDate": 1592577642,
"name": "abc123",
"commentsPage": CommentsPage,
"comment": Comment,
"appraisalGoalsPage": GoalsPage,
"priority": 987,
"appraisalStatus": "xyz789",
"appraisalCalculation": "xyz789",
"isDeleted": true
}
}
}
createAppraisalForUsers
Description
To publish appraisal for users. Access allowed to WeSoar Super Admin.
Response
Returns [Appraisal]
Arguments
| Name | Description |
|---|---|
params - CreateAppraisalForUsersParams!
|
|
options - CreateAppraisalForUsersOptions
|
Example
Query
mutation createAppraisalForUsers(
$params: CreateAppraisalForUsersParams!,
$options: CreateAppraisalForUsersOptions
) {
createAppraisalForUsers(
params: $params,
options: $options
) {
_id
termProgramId
appraisalRating {
...AppraisalRatingFragment
}
appraisalDate
name
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
appraisalGoalsPage {
...GoalsPageFragment
}
priority
appraisalStatus
appraisalCalculation
isDeleted
}
}
Variables
{
"params": CreateAppraisalForUsersParams,
"options": CreateAppraisalForUsersOptions
}
Response
{
"data": {
"createAppraisalForUsers": [
{
"_id": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"appraisalRating": AppraisalRating,
"appraisalDate": 1592577642,
"name": "abc123",
"commentsPage": CommentsPage,
"comment": Comment,
"appraisalGoalsPage": GoalsPage,
"priority": 123,
"appraisalStatus": "abc123",
"appraisalCalculation": "xyz789",
"isDeleted": false
}
]
}
}
createAttendance
Description
DEPRECATED To create an attendance. Access allowed to WeSoar Super Admin.
Response
Returns an Attendance!
Arguments
| Name | Description |
|---|---|
params - CreateAttendanceParams!
|
|
options - CreateAttendanceOptions
|
Example
Query
mutation createAttendance(
$params: CreateAttendanceParams!,
$options: CreateAttendanceOptions
) {
createAttendance(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
userId
attendanceLogs {
...AttendanceLogFragment
}
isActive
isDeleted
attendanceLogsPage {
...AttendanceLogsPageFragment
}
attendanceLogForDate {
...AttendanceLogFragment
}
}
}
Variables
{
"params": CreateAttendanceParams,
"options": CreateAttendanceOptions
}
Response
{
"data": {
"createAttendance": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": true,
"isDeleted": false,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
}
}
createCheckIn
Description
To create a CheckIn. Access allowed to WeSoar Super Admin.
Response
Returns a CheckIn
Arguments
| Name | Description |
|---|---|
params - CreateCheckInParams!
|
|
options - CreateCheckInOptions
|
Example
Query
mutation createCheckIn(
$params: CreateCheckInParams!,
$options: CreateCheckInOptions
) {
createCheckIn(
params: $params,
options: $options
) {
_id
name
checkInType
termProgramId
userId
programId
checkInSetting {
...CheckInSettingFragment
}
checkInDate
checkInRatings {
...CheckInRatingFragment
}
priority
checkInStatus
user {
...UserFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
competencies {
...SurveyQuestionFragment
}
competenciesFPage {
...SurveyQuestionFragment
}
competenciesPage {
...SurveyQuestionsPageFragment
}
isDeleted
latestRating {
...CheckInRatingFragment
}
checkInRatingsPage {
...CheckInRatingsPageFragment
}
checkInRatingsFPage {
...CheckInRatingFragment
}
checkInRatingsFOne {
...CheckInRatingFragment
}
commentTrailId
isActiveForEmp
isActiveForManager
}
}
Variables
{
"params": CreateCheckInParams,
"options": CreateCheckInOptions
}
Response
{
"data": {
"createCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"checkInType": "abc123",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 987,
"checkInStatus": "xyz789",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": false,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": false,
"isActiveForManager": true
}
}
}
createCheckInForUsers
Description
To publish CheckIn for Users. Access allowed to WeSoar Super Admin.
Response
Returns [CheckIn]
Arguments
| Name | Description |
|---|---|
params - CreateCheckInForUsersParams!
|
|
options - CreateCheckInForUsersOptions
|
Example
Query
mutation createCheckInForUsers(
$params: CreateCheckInForUsersParams!,
$options: CreateCheckInForUsersOptions
) {
createCheckInForUsers(
params: $params,
options: $options
) {
_id
name
checkInType
termProgramId
userId
programId
checkInSetting {
...CheckInSettingFragment
}
checkInDate
checkInRatings {
...CheckInRatingFragment
}
priority
checkInStatus
user {
...UserFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
competencies {
...SurveyQuestionFragment
}
competenciesFPage {
...SurveyQuestionFragment
}
competenciesPage {
...SurveyQuestionsPageFragment
}
isDeleted
latestRating {
...CheckInRatingFragment
}
checkInRatingsPage {
...CheckInRatingsPageFragment
}
checkInRatingsFPage {
...CheckInRatingFragment
}
checkInRatingsFOne {
...CheckInRatingFragment
}
commentTrailId
isActiveForEmp
isActiveForManager
}
}
Variables
{
"params": CreateCheckInForUsersParams,
"options": CreateCheckInForUsersOptions
}
Response
{
"data": {
"createCheckInForUsers": [
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"checkInType": "abc123",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 123,
"checkInStatus": "abc123",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": true,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": false,
"isActiveForManager": false
}
]
}
}
createCommunicationEvent
Description
To create Communication Event. Access allowed to WeSoar Super Admin.
Response
Returns a CommunicationEvent
Arguments
| Name | Description |
|---|---|
params - CreateCommunicationEventParams!
|
|
options - CreateCommunicationEventOptions
|
Example
Query
mutation createCommunicationEvent(
$params: CreateCommunicationEventParams!,
$options: CreateCommunicationEventOptions
) {
createCommunicationEvent(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": CreateCommunicationEventParams,
"options": CreateCommunicationEventOptions
}
Response
{
"data": {
"createCommunicationEvent": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 123,
"isActive": false
}
}
}
createCommunityGoal
Description
To create Community Goal. Access allowed to WeSoar Super Admin.
Response
Returns a CommunityGoal
Arguments
| Name | Description |
|---|---|
params - CreateCommunityGoalParams!
|
|
options - CreateCommunityGoalOptions
|
Example
Query
mutation createCommunityGoal(
$params: CreateCommunityGoalParams!,
$options: CreateCommunityGoalOptions
) {
createCommunityGoal(
params: $params,
options: $options
) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{
"params": CreateCommunityGoalParams,
"options": CreateCommunityGoalOptions
}
Response
{
"data": {
"createCommunityGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "abc123",
"trackingStatus": "xyz789",
"achievement": "abc123",
"isCompanyGoal": true,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 123,
"goalProgress": 987.65,
"keyName": "abc123",
"priority": 123,
"isActive": false,
"isDeleted": true,
"hash": "abc123",
"isParticipant": true,
"isSubscriber": false,
"isAdmin": false,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
}
}
createConversation
Description
To create Conversation. Access allowed to Authenticated User.
Response
Returns a Conversation
Arguments
| Name | Description |
|---|---|
params - CreateConversationParams!
|
|
options - CreateConversationOptions
|
Example
Query
mutation createConversation(
$params: CreateConversationParams!,
$options: CreateConversationOptions
) {
createConversation(
params: $params,
options: $options
) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{
"params": CreateConversationParams,
"options": CreateConversationOptions
}
Response
{
"data": {
"createConversation": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"description": "abc123",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "xyz789",
"fldName": "xyz789",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 123,
"isActive": true,
"isDeleted": true,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 987
}
}
}
createGoal
Description
To create Goal. Access allowed to authenticated user as per business logic.
Response
Returns a Goal!
Arguments
| Name | Description |
|---|---|
params - CreateGoalParams!
|
|
options - CreateGoalOptions
|
Example
Query
mutation createGoal(
$params: CreateGoalParams!,
$options: CreateGoalOptions
) {
createGoal(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": CreateGoalParams,
"options": CreateGoalOptions
}
Response
{
"data": {
"createGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "xyz789",
"goalType": "abc123",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "xyz789",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 987,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "abc123",
"goalProgress": 987,
"priority": 123,
"isActive": false,
"isShowInPlannedTask": false,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
createLanguage
Description
To create Language. Access allowed to WeSoar Super Admin.
Response
Returns a Language
Arguments
| Name | Description |
|---|---|
params - CreateLanguageParams!
|
|
options - CreateLanguageOptions
|
Example
Query
mutation createLanguage(
$params: CreateLanguageParams!,
$options: CreateLanguageOptions
) {
createLanguage(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
isRTL
}
}
Variables
{
"params": CreateLanguageParams,
"options": CreateLanguageOptions
}
Response
{
"data": {
"createLanguage": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 987,
"isActive": true,
"isRTL": false
}
}
}
createMaster
Description
To create Master. Access allowed to WeSoar Super Admin.
Response
Returns a Master!
Arguments
| Name | Description |
|---|---|
params - CreateMasterParams!
|
|
modelName - String
|
Example
Query
mutation createMaster(
$params: CreateMasterParams!,
$modelName: String
) {
createMaster(
params: $params,
modelName: $modelName
) {
_id
name
keyName
priority
isActive
isDeleted
}
}
Variables
{
"params": CreateMasterParams,
"modelName": "abc123"
}
Response
{
"data": {
"createMaster": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 987,
"isActive": true,
"isDeleted": true
}
}
}
createModule
Description
To create Module. Access allowed to WeSoar Super Admin.
Response
Returns a Module
Arguments
| Name | Description |
|---|---|
params - CreateModuleParams!
|
|
options - CreateModuleOptions
|
Example
Query
mutation createModule(
$params: CreateModuleParams!,
$options: CreateModuleOptions
) {
createModule(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": CreateModuleParams,
"options": CreateModuleOptions
}
Response
{
"data": {
"createModule": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 987,
"isActive": false
}
}
}
createModuleCategory
Description
To create Module Category. Access allowed to WeSoar Super Admin.
Response
Returns a ModuleCategory
Arguments
| Name | Description |
|---|---|
params - CreateModuleCategoryParams!
|
|
options - CreateModuleCategoryOptions
|
Example
Query
mutation createModuleCategory(
$params: CreateModuleCategoryParams!,
$options: CreateModuleCategoryOptions
) {
createModuleCategory(
params: $params,
options: $options
) {
_id
name
keyName
modules {
...ModuleFragment
}
priority
isActive
}
}
Variables
{
"params": CreateModuleCategoryParams,
"options": CreateModuleCategoryOptions
}
Response
{
"data": {
"createModuleCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"modules": [Module],
"priority": 123,
"isActive": false
}
}
}
createNotification
Description
DEPRECATED To create Notification. Access allowed to WeSoar Super Admin.
Response
Returns a Notification!
Arguments
| Name | Description |
|---|---|
params - CreateNotificationParams!
|
|
options - CreateNotificationOptions
|
Example
Query
mutation createNotification(
$params: CreateNotificationParams!,
$options: CreateNotificationOptions
) {
createNotification(
params: $params,
options: $options
) {
_id
userId
termProgramId
notificationDate
messageData
payload
isOpened
messageText
messageTitle
messageUri
isActive
isDeleted
}
}
Variables
{
"params": CreateNotificationParams,
"options": CreateNotificationOptions
}
Response
{
"data": {
"createNotification": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"notificationDate": 1592577642,
"messageData": {},
"payload": {},
"isOpened": false,
"messageText": "xyz789",
"messageTitle": "abc123",
"messageUri": "xyz789",
"isActive": false,
"isDeleted": true
}
}
}
createOrgAdmin
Description
To create Organisation Admin. Access allowed to WeSoar Super Admin.
Response
Returns a CreateOrgAdminPayload
Arguments
| Name | Description |
|---|---|
params - CreateOrgAdminParams!
|
|
options - CreateOrgAdminOptions
|
Example
Query
mutation createOrgAdmin(
$params: CreateOrgAdminParams!,
$options: CreateOrgAdminOptions
) {
createOrgAdmin(
params: $params,
options: $options
) {
id
userName
firstName
lastName
empCode
email
mobileNumber
isEmailVerified
isMobileNumberVerified
}
}
Variables
{
"params": CreateOrgAdminParams,
"options": CreateOrgAdminOptions
}
Response
{
"data": {
"createOrgAdmin": {
"id": "5e5677d71bdc2ae76344968c",
"userName": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"empCode": "abc123",
"email": "abc123",
"mobileNumber": "abc123",
"isEmailVerified": false,
"isMobileNumberVerified": true
}
}
}
createOrgUnit
Description
To create Organisation Unit. Access allowed to WeSoar Super Admin.
Response
Returns an OrgUnit
Arguments
| Name | Description |
|---|---|
params - CreateOrgUnitParams!
|
|
options - CreateOrgUnitOptions
|
Example
Query
mutation createOrgUnit(
$params: CreateOrgUnitParams!,
$options: CreateOrgUnitOptions
) {
createOrgUnit(
params: $params,
options: $options
) {
_id
name
pid
keyName
priority
isActive
myRootOrg {
...OrgUnitFragment
}
childUnitsPage {
...OrgUnitsPageFragment
}
surveyReportWithPrevSurveyReport {
...SurveyReportFragment
}
}
}
Variables
{
"params": CreateOrgUnitParams,
"options": CreateOrgUnitOptions
}
Response
{
"data": {
"createOrgUnit": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"pid": "5e5677d71bdc2ae76344968c",
"keyName": "xyz789",
"priority": 123,
"isActive": true,
"myRootOrg": OrgUnit,
"childUnitsPage": OrgUnitsPage,
"surveyReportWithPrevSurveyReport": SurveyReport
}
}
}
createOrganisation
Description
To create Organisation. Access allowed to WeSoar Super Admin.
Response
Returns a CreateOrganisationPayload
Arguments
| Name | Description |
|---|---|
params - CreateOrganisationParams!
|
|
options - CreateOrganisationOptions
|
Example
Query
mutation createOrganisation(
$params: CreateOrganisationParams!,
$options: CreateOrganisationOptions
) {
createOrganisation(
params: $params,
options: $options
) {
organisation {
...CreateOrganisation_Organisation_PayloadFragment
}
}
}
Variables
{
"params": CreateOrganisationParams,
"options": CreateOrganisationOptions
}
Response
{
"data": {
"createOrganisation": {
"organisation": CreateOrganisation_Organisation_Payload
}
}
}
createPlannedTask
Description
To create Planned Task. Access allowed to Authenticated User as per business logic.
Response
Returns a PlannedTask!
Arguments
| Name | Description |
|---|---|
params - CreatePlannedTaskParams!
|
|
options - CreatePlannedTaskOptions
|
Example
Query
mutation createPlannedTask(
$params: CreatePlannedTaskParams!,
$options: CreatePlannedTaskOptions
) {
createPlannedTask(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{
"params": CreatePlannedTaskParams,
"options": CreatePlannedTaskOptions
}
Response
{
"data": {
"createPlannedTask": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "xyz789",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "xyz789",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "xyz789",
"priority": 987,
"isActive": false,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 123
}
}
}
createProgram
Description
To create Program. Access allowed to WeSoar Super Admin.
Response
Returns a Program
Arguments
| Name | Description |
|---|---|
params - CreateProgramParams!
|
|
options - CreateProgramOptions
|
Example
Query
mutation createProgram(
$params: CreateProgramParams!,
$options: CreateProgramOptions
) {
createProgram(
params: $params,
options: $options
) {
_id
yearId
programCategoryId
name
keyName
moduleKeyName
moduleCategoryKeyName
startDate
endDate
goalSetting {
...GoalSettingFragment
}
plannedTaskSetting {
...PlannedTaskSettingFragment
}
unplannedTaskSetting {
...UnplannedTaskSettingFragment
}
surveySetting {
...SurveySettingFragment
}
userFilterRules
status
programLabels
priority
isActive
isDeleted
year {
...YearFragment
}
programCategory {
...ProgramCategoryFragment
}
kanbanStage {
...KanbanStageFragment
}
impactStage {
...ImpactStageFragment
}
timelineStage {
...TimelineStageFragment
}
unplannedImpactStage {
...ImpactStageFragment
}
previousProgram {
...ProgramFragment
}
surveyReportsPage {
...SurveyReportsPageFragment
}
surveyReportsCount
surveyReport {
...SurveyReportFragment
}
filterOptions {
...FilterOptionFragment
}
}
}
Variables
{
"params": CreateProgramParams,
"options": CreateProgramOptions
}
Response
{
"data": {
"createProgram": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programCategoryId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"moduleKeyName": "abc123",
"moduleCategoryKeyName": "abc123",
"startDate": 1592577642,
"endDate": 1592577642,
"goalSetting": GoalSetting,
"plannedTaskSetting": PlannedTaskSetting,
"unplannedTaskSetting": UnplannedTaskSetting,
"surveySetting": SurveySetting,
"userFilterRules": [{}],
"status": "abc123",
"programLabels": ["xyz789"],
"priority": 123,
"isActive": true,
"isDeleted": true,
"year": Year,
"programCategory": ProgramCategory,
"kanbanStage": KanbanStage,
"impactStage": ImpactStage,
"timelineStage": TimelineStage,
"unplannedImpactStage": ImpactStage,
"previousProgram": Program,
"surveyReportsPage": SurveyReportsPage,
"surveyReportsCount": 987,
"surveyReport": SurveyReport,
"filterOptions": [FilterOption]
}
}
}
createProgramType
Description
To create Program Type. Access allowed to WeSoar Super Admin.
Response
Returns a ProgramType
Arguments
| Name | Description |
|---|---|
params - CreateProgramTypeParams!
|
|
options - CreateProgramTypeOptions
|
Example
Query
mutation createProgramType(
$params: CreateProgramTypeParams!,
$options: CreateProgramTypeOptions
) {
createProgramType(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": CreateProgramTypeParams,
"options": CreateProgramTypeOptions
}
Response
{
"data": {
"createProgramType": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 987,
"isActive": true
}
}
}
createReport
Description
To create Report Type. Access allowed to WeSoar Super Admin.
Response
Returns a Report
Arguments
| Name | Description |
|---|---|
params - CreateReportParams!
|
|
options - CreateReportOptions
|
Example
Query
mutation createReport(
$params: CreateReportParams!,
$options: CreateReportOptions
) {
createReport(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
isRTL
}
}
Variables
{
"params": CreateReportParams,
"options": CreateReportOptions
}
Response
{
"data": {
"createReport": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 123,
"isActive": true,
"isRTL": false
}
}
}
createSuperOrganisation
Description
To create Super Organisation. Access allowed to WeSoar Super Admin.
Response
Returns a CreateSuperOrganisationPayload
Arguments
| Name | Description |
|---|---|
params - CreateSuperOrganisationParams!
|
|
options - CreateSuperOrganisationOptions
|
Example
Query
mutation createSuperOrganisation(
$params: CreateSuperOrganisationParams!,
$options: CreateSuperOrganisationOptions
) {
createSuperOrganisation(
params: $params,
options: $options
) {
id
name
keyName
wesoarDomain
organisationGroup
contactPerson {
...CreateSuperOrganisation_Person_PayloadFragment
}
registeredAddress {
...CreateSuperOrganisation_Address_PayloadFragment
}
website
profilePicUrl
organisationSize
organisationIndustry
organisationType
organisationStatus
yearOfEstablishment
totalRevenue
objectives
activationCode
contractDetails {
...CreateSuperOrganisation_ContractDetails_PayloadFragment
}
subscriptions {
...CreateSuperOrganisation_Subscription_PayloadFragment
}
defaultFieldMapping
technicalData {
...CreateSuperOrganisation_TechnicalData_PayloadFragment
}
}
}
Variables
{
"params": CreateSuperOrganisationParams,
"options": CreateSuperOrganisationOptions
}
Response
{
"data": {
"createSuperOrganisation": {
"id": "4",
"name": "xyz789",
"keyName": "xyz789",
"wesoarDomain": "abc123",
"organisationGroup": "xyz789",
"contactPerson": CreateSuperOrganisation_Person_Payload,
"registeredAddress": CreateSuperOrganisation_Address_Payload,
"website": "abc123",
"profilePicUrl": "abc123",
"organisationSize": "xyz789",
"organisationIndustry": "abc123",
"organisationType": "xyz789",
"organisationStatus": "abc123",
"yearOfEstablishment": 987,
"totalRevenue": 123,
"objectives": "xyz789",
"activationCode": "abc123",
"contractDetails": [
CreateSuperOrganisation_ContractDetails_Payload
],
"subscriptions": [
CreateSuperOrganisation_Subscription_Payload
],
"defaultFieldMapping": "xyz789",
"technicalData": CreateSuperOrganisation_TechnicalData_Payload
}
}
}
createSurveyAnswerCategory
Description
To create Survey Answer Category. Access allowed to WeSoar Super Admin.
Response
Returns a SurveyAnswerCategory
Arguments
| Name | Description |
|---|---|
params - CreateSurveyAnswerCategoryParams!
|
|
options - CreateSurveyAnswerCategoryOptions
|
Example
Query
mutation createSurveyAnswerCategory(
$params: CreateSurveyAnswerCategoryParams!,
$options: CreateSurveyAnswerCategoryOptions
) {
createSurveyAnswerCategory(
params: $params,
options: $options
) {
_id
name
keyName
color
percentage
priority
isActive
}
}
Variables
{
"params": CreateSurveyAnswerCategoryParams,
"options": CreateSurveyAnswerCategoryOptions
}
Response
{
"data": {
"createSurveyAnswerCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"color": "abc123",
"percentage": 123.45,
"priority": 987,
"isActive": true
}
}
}
createSurveyQuestion
Description
To create Survey Question. Access allowed to WeSoar Super Admin.
Response
Returns a SurveyQuestion
Arguments
| Name | Description |
|---|---|
params - CreateSurveyQuestionParams!
|
|
options - CreateSurveyQuestionOptions
|
Example
Query
mutation createSurveyQuestion(
$params: CreateSurveyQuestionParams!,
$options: CreateSurveyQuestionOptions
) {
createSurveyQuestion(
params: $params,
options: $options
) {
_id
surveyLibraryQuestionId
question {
...QuestionFragment
}
responseBySpecimenKey {
...SurveyResponseFragment
}
responseBySpecimenId {
...SurveyResponseFragment
}
isLibraryQuestion
conversion
stdDev
countResponses
scaleResponseSummary {
...ScaleResponseSummaryFragment
}
responsesByCheckInId {
...ResponseByCheckInFragment
}
sentiments {
...SentimentFragment
}
summary
}
}
Variables
{
"params": CreateSurveyQuestionParams,
"options": CreateSurveyQuestionOptions
}
Response
{
"data": {
"createSurveyQuestion": {
"_id": "5e5677d71bdc2ae76344968c",
"surveyLibraryQuestionId": "5e5677d71bdc2ae76344968c",
"question": Question,
"responseBySpecimenKey": SurveyResponse,
"responseBySpecimenId": SurveyResponse,
"isLibraryQuestion": true,
"conversion": 123.45,
"stdDev": 123.45,
"countResponses": 987,
"scaleResponseSummary": [ScaleResponseSummary],
"responsesByCheckInId": [ResponseByCheckIn],
"sentiments": [Sentiment],
"summary": ["abc123"]
}
}
}
createSurveyQuestionFactor
Description
To create Survey Question Factor. Access allowed to WeSoar Super Admin.
Response
Returns a SurveyQuestionFactor
Arguments
| Name | Description |
|---|---|
params - CreateSurveyQuestionFactorParams!
|
|
options - CreateSurveyQuestionFactorOptions
|
Example
Query
mutation createSurveyQuestionFactor(
$params: CreateSurveyQuestionFactorParams!,
$options: CreateSurveyQuestionFactorOptions
) {
createSurveyQuestionFactor(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
conversion
stdDev
countQuestions
surveyAnswerCategories {
...SurveyAnswerCategoryFragment
}
overallRankWithGap {
...RankWithGapFragment
}
overallRank
overallGap
wordCloudWords {
...WordCloudWordFragment
}
sentiments {
...SentimentFragment
}
surveyAnswerCompositions {
...SurveyAnswerCategoryFragment
}
summary
responsesByCheckInId {
...ResponseByCheckInFragment
}
responsesTillCheckInId {
...ResponseByCheckInFragment
}
}
}
Variables
{
"params": CreateSurveyQuestionFactorParams,
"options": CreateSurveyQuestionFactorOptions
}
Response
{
"data": {
"createSurveyQuestionFactor": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 987,
"isActive": false,
"conversion": 123.45,
"stdDev": 987.65,
"countQuestions": 987,
"surveyAnswerCategories": [SurveyAnswerCategory],
"overallRankWithGap": RankWithGap,
"overallRank": 123,
"overallGap": 123.45,
"wordCloudWords": [WordCloudWord],
"sentiments": [Sentiment],
"surveyAnswerCompositions": [SurveyAnswerCategory],
"summary": ["xyz789"],
"responsesByCheckInId": [ResponseByCheckIn],
"responsesTillCheckInId": [ResponseByCheckIn]
}
}
}
createSurveyResponse
Description
To create Survey Response. Access allowed to Survey Respondent.
Response
Returns a SurveyResponse
Arguments
| Name | Description |
|---|---|
params - CreateSurveyResponseParams!
|
|
options - CreateSurveyResponseOptions
|
Example
Query
mutation createSurveyResponse(
$params: CreateSurveyResponseParams!,
$options: CreateSurveyResponseOptions
) {
createSurveyResponse(
params: $params,
options: $options
) {
_id
surveyForUserId
surveyQuestionId
choiceAnswers
scaleAnswer
textAnswer
isNotApplicable
remark
isActive
isDeleted
}
}
Variables
{
"params": CreateSurveyResponseParams,
"options": CreateSurveyResponseOptions
}
Response
{
"data": {
"createSurveyResponse": {
"_id": "5e5677d71bdc2ae76344968c",
"surveyForUserId": "5e5677d71bdc2ae76344968c",
"surveyQuestionId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["abc123"],
"scaleAnswer": 123,
"textAnswer": "xyz789",
"isNotApplicable": false,
"remark": "xyz789",
"isActive": false,
"isDeleted": false
}
}
}
createSurveySpecimen
Description
To create Survey Specimen. Access allowed to Super Admin.
Response
Returns a SurveySpecimen
Arguments
| Name | Description |
|---|---|
params - CreateSurveySpecimenParams!
|
|
options - CreateSurveySpecimenOptions
|
Example
Query
mutation createSurveySpecimen(
$params: CreateSurveySpecimenParams!,
$options: CreateSurveySpecimenOptions
) {
createSurveySpecimen(
params: $params,
options: $options
) {
_id
programId
program {
...ProgramFragment
}
userId
user {
...UserFragment
}
isOpen
isActive
responses {
...SurveyResponseFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
surveySpecimenKey
participants {
...UserFragment
}
}
}
Variables
{
"params": CreateSurveySpecimenParams,
"options": CreateSurveySpecimenOptions
}
Response
{
"data": {
"createSurveySpecimen": {
"_id": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"user": User,
"isOpen": true,
"isActive": true,
"responses": [SurveyResponse],
"surveyQuestions": [SurveyQuestion],
"surveySpecimenKey": "abc123",
"participants": [User]
}
}
}
createTermProgram
Description
To create term program. Access allowed to WeSoar Super Admin.
Response
Returns a TermProgram
Arguments
| Name | Description |
|---|---|
params - CreateTermProgramParams!
|
|
options - CreateTermProgramOptions
|
Example
Query
mutation createTermProgram(
$params: CreateTermProgramParams!,
$options: CreateTermProgramOptions
) {
createTermProgram(
params: $params,
options: $options
) {
_id
name
userId
programId
assignDate
deAssignDate
isOpen
isActive
isDeleted
user {
...UserFragment
}
program {
...ProgramFragment
}
myCompanyGoalsPage {
...CommunityGoalsPageFragment
}
myCommunityGoalsPage {
...CommunityGoalsPageFragment
}
approvedGoalsPage {
...GoalsPageFragment
}
withObstacleGoalsPage {
...GoalsPageFragment
}
draftGoalsPage {
...GoalsPageFragment
}
trashedGoalsPage {
...GoalsPageFragment
}
taggedGoalsPage {
...GoalsPageFragment
}
checkInGoalsPage {
...GoalsPageFragment
}
approvedGoalsFacts {
...FactFragment
}
draftGoalsFacts {
...FactFragment
}
trashedGoalsFacts {
...FactFragment
}
taggedGoalsFacts {
...FactFragment
}
submittedGoalsFacts {
...FactFragment
}
goalsFacts {
...FactFragment
}
plannedTasksPage {
...PlannedTasksPageFragment
}
plannedTasksFacts {
...FactFragment
}
taggedPlannedTasksPage {
...PlannedTasksPageFragment
}
taggedPlannedTasksFacts {
...FactFragment
}
unplannedTasksPage {
...UnplannedTasksPageFragment
}
unplannedTasksFacts {
...FactFragment
}
attendancesPage {
...AttendancesPageFragment
}
attendancesFacts {
...FactFragment
}
checkInsPage {
...CheckInsPageFragment
}
checkInsFacts {
...FactFragment
}
appraisalsPage {
...AppraisalsPageFragment
}
appraisalsFacts {
...FactFragment
}
}
}
Variables
{
"params": CreateTermProgramParams,
"options": CreateTermProgramOptions
}
Response
{
"data": {
"createTermProgram": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"assignDate": 1592577642,
"deAssignDate": 1592577642,
"isOpen": false,
"isActive": false,
"isDeleted": true,
"user": User,
"program": Program,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"withObstacleGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"checkInGoalsPage": GoalsPage,
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"checkInsPage": CheckInsPage,
"checkInsFacts": [Fact],
"appraisalsPage": AppraisalsPage,
"appraisalsFacts": [Fact]
}
}
}
createUnplannedTask
Description
To create Unplanned Task. Access allowed to Authenticated User as per business logic.
Response
Returns an UnplannedTask!
Arguments
| Name | Description |
|---|---|
params - CreateUnplannedTaskParams!
|
|
options - CreateUnplannedTaskOptions
|
Example
Query
mutation createUnplannedTask(
$params: CreateUnplannedTaskParams!,
$options: CreateUnplannedTaskOptions
) {
createUnplannedTask(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
unplannedTaskType
unplannedTaskDetail {
...UnplannedTaskDetailFragment
}
comments {
...CommentFragment
}
reactions {
...ReactionFragment
}
impactStageId
impactStage {
...ImpactStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
unplannedTaskCommentsFacts {
...FactFragment
}
myUnplannedTaskReaction {
...ReactionFragment
}
unplannedTaskReactionsFacts {
...FactFragment
}
unplannedTaskReactionsPage {
...ReactionsPageFragment
}
unplannedTasksFacts {
...FactFragment
}
views
}
}
Variables
{
"params": CreateUnplannedTaskParams,
"options": CreateUnplannedTaskOptions
}
Response
{
"data": {
"createUnplannedTask": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "xyz789",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "abc123",
"priority": 123,
"isActive": false,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 123
}
}
}
createUser
Description
To create user. Access allowed to WeSoar Super Admin.
Response
Returns a User
Arguments
| Name | Description |
|---|---|
params - CreateUserParams!
|
|
options - CreateUserOptions
|
Example
Query
mutation createUser(
$params: CreateUserParams!,
$options: CreateUserOptions
) {
createUser(
params: $params,
options: $options
) {
_id
userName
empCode
preferredName
firstName
lastName
email
mobileNumber
isEmailVerified
isMobileNumberVerified
imageUrl
profilePic {
...FileFragment
}
managers {
...ManagerFragment
}
orgUnits
designation
path
aboutMe
myStatus
isReportAppDiagnosticData
isActive
dummy
progress
overallGoalProgress
ytdRating
teamOverallGoalProgress
peersOverallGoalProgress
isManager
managerId
myRoles {
...ManagerTypeFragment
}
cognitoInfo {
...User_CognitoInfoFragment
}
cognitoGroups {
...User_CognitoGroupFragment
}
tokenRoles
tokenAbility {
...AbilityFragment
}
roles {
...RoleFragment
}
ability {
...AbilityFragment
}
rbacRoles
permissions {
...User_PermissionFragment
}
terms {
...TermFragment
}
isMFAEnabled
years {
...YearFragment
}
moduleCategories {
...UserModuelCategoryFragment
}
termPrograms {
...TermProgramFragment
}
termProgramsPage {
...TermProgramsPageFragment
}
termsPage {
...TermsPageFragment
}
termsFacts {
...FactFragment
}
latestSupportTicket {
...SupportTicketFragment
}
peersPage {
...UsersPageFragment
}
myManager {
...UserFragment
}
myEvaluator {
...UserFragment
}
directReportsPage {
...UsersPageFragment
}
directReportsFact {
...FactFragment
}
managersInMyDirectReportsPage {
...UsersPageFragment
}
orgUnit
organizationUnit {
...OrgUnitFragment
}
myCEO {
...UserFragment
}
inDirectReportsPage {
...UsersPageFragment
}
termProgram {
...TermProgramFragment
}
latestTermProgram {
...TermProgramFragment
}
userFilterOptions {
...UserFilterOptionFragment
}
subUsersPage {
...UsersPageFragment
}
myCompanyGoalsPage {
...CommunityGoalsPageFragment
}
myCommunityGoalsPage {
...CommunityGoalsPageFragment
}
approvedGoalsPage {
...GoalsPageFragment
}
completedGoalsPage {
...GoalsPageFragment
}
canceledGoalsPage {
...GoalsPageFragment
}
draftGoalsPage {
...GoalsPageFragment
}
trashedGoalsPage {
...GoalsPageFragment
}
taggedGoalsPage {
...GoalsPageFragment
}
goalCreationStatus
goalCreationStatusFacts {
...FactFragment
}
approvedGoalsFacts {
...FactFragment
}
draftGoalsFacts {
...FactFragment
}
trashedGoalsFacts {
...FactFragment
}
taggedGoalsFacts {
...FactFragment
}
submittedGoalsFacts {
...FactFragment
}
goalsFacts {
...FactFragment
}
plannedTasksPage {
...PlannedTasksPageFragment
}
plannedTasksFacts {
...FactFragment
}
taggedPlannedTasksPage {
...PlannedTasksPageFragment
}
taggedPlannedTasksFacts {
...FactFragment
}
unplannedTasksPage {
...UnplannedTasksPageFragment
}
unplannedTasksFacts {
...FactFragment
}
attendancesPage {
...AttendancesPageFragment
}
attendancesFacts {
...FactFragment
}
notificationsPage {
...NotificationsPageFragment
}
surveyScore
surveySpecimensPage {
...SurveySpecimensPageFragment
}
socketUrl
programsOfDirectReportsPage {
...ProgramsPageFragment
}
surveyReport {
...SurveyReportFragment
}
surveyReportWithPrevSurveyReport {
...SurveyReportFragment
}
}
}
Variables
{
"params": CreateUserParams,
"options": CreateUserOptions
}
Response
{
"data": {
"createUser": {
"_id": "5e5677d71bdc2ae76344968c",
"userName": "xyz789",
"empCode": "xyz789",
"preferredName": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"email": "abc123",
"mobileNumber": "abc123",
"isEmailVerified": false,
"isMobileNumberVerified": false,
"imageUrl": "xyz789",
"profilePic": File,
"managers": [Manager],
"orgUnits": [
"5e5677d71bdc2ae76344968c"
],
"designation": "xyz789",
"path": "abc123",
"aboutMe": "xyz789",
"myStatus": "xyz789",
"isReportAppDiagnosticData": true,
"isActive": true,
"dummy": "xyz789",
"progress": 123.45,
"overallGoalProgress": 123.45,
"ytdRating": 987.65,
"teamOverallGoalProgress": 987.65,
"peersOverallGoalProgress": 987.65,
"isManager": true,
"managerId": "xyz789",
"myRoles": [ManagerType],
"cognitoInfo": User_CognitoInfo,
"cognitoGroups": [User_CognitoGroup],
"tokenRoles": ["xyz789"],
"tokenAbility": [Ability],
"roles": [Role],
"ability": [Ability],
"rbacRoles": ["abc123"],
"permissions": [User_Permission],
"terms": [Term],
"isMFAEnabled": false,
"years": [Year],
"moduleCategories": [UserModuelCategory],
"termPrograms": [TermProgram],
"termProgramsPage": TermProgramsPage,
"termsPage": TermsPage,
"termsFacts": [Fact],
"latestSupportTicket": SupportTicket,
"peersPage": UsersPage,
"myManager": User,
"myEvaluator": User,
"directReportsPage": UsersPage,
"directReportsFact": [Fact],
"managersInMyDirectReportsPage": UsersPage,
"orgUnit": "xyz789",
"organizationUnit": OrgUnit,
"myCEO": User,
"inDirectReportsPage": UsersPage,
"termProgram": TermProgram,
"latestTermProgram": TermProgram,
"userFilterOptions": [UserFilterOption],
"subUsersPage": UsersPage,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"completedGoalsPage": GoalsPage,
"canceledGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"goalCreationStatus": "xyz789",
"goalCreationStatusFacts": [Fact],
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"notificationsPage": NotificationsPage,
"surveyScore": "abc123",
"surveySpecimensPage": SurveySpecimensPage,
"socketUrl": "abc123",
"programsOfDirectReportsPage": ProgramsPage,
"surveyReport": SurveyReport,
"surveyReportWithPrevSurveyReport": SurveyReport
}
}
}
createYear
Description
To create Year. Access allowed to WeSoar Super Admin.
Response
Returns a Year
Arguments
| Name | Description |
|---|---|
params - CreateYearParams!
|
|
options - CreateYearOptions
|
Example
Query
mutation createYear(
$params: CreateYearParams!,
$options: CreateYearOptions
) {
createYear(
params: $params,
options: $options
) {
_id
userId
name
keyName
priority
isActive
userModuleCategories {
...UserModuelCategoryFragment
}
}
}
Variables
{
"params": CreateYearParams,
"options": CreateYearOptions
}
Response
{
"data": {
"createYear": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 123,
"isActive": true,
"userModuleCategories": [UserModuelCategory]
}
}
}
declineCheckIn
Description
To decline CheckIns. Access allowed to authenticated user who is part of CheckIn Workflow as per business logic.
Response
Returns a CheckIn
Example
Query
mutation declineCheckIn(
$checkInId: ObjectID,
$managerTypeId: ObjectID,
$userManagerId: ObjectID
) {
declineCheckIn(
checkInId: $checkInId,
managerTypeId: $managerTypeId,
userManagerId: $userManagerId
) {
_id
name
checkInType
termProgramId
userId
programId
checkInSetting {
...CheckInSettingFragment
}
checkInDate
checkInRatings {
...CheckInRatingFragment
}
priority
checkInStatus
user {
...UserFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
competencies {
...SurveyQuestionFragment
}
competenciesFPage {
...SurveyQuestionFragment
}
competenciesPage {
...SurveyQuestionsPageFragment
}
isDeleted
latestRating {
...CheckInRatingFragment
}
checkInRatingsPage {
...CheckInRatingsPageFragment
}
checkInRatingsFPage {
...CheckInRatingFragment
}
checkInRatingsFOne {
...CheckInRatingFragment
}
commentTrailId
isActiveForEmp
isActiveForManager
}
}
Variables
{
"checkInId": "5e5677d71bdc2ae76344968c",
"managerTypeId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c"
}
Response
{
"data": {
"declineCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"checkInType": "abc123",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 123,
"checkInStatus": "abc123",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": false,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": false,
"isActiveForManager": false
}
}
}
deleteAlarms
Description
To delete Alarms. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteAlarmsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteAlarmsParams!
|
|
options - DeleteAlarmsOptions
|
Example
Query
mutation deleteAlarms(
$params: DeleteAlarmsParams!,
$options: DeleteAlarmsOptions
) {
deleteAlarms(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteAlarmsParams,
"options": DeleteAlarmsOptions
}
Response
{"data": {"deleteAlarms": {"recordsDeleted": 987}}}
deleteAllNotifications
Description
DEPRECATED To delete all Notifications. Access allowed to Authenticated User.
Response
Returns a DeleteNotificationsPayload!
Arguments
| Name | Description |
|---|---|
dummy - Boolean
|
Example
Query
mutation deleteAllNotifications($dummy: Boolean) {
deleteAllNotifications(dummy: $dummy) {
recordsDeleted
}
}
Variables
{"dummy": false}
Response
{"data": {"deleteAllNotifications": {"recordsDeleted": 987}}}
deleteAppraisals
Description
To delete an appraisal. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteAppraisalsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteAppraisalsParams!
|
|
options - DeleteAppraisalsOptions
|
Example
Query
mutation deleteAppraisals(
$params: DeleteAppraisalsParams!,
$options: DeleteAppraisalsOptions
) {
deleteAppraisals(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteAppraisalsParams,
"options": DeleteAppraisalsOptions
}
Response
{"data": {"deleteAppraisals": {"recordsDeleted": 123}}}
deleteAttendances
Description
DEPRECATED To update attendances. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteAttendancesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteAttendancesParams!
|
|
options - DeleteAttendancesOptions
|
Example
Query
mutation deleteAttendances(
$params: DeleteAttendancesParams!,
$options: DeleteAttendancesOptions
) {
deleteAttendances(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteAttendancesParams,
"options": DeleteAttendancesOptions
}
Response
{"data": {"deleteAttendances": {"recordsDeleted": 123}}}
deleteCheckIns
Description
To delete CheckIns. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteCheckInsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteCheckInsParams!
|
|
options - DeleteCheckInsOptions
|
Example
Query
mutation deleteCheckIns(
$params: DeleteCheckInsParams!,
$options: DeleteCheckInsOptions
) {
deleteCheckIns(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteCheckInsParams,
"options": DeleteCheckInsOptions
}
Response
{"data": {"deleteCheckIns": {"recordsDeleted": 123}}}
deleteComment
Description
To delete a comment. Access allowed to authenticated user.
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
params - DeleteCommentParams!
|
|
rootOptions - RootOptions
|
Example
Query
mutation deleteComment(
$params: DeleteCommentParams!,
$rootOptions: RootOptions
) {
deleteComment(
params: $params,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"params": DeleteCommentParams,
"rootOptions": RootOptions
}
Response
{
"data": {
"deleteComment": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": false,
"isDeleted": true,
"commentDate": 1592577642,
"type": "abc123",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
deleteCommunicationEvents
Description
To delete Communication Event. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteCommunicationEventsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteCommunicationEventsParams!
|
|
options - DeleteCommunicationEventsOptions
|
Example
Query
mutation deleteCommunicationEvents(
$params: DeleteCommunicationEventsParams!,
$options: DeleteCommunicationEventsOptions
) {
deleteCommunicationEvents(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteCommunicationEventsParams,
"options": DeleteCommunicationEventsOptions
}
Response
{"data": {"deleteCommunicationEvents": {"recordsDeleted": 987}}}
deleteCommunityGoals
Description
To delete Community Goal. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteCommunityGoalsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteCommunityGoalsParams!
|
|
options - DeleteCommunityGoalsOptions
|
Example
Query
mutation deleteCommunityGoals(
$params: DeleteCommunityGoalsParams!,
$options: DeleteCommunityGoalsOptions
) {
deleteCommunityGoals(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteCommunityGoalsParams,
"options": DeleteCommunityGoalsOptions
}
Response
{"data": {"deleteCommunityGoals": {"recordsDeleted": 123}}}
deleteConversationMetas
Description
To delete Conversation Metas. Access allowed to Authenticated User.
Response
Returns a Conversation
Arguments
| Name | Description |
|---|---|
params - DeleteConversationMetasParams!
|
|
options - DeleteConversationMetasOptions
|
Example
Query
mutation deleteConversationMetas(
$params: DeleteConversationMetasParams!,
$options: DeleteConversationMetasOptions
) {
deleteConversationMetas(
params: $params,
options: $options
) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{
"params": DeleteConversationMetasParams,
"options": DeleteConversationMetasOptions
}
Response
{
"data": {
"deleteConversationMetas": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"description": "xyz789",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "abc123",
"fldName": "abc123",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 987,
"isActive": true,
"isDeleted": false,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 123
}
}
}
deleteConversationSubscribers
Description
To delete Conversation Subscribers. Access allowed to Authenticated User.
Response
Returns a Conversation
Arguments
| Name | Description |
|---|---|
params - DeleteConversationSubscribersParams!
|
|
options - DeleteConversationSubscribersOptions
|
Example
Query
mutation deleteConversationSubscribers(
$params: DeleteConversationSubscribersParams!,
$options: DeleteConversationSubscribersOptions
) {
deleteConversationSubscribers(
params: $params,
options: $options
) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{
"params": DeleteConversationSubscribersParams,
"options": DeleteConversationSubscribersOptions
}
Response
{
"data": {
"deleteConversationSubscribers": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"description": "abc123",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "xyz789",
"fldName": "abc123",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 123,
"isActive": false,
"isDeleted": true,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 123
}
}
}
deleteConversations
Description
To delete Conversation. Access allowed to Authenticated User.
Response
Returns a DeleteConversationsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteConversationsParams!
|
|
options - DeleteConversationsOptions
|
Example
Query
mutation deleteConversations(
$params: DeleteConversationsParams!,
$options: DeleteConversationsOptions
) {
deleteConversations(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteConversationsParams,
"options": DeleteConversationsOptions
}
Response
{"data": {"deleteConversations": {"recordsDeleted": 123}}}
deleteGoals
Description
To delete Goals. Access allowed to authenticated user as per business logic.
Response
Returns a DeleteGoalsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteGoalsParams!
|
|
options - DeleteGoalsOptions
|
Example
Query
mutation deleteGoals(
$params: DeleteGoalsParams!,
$options: DeleteGoalsOptions
) {
deleteGoals(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": DeleteGoalsParams,
"options": DeleteGoalsOptions
}
Response
{"data": {"deleteGoals": {"recordsUpdated": 987}}}
deleteLanguages
Description
To delete Language. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteLanguagesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteLanguagesParams!
|
|
options - DeleteLanguagesOptions
|
Example
Query
mutation deleteLanguages(
$params: DeleteLanguagesParams!,
$options: DeleteLanguagesOptions
) {
deleteLanguages(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteLanguagesParams,
"options": DeleteLanguagesOptions
}
Response
{"data": {"deleteLanguages": {"recordsDeleted": 987}}}
deleteMaster
Description
To delete Master. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteMasterPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteMasterParams!
|
|
options - DeleteMasterOptions
|
|
modelName - String
|
Example
Query
mutation deleteMaster(
$params: DeleteMasterParams!,
$options: DeleteMasterOptions,
$modelName: String
) {
deleteMaster(
params: $params,
options: $options,
modelName: $modelName
) {
status
}
}
Variables
{
"params": DeleteMasterParams,
"options": DeleteMasterOptions,
"modelName": "xyz789"
}
Response
{"data": {"deleteMaster": {"status": true}}}
deleteMessage
Response
Returns a Message
Arguments
| Name | Description |
|---|---|
params - DeleteMessageParams!
|
Example
Query
mutation deleteMessage($params: DeleteMessageParams!) {
deleteMessage(params: $params) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"params": DeleteMessageParams}
Response
{
"data": {
"deleteMessage": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "xyz789",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": false,
"isDeleted": false,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
deleteModuleCategories
Description
To delete Module Categories. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteModuleCategoriesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteModuleCategoriesParams!
|
|
options - DeleteModuleCategoriesOptions
|
Example
Query
mutation deleteModuleCategories(
$params: DeleteModuleCategoriesParams!,
$options: DeleteModuleCategoriesOptions
) {
deleteModuleCategories(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteModuleCategoriesParams,
"options": DeleteModuleCategoriesOptions
}
Response
{"data": {"deleteModuleCategories": {"recordsDeleted": 123}}}
deleteModules
Description
To delete Module. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteModulesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteModulesParams!
|
|
options - DeleteModulesOptions
|
Example
Query
mutation deleteModules(
$params: DeleteModulesParams!,
$options: DeleteModulesOptions
) {
deleteModules(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteModulesParams,
"options": DeleteModulesOptions
}
Response
{"data": {"deleteModules": {"recordsDeleted": 123}}}
deleteNotifications
Description
DEPRECATED To delete Notifications. Access allowed to Authenticated User.
Response
Returns a DeleteNotificationsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteNotificationsParams!
|
|
options - DeleteNotificationsOptions
|
Example
Query
mutation deleteNotifications(
$params: DeleteNotificationsParams!,
$options: DeleteNotificationsOptions
) {
deleteNotifications(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteNotificationsParams,
"options": DeleteNotificationsOptions
}
Response
{"data": {"deleteNotifications": {"recordsDeleted": 123}}}
deleteOrgUnits
Description
To delete Organisation Unit. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteOrgUnitsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteOrgUnitsParams!
|
|
options - DeleteOrgUnitsOptions
|
Example
Query
mutation deleteOrgUnits(
$params: DeleteOrgUnitsParams!,
$options: DeleteOrgUnitsOptions
) {
deleteOrgUnits(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteOrgUnitsParams,
"options": DeleteOrgUnitsOptions
}
Response
{"data": {"deleteOrgUnits": {"recordsDeleted": 987}}}
deletePlannedTasks
Description
To delete Planned Tasks. Access allowed to Authenticated User as per business logic.
Response
Returns a DeletePlannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - DeletePlannedTasksParams!
|
|
options - DeletePlannedTasksOptions
|
Example
Query
mutation deletePlannedTasks(
$params: DeletePlannedTasksParams!,
$options: DeletePlannedTasksOptions
) {
deletePlannedTasks(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeletePlannedTasksParams,
"options": DeletePlannedTasksOptions
}
Response
{"data": {"deletePlannedTasks": {"recordsDeleted": 987}}}
deleteProgramTypes
Description
To delete Program Type. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteProgramTypesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteProgramTypesParams!
|
|
options - DeleteProgramTypesOptions
|
Example
Query
mutation deleteProgramTypes(
$params: DeleteProgramTypesParams!,
$options: DeleteProgramTypesOptions
) {
deleteProgramTypes(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteProgramTypesParams,
"options": DeleteProgramTypesOptions
}
Response
{"data": {"deleteProgramTypes": {"recordsDeleted": 123}}}
deletePrograms
Description
To delete Program. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteProgramsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteProgramsParams!
|
|
options - DeleteProgramsOptions
|
Example
Query
mutation deletePrograms(
$params: DeleteProgramsParams!,
$options: DeleteProgramsOptions
) {
deletePrograms(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteProgramsParams,
"options": DeleteProgramsOptions
}
Response
{"data": {"deletePrograms": {"recordsDeleted": 123}}}
deleteReports
Description
To delete Report Types. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteReportsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteReportsParams!
|
|
options - DeleteReportsOptions
|
Example
Query
mutation deleteReports(
$params: DeleteReportsParams!,
$options: DeleteReportsOptions
) {
deleteReports(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteReportsParams,
"options": DeleteReportsOptions
}
Response
{"data": {"deleteReports": {"recordsDeleted": 987}}}
deleteSurveyAnswerCategorys
Description
To delete Survey Answer Category. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteSurveyAnswerCategoriesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteSurveyAnswerCategoriesParams!
|
|
options - DeleteSurveyAnswerCategoriesOptions
|
Example
Query
mutation deleteSurveyAnswerCategorys(
$params: DeleteSurveyAnswerCategoriesParams!,
$options: DeleteSurveyAnswerCategoriesOptions
) {
deleteSurveyAnswerCategorys(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteSurveyAnswerCategoriesParams,
"options": DeleteSurveyAnswerCategoriesOptions
}
Response
{"data": {"deleteSurveyAnswerCategorys": {"recordsDeleted": 123}}}
deleteSurveyQuestionFactors
Description
To delete Survey Question Factors. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteSurveyQuestionFactorsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteSurveyQuestionFactorsParams!
|
|
options - DeleteSurveyQuestionFactorsOptions
|
Example
Query
mutation deleteSurveyQuestionFactors(
$params: DeleteSurveyQuestionFactorsParams!,
$options: DeleteSurveyQuestionFactorsOptions
) {
deleteSurveyQuestionFactors(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteSurveyQuestionFactorsParams,
"options": DeleteSurveyQuestionFactorsOptions
}
Response
{"data": {"deleteSurveyQuestionFactors": {"recordsDeleted": 987}}}
deleteSurveyQuestions
Description
To delete Survey Question. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteSurveyQuestionsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteSurveyQuestionsParams!
|
|
options - DeleteSurveyQuestionsOptions
|
Example
Query
mutation deleteSurveyQuestions(
$params: DeleteSurveyQuestionsParams!,
$options: DeleteSurveyQuestionsOptions
) {
deleteSurveyQuestions(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteSurveyQuestionsParams,
"options": DeleteSurveyQuestionsOptions
}
Response
{"data": {"deleteSurveyQuestions": {"recordsDeleted": 987}}}
deleteSurveyResponses
Description
To delete Survey Responses. Access allowed to Super Admin.
Response
Returns a DeleteSurveyResponsesPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteSurveyResponsesParams!
|
|
options - DeleteSurveyResponsesOptions
|
Example
Query
mutation deleteSurveyResponses(
$params: DeleteSurveyResponsesParams!,
$options: DeleteSurveyResponsesOptions
) {
deleteSurveyResponses(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteSurveyResponsesParams,
"options": DeleteSurveyResponsesOptions
}
Response
{"data": {"deleteSurveyResponses": {"recordsDeleted": 987}}}
deleteSurveySpecimens
Description
To delete Survey Specimen. Access allowed to Super Admin.
Response
Returns a DeleteSurveySpecimensPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteSurveySpecimensParams!
|
|
options - DeleteSurveySpecimensOptions
|
Example
Query
mutation deleteSurveySpecimens(
$params: DeleteSurveySpecimensParams!,
$options: DeleteSurveySpecimensOptions
) {
deleteSurveySpecimens(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteSurveySpecimensParams,
"options": DeleteSurveySpecimensOptions
}
Response
{"data": {"deleteSurveySpecimens": {"recordsDeleted": 987}}}
deleteTermPrograms
Description
To delete term program. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteTermProgramsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteTermProgramsParams!
|
|
options - DeleteTermProgramsOptions
|
Example
Query
mutation deleteTermPrograms(
$params: DeleteTermProgramsParams!,
$options: DeleteTermProgramsOptions
) {
deleteTermPrograms(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteTermProgramsParams,
"options": DeleteTermProgramsOptions
}
Response
{"data": {"deleteTermPrograms": {"recordsDeleted": 123}}}
deleteUnplannedTasks
Description
To delete Unplanned Tasks. Access allowed to Authenticated User as per business logic.
Response
Returns a DeleteUnplannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteUnplannedTasksParams!
|
|
options - DeleteUnplannedTasksOptions
|
Example
Query
mutation deleteUnplannedTasks(
$params: DeleteUnplannedTasksParams!,
$options: DeleteUnplannedTasksOptions
) {
deleteUnplannedTasks(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteUnplannedTasksParams,
"options": DeleteUnplannedTasksOptions
}
Response
{"data": {"deleteUnplannedTasks": {"recordsDeleted": 987}}}
deleteYears
Description
To delete Years. Access allowed to WeSoar Super Admin.
Response
Returns a DeleteYearsPayload!
Arguments
| Name | Description |
|---|---|
params - DeleteYearsParams!
|
|
options - DeleteYearsOptions
|
Example
Query
mutation deleteYears(
$params: DeleteYearsParams!,
$options: DeleteYearsOptions
) {
deleteYears(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": DeleteYearsParams,
"options": DeleteYearsOptions
}
Response
{"data": {"deleteYears": {"recordsDeleted": 987}}}
disableMfa
Description
DEPRECATED To Disable MFA. Access allowed to WeSoar Super Admin.
Response
Returns a DisableMfaPayload
Arguments
| Name | Description |
|---|---|
params - Boolean
|
Example
Query
mutation disableMfa($params: Boolean) {
disableMfa(params: $params) {
status
}
}
Variables
{"params": false}
Response
{"data": {"disableMfa": {"status": false}}}
enableMfa
Description
DEPRECATED To Enable MFA. Access allowed to WeSoar Super Admin.
Response
Returns an EnableMfaPayload
Arguments
| Name | Description |
|---|---|
params - Boolean
|
Example
Query
mutation enableMfa($params: Boolean) {
enableMfa(params: $params) {
status
}
}
Variables
{"params": true}
Response
{"data": {"enableMfa": {"status": true}}}
forgotPassword
Description
DEPRECATED To Forgot password. Access allowed to WeSoar Super Admin.
Response
Returns a ForgotPasswordPayload
Arguments
| Name | Description |
|---|---|
params - ForgotPasswordParams
|
|
options - ForgotPasswordOptions
|
Example
Query
mutation forgotPassword(
$params: ForgotPasswordParams,
$options: ForgotPasswordOptions
) {
forgotPassword(
params: $params,
options: $options
) {
codeDeliveryDetails {
...CodeDeliveryDetailsFragment
}
}
}
Variables
{
"params": ForgotPasswordParams,
"options": ForgotPasswordOptions
}
Response
{
"data": {
"forgotPassword": {
"codeDeliveryDetails": CodeDeliveryDetails
}
}
}
getFileUploadUrl
Description
To generate file upload URL. Access allowed to Authenticated User.
Response
Returns a FileUploadUrlPayload
Arguments
| Name | Description |
|---|---|
params - GetFileUploadUrlParams!
|
|
options - GetFileUploadUrlOptions
|
Example
Query
mutation getFileUploadUrl(
$params: GetFileUploadUrlParams!,
$options: GetFileUploadUrlOptions
) {
getFileUploadUrl(
params: $params,
options: $options
) {
uploadUrl
fileKeyName
uploadFields {
...uploadFieldFragment
}
}
}
Variables
{
"params": GetFileUploadUrlParams,
"options": GetFileUploadUrlOptions
}
Response
{
"data": {
"getFileUploadUrl": {
"uploadUrl": "xyz789",
"fileKeyName": "xyz789",
"uploadFields": [uploadField]
}
}
}
getLoginFromRefreshToken
Description
DEPRECATED To get login from refresh token. Access allowed to WeSoar Super Admin.
Response
Returns a GetLoginFromRefreshTokenPayload
Arguments
| Name | Description |
|---|---|
params - GetLoginFromRefreshTokenParams
|
Example
Query
mutation getLoginFromRefreshToken($params: GetLoginFromRefreshTokenParams) {
getLoginFromRefreshToken(params: $params) {
tokens {
...TokensFragment
}
}
}
Variables
{"params": GetLoginFromRefreshTokenParams}
Response
{"data": {"getLoginFromRefreshToken": {"tokens": Tokens}}}
removeAttendanceLog
Description
DEPRECATED To remove an attendance entry. Access allowed to WeSoar Super Admin.
Response
Returns an Attendance
Arguments
| Name | Description |
|---|---|
params - RemoveAttendanceLogParams!
|
|
options - RemoveAttendanceLogOptions
|
Example
Query
mutation removeAttendanceLog(
$params: RemoveAttendanceLogParams!,
$options: RemoveAttendanceLogOptions
) {
removeAttendanceLog(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
userId
attendanceLogs {
...AttendanceLogFragment
}
isActive
isDeleted
attendanceLogsPage {
...AttendanceLogsPageFragment
}
attendanceLogForDate {
...AttendanceLogFragment
}
}
}
Variables
{
"params": RemoveAttendanceLogParams,
"options": RemoveAttendanceLogOptions
}
Response
{
"data": {
"removeAttendanceLog": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": false,
"isDeleted": false,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
}
}
removeAttendances
Description
DEPRECATED To remove attendances. Access allowed to WeSoar Super Admin.
Response
Returns a RemoveAttendancesPayload!
Arguments
| Name | Description |
|---|---|
params - RemoveAttendancesParams!
|
|
options - RemoveAttendancesOptions
|
Example
Query
mutation removeAttendances(
$params: RemoveAttendancesParams!,
$options: RemoveAttendancesOptions
) {
removeAttendances(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": RemoveAttendancesParams,
"options": RemoveAttendancesOptions
}
Response
{"data": {"removeAttendances": {"recordsDeleted": 123}}}
removeCommentReaction
Description
To remove a comment. reaction Access allowed to authenticated user.
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
params - RemoveCommentReactionParams!
|
|
rootOptions - RootOptions
|
Example
Query
mutation removeCommentReaction(
$params: RemoveCommentReactionParams!,
$rootOptions: RootOptions
) {
removeCommentReaction(
params: $params,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"params": RemoveCommentReactionParams,
"rootOptions": RootOptions
}
Response
{
"data": {
"removeCommentReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": false,
"isDeleted": true,
"commentDate": 1592577642,
"type": "xyz789",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
removeGoalAppraisal
Description
DEPRECATED To remove Goal Appraisals. Access allowed to WeSoar Super Admin.
Response
Returns a Goal
Arguments
| Name | Description |
|---|---|
params - RemoveGoalAppraisalParams!
|
|
options - RemoveGoalAppraisalOptions
|
Example
Query
mutation removeGoalAppraisal(
$params: RemoveGoalAppraisalParams!,
$options: RemoveGoalAppraisalOptions
) {
removeGoalAppraisal(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": RemoveGoalAppraisalParams,
"options": RemoveGoalAppraisalOptions
}
Response
{
"data": {
"removeGoalAppraisal": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "abc123",
"goalType": "abc123",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "xyz789",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 123,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "xyz789",
"goalProgress": 987,
"priority": 987,
"isActive": false,
"isShowInPlannedTask": true,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
removeGoalCheckIn
Description
DEPRECATED To remove Goal CheckIn. Access allowed to WeSoar Super Admin.
Response
Returns a Goal
Arguments
| Name | Description |
|---|---|
params - RemoveGoalCheckInParams!
|
|
options - RemoveGoalCheckInOptions
|
Example
Query
mutation removeGoalCheckIn(
$params: RemoveGoalCheckInParams!,
$options: RemoveGoalCheckInOptions
) {
removeGoalCheckIn(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": RemoveGoalCheckInParams,
"options": RemoveGoalCheckInOptions
}
Response
{
"data": {
"removeGoalCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "xyz789",
"goalType": "xyz789",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 987,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "abc123",
"goalProgress": 987,
"priority": 987,
"isActive": false,
"isShowInPlannedTask": false,
"isShowInUnplannedTask": true,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
removeGoals
Description
To remove Goals. Access allowed to WeSoar Super Admin.
Response
Returns a RemoveGoalsPayload!
Arguments
| Name | Description |
|---|---|
params - RemoveGoalsParams!
|
|
options - RemoveGoalsOptions
|
Example
Query
mutation removeGoals(
$params: RemoveGoalsParams!,
$options: RemoveGoalsOptions
) {
removeGoals(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": RemoveGoalsParams,
"options": RemoveGoalsOptions
}
Response
{"data": {"removeGoals": {"recordsDeleted": 987}}}
removeMessageReaction
Response
Returns a Message
Arguments
| Name | Description |
|---|---|
params - RemoveMessageReactionParams!
|
Example
Query
mutation removeMessageReaction($params: RemoveMessageReactionParams!) {
removeMessageReaction(params: $params) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"params": RemoveMessageReactionParams}
Response
{
"data": {
"removeMessageReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "abc123",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": false,
"isDeleted": false,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
removeNotifications
Description
DEPRECATED To remove Notification. Access allowed to WeSoar Super Admin.
Response
Returns a RemoveNotificationsPayload!
Arguments
| Name | Description |
|---|---|
params - RemoveNotificationsParams!
|
|
options - RemoveNotificationsOptions
|
Example
Query
mutation removeNotifications(
$params: RemoveNotificationsParams!,
$options: RemoveNotificationsOptions
) {
removeNotifications(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": RemoveNotificationsParams,
"options": RemoveNotificationsOptions
}
Response
{"data": {"removeNotifications": {"recordsDeleted": 987}}}
removePlannedTaskFollowUp
Description
To remove Planned Tas follow up. Access allowed to Authenticated User as per business logic.
Response
Returns a PlannedTask
Arguments
| Name | Description |
|---|---|
params - RemovePlannedTaskFollowUpParams!
|
|
options - RemovePlannedTaskFollowUpOptions
|
Example
Query
mutation removePlannedTaskFollowUp(
$params: RemovePlannedTaskFollowUpParams!,
$options: RemovePlannedTaskFollowUpOptions
) {
removePlannedTaskFollowUp(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{
"params": RemovePlannedTaskFollowUpParams,
"options": RemovePlannedTaskFollowUpOptions
}
Response
{
"data": {
"removePlannedTaskFollowUp": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "xyz789",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "abc123",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "xyz789",
"priority": 987,
"isActive": true,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 987
}
}
}
removePlannedTasks
Description
To remove Planned Tasks. Access allowed to Super Admin.
Response
Returns a RemovePlannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - RemovePlannedTasksParams!
|
|
options - RemovePlannedTasksOptions
|
Example
Query
mutation removePlannedTasks(
$params: RemovePlannedTasksParams!,
$options: RemovePlannedTasksOptions
) {
removePlannedTasks(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": RemovePlannedTasksParams,
"options": RemovePlannedTasksOptions
}
Response
{"data": {"removePlannedTasks": {"recordsDeleted": 123}}}
removeUnplannedTaskReaction
Description
To remove Unplanned Task Reaction. Access allowed to Authenticated User as per business logic.
Response
Returns an UnplannedTask
Arguments
| Name | Description |
|---|---|
params - RemoveUnplannedTaskReactionParams!
|
|
options - RemoveUnplannedTaskReactionOptions
|
Example
Query
mutation removeUnplannedTaskReaction(
$params: RemoveUnplannedTaskReactionParams!,
$options: RemoveUnplannedTaskReactionOptions
) {
removeUnplannedTaskReaction(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
unplannedTaskType
unplannedTaskDetail {
...UnplannedTaskDetailFragment
}
comments {
...CommentFragment
}
reactions {
...ReactionFragment
}
impactStageId
impactStage {
...ImpactStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
unplannedTaskCommentsFacts {
...FactFragment
}
myUnplannedTaskReaction {
...ReactionFragment
}
unplannedTaskReactionsFacts {
...FactFragment
}
unplannedTaskReactionsPage {
...ReactionsPageFragment
}
unplannedTasksFacts {
...FactFragment
}
views
}
}
Variables
{
"params": RemoveUnplannedTaskReactionParams,
"options": RemoveUnplannedTaskReactionOptions
}
Response
{
"data": {
"removeUnplannedTaskReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "xyz789",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "xyz789",
"priority": 987,
"isActive": true,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 123
}
}
}
removeUnplannedTasks
Description
To create Unplanned Tasks. Access allowed to WeSoar Super Admin.
Response
Returns a RemoveUnplannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - RemoveUnplannedTasksParams!
|
|
options - RemoveUnplannedTasksOptions
|
Example
Query
mutation removeUnplannedTasks(
$params: RemoveUnplannedTasksParams!,
$options: RemoveUnplannedTasksOptions
) {
removeUnplannedTasks(
params: $params,
options: $options
) {
recordsDeleted
}
}
Variables
{
"params": RemoveUnplannedTasksParams,
"options": RemoveUnplannedTasksOptions
}
Response
{"data": {"removeUnplannedTasks": {"recordsDeleted": 123}}}
resendEmailCode
Description
DEPRECATED To resent Email OTP. Access allowed to WeSoar Super Admin.
Response
Returns a ResendEmailCodePayload
Arguments
| Name | Description |
|---|---|
params - Boolean
|
Example
Query
mutation resendEmailCode($params: Boolean) {
resendEmailCode(params: $params) {
codeDeliveryDetails {
...CodeDeliveryDetailsFragment
}
}
}
Variables
{"params": false}
Response
{
"data": {
"resendEmailCode": {
"codeDeliveryDetails": CodeDeliveryDetails
}
}
}
resendMobileNumberCode
Description
DEPRECATED To resent mobile number OTP. Access allowed to WeSoar Super Admin.
Response
Returns a ResendMobileNumberCodePayload
Arguments
| Name | Description |
|---|---|
params - Boolean
|
Example
Query
mutation resendMobileNumberCode($params: Boolean) {
resendMobileNumberCode(params: $params) {
codeDeliveryDetails {
...CodeDeliveryDetailsFragment
}
}
}
Variables
{"params": false}
Response
{
"data": {
"resendMobileNumberCode": {
"codeDeliveryDetails": CodeDeliveryDetails
}
}
}
resetPasswordOnFirstLogin
Description
DEPRECATED To Reset Password on first login. Access allowed to WeSoar Super Admin.
Response
Returns a SignInPayload
Arguments
| Name | Description |
|---|---|
params - ResetPasswordOnFirstLoginParams!
|
|
options - ResetPasswordOnFirstLoginOptions
|
Example
Query
mutation resetPasswordOnFirstLogin(
$params: ResetPasswordOnFirstLoginParams!,
$options: ResetPasswordOnFirstLoginOptions
) {
resetPasswordOnFirstLogin(
params: $params,
options: $options
) {
tokens {
...TokensFragment
}
challenge {
...ChallengeFragment
}
}
}
Variables
{
"params": ResetPasswordOnFirstLoginParams,
"options": ResetPasswordOnFirstLoginOptions
}
Response
{
"data": {
"resetPasswordOnFirstLogin": {
"tokens": Tokens,
"challenge": Challenge
}
}
}
restoreGoals
Description
To restore Goals. Access allowed to authenticated user as per business logic.
Response
Returns a RestoreGoalsPayload!
Arguments
| Name | Description |
|---|---|
params - RestoreGoalsParams!
|
|
options - RestoreGoalsOptions
|
Example
Query
mutation restoreGoals(
$params: RestoreGoalsParams!,
$options: RestoreGoalsOptions
) {
restoreGoals(
params: $params,
options: $options
) {
goalsUpdated
goalsNotUpdated
}
}
Variables
{
"params": RestoreGoalsParams,
"options": RestoreGoalsOptions
}
Response
{
"data": {
"restoreGoals": {
"goalsUpdated": ["xyz789"],
"goalsNotUpdated": ["abc123"]
}
}
}
restorePlannedTasks
Description
To restore Planned Tasks. Access allowed to Authenticated User as per business logic.
Response
Returns a RestorePlannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - RestorePlannedTasksParams!
|
|
options - RestorePlannedTasksOptions
|
Example
Query
mutation restorePlannedTasks(
$params: RestorePlannedTasksParams!,
$options: RestorePlannedTasksOptions
) {
restorePlannedTasks(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": RestorePlannedTasksParams,
"options": RestorePlannedTasksOptions
}
Response
{"data": {"restorePlannedTasks": {"recordsUpdated": 987}}}
restoreUnplannedTasks
Description
To restore Unplanned Tasks. Access allowed to Authenticated User as per business logic.
Response
Returns a RestoreUnplannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - RestoreUnplannedTasksParams!
|
|
options - RestoreUnplannedTasksOptions
|
Example
Query
mutation restoreUnplannedTasks(
$params: RestoreUnplannedTasksParams!,
$options: RestoreUnplannedTasksOptions
) {
restoreUnplannedTasks(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": RestoreUnplannedTasksParams,
"options": RestoreUnplannedTasksOptions
}
Response
{"data": {"restoreUnplannedTasks": {"recordsUpdated": 123}}}
setupOrg
Description
To setup a new organisation. Access allowed to WeSoar Super Admin.
Example
Query
mutation setupOrg(
$accessToken: String,
$keyName: String
) {
setupOrg(
accessToken: $accessToken,
keyName: $keyName
)
}
Variables
{
"accessToken": "xyz789",
"keyName": "abc123"
}
Response
{"data": {"setupOrg": true}}
signIn
Description
DEPRECATED To Sing In. Access allowed to WeSoar Super Admin.
Response
Returns a SignInPayload!
Arguments
| Name | Description |
|---|---|
params - SignInParams!
|
|
options - SignInOptions
|
Example
Query
mutation signIn(
$params: SignInParams!,
$options: SignInOptions
) {
signIn(
params: $params,
options: $options
) {
tokens {
...TokensFragment
}
challenge {
...ChallengeFragment
}
}
}
Variables
{
"params": SignInParams,
"options": SignInOptions
}
Response
{
"data": {
"signIn": {
"tokens": Tokens,
"challenge": Challenge
}
}
}
startSurvey
Description
To start Survey Response. Access allowed to Survey Respondent.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
params - StartSurveyParams
|
|
options - StartSurveyOptions
|
Example
Query
mutation startSurvey(
$params: StartSurveyParams,
$options: StartSurveyOptions
) {
startSurvey(
params: $params,
options: $options
)
}
Variables
{
"params": StartSurveyParams,
"options": StartSurveyOptions
}
Response
{"data": {"startSurvey": false}}
subscribeCommunityGoal
Description
To subscribe Community Goal. Access allowed to authenticated user.
Response
Returns a CommunityGoal
Arguments
| Name | Description |
|---|---|
params - SubscribeCommunityGoalParams!
|
|
options - SubscribeCommunityGoalOptions
|
Example
Query
mutation subscribeCommunityGoal(
$params: SubscribeCommunityGoalParams!,
$options: SubscribeCommunityGoalOptions
) {
subscribeCommunityGoal(
params: $params,
options: $options
) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{
"params": SubscribeCommunityGoalParams,
"options": SubscribeCommunityGoalOptions
}
Response
{
"data": {
"subscribeCommunityGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "xyz789",
"trackingStatus": "xyz789",
"achievement": "abc123",
"isCompanyGoal": false,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 123,
"goalProgress": 123.45,
"keyName": "xyz789",
"priority": 123,
"isActive": true,
"isDeleted": true,
"hash": "xyz789",
"isParticipant": false,
"isSubscriber": true,
"isAdmin": false,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
}
}
subscribeCommunityGoals
Description
To subscribe multiple Community Goals. Access allowed to authenticated user.
Response
Returns [CommunityGoal]
Arguments
| Name | Description |
|---|---|
params - SubscribeCommunityGoalsParams!
|
|
options - SubscribeCommunityGoalsOptions
|
Example
Query
mutation subscribeCommunityGoals(
$params: SubscribeCommunityGoalsParams!,
$options: SubscribeCommunityGoalsOptions
) {
subscribeCommunityGoals(
params: $params,
options: $options
) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{
"params": SubscribeCommunityGoalsParams,
"options": SubscribeCommunityGoalsOptions
}
Response
{
"data": {
"subscribeCommunityGoals": [
{
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "abc123",
"trackingStatus": "abc123",
"achievement": "xyz789",
"isCompanyGoal": false,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 123,
"goalProgress": 123.45,
"keyName": "abc123",
"priority": 987,
"isActive": false,
"isDeleted": false,
"hash": "abc123",
"isParticipant": true,
"isSubscriber": true,
"isAdmin": false,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
]
}
}
subscribeNotification
Description
To subscribe for notification. Access allowed user with a valid token.
Example
Query
mutation subscribeNotification($token: String) {
subscribeNotification(token: $token) {
_id
userName
empCode
preferredName
firstName
lastName
email
mobileNumber
isEmailVerified
isMobileNumberVerified
imageUrl
profilePic {
...FileFragment
}
managers {
...ManagerFragment
}
orgUnits
designation
path
aboutMe
myStatus
isReportAppDiagnosticData
isActive
dummy
progress
overallGoalProgress
ytdRating
teamOverallGoalProgress
peersOverallGoalProgress
isManager
managerId
myRoles {
...ManagerTypeFragment
}
cognitoInfo {
...User_CognitoInfoFragment
}
cognitoGroups {
...User_CognitoGroupFragment
}
tokenRoles
tokenAbility {
...AbilityFragment
}
roles {
...RoleFragment
}
ability {
...AbilityFragment
}
rbacRoles
permissions {
...User_PermissionFragment
}
terms {
...TermFragment
}
isMFAEnabled
years {
...YearFragment
}
moduleCategories {
...UserModuelCategoryFragment
}
termPrograms {
...TermProgramFragment
}
termProgramsPage {
...TermProgramsPageFragment
}
termsPage {
...TermsPageFragment
}
termsFacts {
...FactFragment
}
latestSupportTicket {
...SupportTicketFragment
}
peersPage {
...UsersPageFragment
}
myManager {
...UserFragment
}
myEvaluator {
...UserFragment
}
directReportsPage {
...UsersPageFragment
}
directReportsFact {
...FactFragment
}
managersInMyDirectReportsPage {
...UsersPageFragment
}
orgUnit
organizationUnit {
...OrgUnitFragment
}
myCEO {
...UserFragment
}
inDirectReportsPage {
...UsersPageFragment
}
termProgram {
...TermProgramFragment
}
latestTermProgram {
...TermProgramFragment
}
userFilterOptions {
...UserFilterOptionFragment
}
subUsersPage {
...UsersPageFragment
}
myCompanyGoalsPage {
...CommunityGoalsPageFragment
}
myCommunityGoalsPage {
...CommunityGoalsPageFragment
}
approvedGoalsPage {
...GoalsPageFragment
}
completedGoalsPage {
...GoalsPageFragment
}
canceledGoalsPage {
...GoalsPageFragment
}
draftGoalsPage {
...GoalsPageFragment
}
trashedGoalsPage {
...GoalsPageFragment
}
taggedGoalsPage {
...GoalsPageFragment
}
goalCreationStatus
goalCreationStatusFacts {
...FactFragment
}
approvedGoalsFacts {
...FactFragment
}
draftGoalsFacts {
...FactFragment
}
trashedGoalsFacts {
...FactFragment
}
taggedGoalsFacts {
...FactFragment
}
submittedGoalsFacts {
...FactFragment
}
goalsFacts {
...FactFragment
}
plannedTasksPage {
...PlannedTasksPageFragment
}
plannedTasksFacts {
...FactFragment
}
taggedPlannedTasksPage {
...PlannedTasksPageFragment
}
taggedPlannedTasksFacts {
...FactFragment
}
unplannedTasksPage {
...UnplannedTasksPageFragment
}
unplannedTasksFacts {
...FactFragment
}
attendancesPage {
...AttendancesPageFragment
}
attendancesFacts {
...FactFragment
}
notificationsPage {
...NotificationsPageFragment
}
surveyScore
surveySpecimensPage {
...SurveySpecimensPageFragment
}
socketUrl
programsOfDirectReportsPage {
...ProgramsPageFragment
}
surveyReport {
...SurveyReportFragment
}
surveyReportWithPrevSurveyReport {
...SurveyReportFragment
}
}
}
Variables
{"token": "xyz789"}
Response
{
"data": {
"subscribeNotification": {
"_id": "5e5677d71bdc2ae76344968c",
"userName": "abc123",
"empCode": "xyz789",
"preferredName": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"email": "abc123",
"mobileNumber": "xyz789",
"isEmailVerified": false,
"isMobileNumberVerified": false,
"imageUrl": "abc123",
"profilePic": File,
"managers": [Manager],
"orgUnits": [
"5e5677d71bdc2ae76344968c"
],
"designation": "xyz789",
"path": "xyz789",
"aboutMe": "abc123",
"myStatus": "xyz789",
"isReportAppDiagnosticData": false,
"isActive": true,
"dummy": "xyz789",
"progress": 987.65,
"overallGoalProgress": 123.45,
"ytdRating": 987.65,
"teamOverallGoalProgress": 123.45,
"peersOverallGoalProgress": 987.65,
"isManager": true,
"managerId": "abc123",
"myRoles": [ManagerType],
"cognitoInfo": User_CognitoInfo,
"cognitoGroups": [User_CognitoGroup],
"tokenRoles": ["xyz789"],
"tokenAbility": [Ability],
"roles": [Role],
"ability": [Ability],
"rbacRoles": ["xyz789"],
"permissions": [User_Permission],
"terms": [Term],
"isMFAEnabled": true,
"years": [Year],
"moduleCategories": [UserModuelCategory],
"termPrograms": [TermProgram],
"termProgramsPage": TermProgramsPage,
"termsPage": TermsPage,
"termsFacts": [Fact],
"latestSupportTicket": SupportTicket,
"peersPage": UsersPage,
"myManager": User,
"myEvaluator": User,
"directReportsPage": UsersPage,
"directReportsFact": [Fact],
"managersInMyDirectReportsPage": UsersPage,
"orgUnit": "abc123",
"organizationUnit": OrgUnit,
"myCEO": User,
"inDirectReportsPage": UsersPage,
"termProgram": TermProgram,
"latestTermProgram": TermProgram,
"userFilterOptions": [UserFilterOption],
"subUsersPage": UsersPage,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"completedGoalsPage": GoalsPage,
"canceledGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"goalCreationStatus": "xyz789",
"goalCreationStatusFacts": [Fact],
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"notificationsPage": NotificationsPage,
"surveyScore": "xyz789",
"surveySpecimensPage": SurveySpecimensPage,
"socketUrl": "xyz789",
"programsOfDirectReportsPage": ProgramsPage,
"surveyReport": SurveyReport,
"surveyReportWithPrevSurveyReport": SurveyReport
}
}
}
trashGoals
Description
To delete Goals. Access allowed to authenticated user as per business logic.
Response
Returns a TrashGoalsPayload!
Arguments
| Name | Description |
|---|---|
params - TrashGoalsParams!
|
|
options - TrashGoalsOptions
|
Example
Query
mutation trashGoals(
$params: TrashGoalsParams!,
$options: TrashGoalsOptions
) {
trashGoals(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": TrashGoalsParams,
"options": TrashGoalsOptions
}
Response
{"data": {"trashGoals": {"recordsUpdated": 987}}}
trashPlannedTasks
Description
To trash Planned Tasks. Access allowed to Authenticated User as per business logic.
Response
Returns a TrashPlannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - TrashPlannedTasksParams!
|
|
options - TrashPlannedTasksOptions
|
Example
Query
mutation trashPlannedTasks(
$params: TrashPlannedTasksParams!,
$options: TrashPlannedTasksOptions
) {
trashPlannedTasks(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": TrashPlannedTasksParams,
"options": TrashPlannedTasksOptions
}
Response
{"data": {"trashPlannedTasks": {"recordsUpdated": 123}}}
trashUnplannedTasks
Description
To update Unplanned Tasks. Access allowed to Authenticated User as per business logic.
Response
Returns a TrashUnplannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - TrashUnplannedTasksParams!
|
|
options - TrashUnplannedTasksOptions
|
Example
Query
mutation trashUnplannedTasks(
$params: TrashUnplannedTasksParams!,
$options: TrashUnplannedTasksOptions
) {
trashUnplannedTasks(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": TrashUnplannedTasksParams,
"options": TrashUnplannedTasksOptions
}
Response
{"data": {"trashUnplannedTasks": {"recordsUpdated": 123}}}
unfollowGoals
Description
To unfollow Goals. Access allowed to authenticated user as per business logic.
Response
Returns an UnfollowGoalsPayload!
Arguments
| Name | Description |
|---|---|
params - UnfollowGoalsParams!
|
|
options - UnfollowGoalsOptions
|
Example
Query
mutation unfollowGoals(
$params: UnfollowGoalsParams!,
$options: UnfollowGoalsOptions
) {
unfollowGoals(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": UnfollowGoalsParams,
"options": UnfollowGoalsOptions
}
Response
{"data": {"unfollowGoals": {"recordsUpdated": 987}}}
unfollowPlannedTasks
Description
To unfollow Planned Task. Access allowed to Authenticated User as per business logic.
Response
Returns an UnfollowPlannedTasksPayload!
Arguments
| Name | Description |
|---|---|
params - UnfollowPlannedTasksParams!
|
|
options - UnfollowPlannedTasksOptions
|
Example
Query
mutation unfollowPlannedTasks(
$params: UnfollowPlannedTasksParams!,
$options: UnfollowPlannedTasksOptions
) {
unfollowPlannedTasks(
params: $params,
options: $options
) {
recordsUpdated
}
}
Variables
{
"params": UnfollowPlannedTasksParams,
"options": UnfollowPlannedTasksOptions
}
Response
{"data": {"unfollowPlannedTasks": {"recordsUpdated": 123}}}
unsubscribeCommunityGoal
Description
To unsubscribe Community Goal. Access allowed to authenticated user.
Response
Returns a CommunityGoal
Arguments
| Name | Description |
|---|---|
params - UnsubscribeCommunityGoalParams!
|
|
options - UnsubscribeCommunityGoalOptions
|
Example
Query
mutation unsubscribeCommunityGoal(
$params: UnsubscribeCommunityGoalParams!,
$options: UnsubscribeCommunityGoalOptions
) {
unsubscribeCommunityGoal(
params: $params,
options: $options
) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{
"params": UnsubscribeCommunityGoalParams,
"options": UnsubscribeCommunityGoalOptions
}
Response
{
"data": {
"unsubscribeCommunityGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "abc123",
"trackingStatus": "abc123",
"achievement": "abc123",
"isCompanyGoal": false,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 987,
"goalProgress": 987.65,
"keyName": "abc123",
"priority": 123,
"isActive": false,
"isDeleted": false,
"hash": "xyz789",
"isParticipant": true,
"isSubscriber": true,
"isAdmin": true,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
}
}
unsubscribeCommunityGoals
Description
To unsubscribe multiple Community Goals. Access allowed to authenticated user.
Response
Returns [CommunityGoal]
Arguments
| Name | Description |
|---|---|
params - UnsubscribeCommunityGoalsParams!
|
|
options - UnsubscribeCommunityGoalsOptions
|
Example
Query
mutation unsubscribeCommunityGoals(
$params: UnsubscribeCommunityGoalsParams!,
$options: UnsubscribeCommunityGoalsOptions
) {
unsubscribeCommunityGoals(
params: $params,
options: $options
) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{
"params": UnsubscribeCommunityGoalsParams,
"options": UnsubscribeCommunityGoalsOptions
}
Response
{
"data": {
"unsubscribeCommunityGoals": [
{
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "abc123",
"trackingStatus": "abc123",
"achievement": "abc123",
"isCompanyGoal": true,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 987,
"goalProgress": 987.65,
"keyName": "xyz789",
"priority": 987,
"isActive": true,
"isDeleted": true,
"hash": "abc123",
"isParticipant": true,
"isSubscriber": true,
"isAdmin": true,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
]
}
}
updateAlarm
Description
To update Alarm. Access allowed to WeSoar Super Admin.
Response
Returns an Alarm
Arguments
| Name | Description |
|---|---|
params - UpdateAlarmParams!
|
|
options - UpdateAlarmOptions
|
Example
Query
mutation updateAlarm(
$params: UpdateAlarmParams!,
$options: UpdateAlarmOptions
) {
updateAlarm(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": UpdateAlarmParams,
"options": UpdateAlarmOptions
}
Response
{
"data": {
"updateAlarm": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 123,
"isActive": false
}
}
}
updateAppraisal
Description
To update an appraisal. Access allowed to WeSoar Super Admin.
Response
Returns an Appraisal
Arguments
| Name | Description |
|---|---|
params - UpdateAppraisalParams!
|
|
options - UpdateAppraisalOptions
|
Example
Query
mutation updateAppraisal(
$params: UpdateAppraisalParams!,
$options: UpdateAppraisalOptions
) {
updateAppraisal(
params: $params,
options: $options
) {
_id
termProgramId
appraisalRating {
...AppraisalRatingFragment
}
appraisalDate
name
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
appraisalGoalsPage {
...GoalsPageFragment
}
priority
appraisalStatus
appraisalCalculation
isDeleted
}
}
Variables
{
"params": UpdateAppraisalParams,
"options": UpdateAppraisalOptions
}
Response
{
"data": {
"updateAppraisal": {
"_id": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"appraisalRating": AppraisalRating,
"appraisalDate": 1592577642,
"name": "abc123",
"commentsPage": CommentsPage,
"comment": Comment,
"appraisalGoalsPage": GoalsPage,
"priority": 987,
"appraisalStatus": "xyz789",
"appraisalCalculation": "abc123",
"isDeleted": false
}
}
}
updateAttendance
Description
DEPRECATED To create an attendance. Access allowed to WeSoar Super Admin.
Response
Returns an Attendance!
Arguments
| Name | Description |
|---|---|
params - UpdateAttendanceParams!
|
|
options - UpdateAttendanceOptions
|
Example
Query
mutation updateAttendance(
$params: UpdateAttendanceParams!,
$options: UpdateAttendanceOptions
) {
updateAttendance(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
userId
attendanceLogs {
...AttendanceLogFragment
}
isActive
isDeleted
attendanceLogsPage {
...AttendanceLogsPageFragment
}
attendanceLogForDate {
...AttendanceLogFragment
}
}
}
Variables
{
"params": UpdateAttendanceParams,
"options": UpdateAttendanceOptions
}
Response
{
"data": {
"updateAttendance": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": true,
"isDeleted": false,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
}
}
updateAttendanceLog
Description
DEPRECATED To update an attendance entry. Access allowed to WeSoar Super Admin.
Response
Returns an Attendance
Arguments
| Name | Description |
|---|---|
params - UpdateAttendanceLogParams!
|
|
options - UpdateAttendanceLogOptions
|
Example
Query
mutation updateAttendanceLog(
$params: UpdateAttendanceLogParams!,
$options: UpdateAttendanceLogOptions
) {
updateAttendanceLog(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
userId
attendanceLogs {
...AttendanceLogFragment
}
isActive
isDeleted
attendanceLogsPage {
...AttendanceLogsPageFragment
}
attendanceLogForDate {
...AttendanceLogFragment
}
}
}
Variables
{
"params": UpdateAttendanceLogParams,
"options": UpdateAttendanceLogOptions
}
Response
{
"data": {
"updateAttendanceLog": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": true,
"isDeleted": true,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
}
}
updateAttendanceLogs
Description
DEPRECATED To update attendance entries. Access allowed to WeSoar Super Admin.
Response
Returns an UpdateAttendanceLogsPayload
Arguments
| Name | Description |
|---|---|
params - [UpdateAttendanceLogParams!]
|
|
options - UpdateAttendanceLogOptions
|
Example
Query
mutation updateAttendanceLogs(
$params: [UpdateAttendanceLogParams!],
$options: UpdateAttendanceLogOptions
) {
updateAttendanceLogs(
params: $params,
options: $options
) {
attendancesUpdated
attendancesNotUpdated
}
}
Variables
{
"params": [UpdateAttendanceLogParams],
"options": UpdateAttendanceLogOptions
}
Response
{
"data": {
"updateAttendanceLogs": {
"attendancesUpdated": [
"5e5677d71bdc2ae76344968c"
],
"attendancesNotUpdated": [
"5e5677d71bdc2ae76344968c"
]
}
}
}
updateCheckIn
Description
To update a CheckIn. Access allowed to authenticated user who is part of CheckIn Workflow as per business logic.
Response
Returns a CheckIn
Arguments
| Name | Description |
|---|---|
params - UpdateCheckInParams!
|
|
options - UpdateCheckInOptions
|
Example
Query
mutation updateCheckIn(
$params: UpdateCheckInParams!,
$options: UpdateCheckInOptions
) {
updateCheckIn(
params: $params,
options: $options
) {
_id
name
checkInType
termProgramId
userId
programId
checkInSetting {
...CheckInSettingFragment
}
checkInDate
checkInRatings {
...CheckInRatingFragment
}
priority
checkInStatus
user {
...UserFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
competencies {
...SurveyQuestionFragment
}
competenciesFPage {
...SurveyQuestionFragment
}
competenciesPage {
...SurveyQuestionsPageFragment
}
isDeleted
latestRating {
...CheckInRatingFragment
}
checkInRatingsPage {
...CheckInRatingsPageFragment
}
checkInRatingsFPage {
...CheckInRatingFragment
}
checkInRatingsFOne {
...CheckInRatingFragment
}
commentTrailId
isActiveForEmp
isActiveForManager
}
}
Variables
{
"params": UpdateCheckInParams,
"options": UpdateCheckInOptions
}
Response
{
"data": {
"updateCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"checkInType": "xyz789",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 123,
"checkInStatus": "xyz789",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": false,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": true,
"isActiveForManager": false
}
}
}
updateComment
Description
To update a comment. Access allowed to authenticated user.
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
params - UpdateCommentParams!
|
|
rootOptions - RootOptions
|
Example
Query
mutation updateComment(
$params: UpdateCommentParams!,
$rootOptions: RootOptions
) {
updateComment(
params: $params,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"params": UpdateCommentParams,
"rootOptions": RootOptions
}
Response
{
"data": {
"updateComment": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "xyz789",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": true,
"isDeleted": true,
"commentDate": 1592577642,
"type": "xyz789",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
updateCommentReaction
Description
To update a comment reaction. Access allowed to authenticated user.
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
params - UpdateCommentReactionParams!
|
|
rootOptions - RootOptions
|
Example
Query
mutation updateCommentReaction(
$params: UpdateCommentReactionParams!,
$rootOptions: RootOptions
) {
updateCommentReaction(
params: $params,
rootOptions: $rootOptions
) {
_id
parentCommentId
fbMessageId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
userId
mentions {
...MentionFragment
}
isEdited
isDeleted
commentDate
type
updatedDate
deletedDate
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
parentComment {
...CommentFragment
}
reactionsFacts {
...FactFragment
}
commentsFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
commentsPage {
...CommentsPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{
"params": UpdateCommentReactionParams,
"rootOptions": RootOptions
}
Response
{
"data": {
"updateCommentReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": true,
"isDeleted": false,
"commentDate": 1592577642,
"type": "abc123",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
updateCommunicationEvent
Description
To update Communication Event. Access allowed to WeSoar Super Admin.
Response
Returns a CommunicationEvent
Arguments
| Name | Description |
|---|---|
params - UpdateCommunicationEventParams!
|
|
options - UpdateCommunicationEventOptions
|
Example
Query
mutation updateCommunicationEvent(
$params: UpdateCommunicationEventParams!,
$options: UpdateCommunicationEventOptions
) {
updateCommunicationEvent(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": UpdateCommunicationEventParams,
"options": UpdateCommunicationEventOptions
}
Response
{
"data": {
"updateCommunicationEvent": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 123,
"isActive": false
}
}
}
updateCommunityGoal
Description
To update Community Goal. Access allowed to WeSoar Super Admin.
Response
Returns a CommunityGoal
Arguments
| Name | Description |
|---|---|
params - UpdateCommunityGoalParams!
|
|
options - UpdateCommunityGoalOptions
|
Example
Query
mutation updateCommunityGoal(
$params: UpdateCommunityGoalParams!,
$options: UpdateCommunityGoalOptions
) {
updateCommunityGoal(
params: $params,
options: $options
) {
_id
adminUserId
adminUser {
...UserFragment
}
yearId
year {
...YearFragment
}
programId
program {
...ProgramFragment
}
goalType
trackingStatus
achievement
isCompanyGoal
goalDetail {
...GoalDetailFragment
}
participations {
...ParticipationFragment
}
participationsPage {
...ParticipationsPageFragment
}
participationsFacts {
...FactFragment
}
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...SubscriptionsPageFragment
}
subscriptionsFacts {
...FactFragment
}
subscribers {
...UserFragment
}
subscribersPage {
...UsersPageFragment
}
comments {
...CommentFragment
}
progress
goalProgress
keyName
priority
isActive
isDeleted
hash
isParticipant
isSubscriber
isAdmin
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
}
}
Variables
{
"params": UpdateCommunityGoalParams,
"options": UpdateCommunityGoalOptions
}
Response
{
"data": {
"updateCommunityGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "xyz789",
"trackingStatus": "xyz789",
"achievement": "xyz789",
"isCompanyGoal": false,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 123,
"goalProgress": 123.45,
"keyName": "xyz789",
"priority": 987,
"isActive": false,
"isDeleted": false,
"hash": "xyz789",
"isParticipant": false,
"isSubscriber": false,
"isAdmin": false,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
}
}
updateConversation
Description
To update Conversation. Access allowed to Authenticated User.
Response
Returns a Conversation
Arguments
| Name | Description |
|---|---|
params - UpdateConversationParams!
|
|
options - UpdateConversationOptions
|
Example
Query
mutation updateConversation(
$params: UpdateConversationParams!,
$options: UpdateConversationOptions
) {
updateConversation(
params: $params,
options: $options
) {
_id
name
description
icon {
...FileFragment
}
rootId
rootType
fldName
subscriptions {
...ParticipationFragment
}
subscriptionsPage {
...ParticipationsPageFragment
}
subscriptionsFacts {
...FactFragment
}
metas {
...MetaFragment
}
metasPage {
...MetasPageFragment
}
metasFacts {
...FactFragment
}
comments {
...CommentFragment
}
messages {
...MessageFragment
}
priority
isActive
isDeleted
lastMessageDate
lastMessage {
...MessageFragment
}
createdDate
updatedDate
trashedDate
deletedDate
commentsPage {
...CommentsPageFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FilesPageFragment
}
comment {
...CommentFragment
}
subscribersPage {
...UsersPageFragment
}
unseenCount
}
}
Variables
{
"params": UpdateConversationParams,
"options": UpdateConversationOptions
}
Response
{
"data": {
"updateConversation": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"description": "abc123",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "xyz789",
"fldName": "xyz789",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 987,
"isActive": false,
"isDeleted": true,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 987
}
}
}
updateGoal
Description
To update Goal. Access allowed to authenticated user as per business logic.
Response
Returns a Goal!
Arguments
| Name | Description |
|---|---|
params - UpdateGoalParams!
|
|
options - UpdateGoalOptions
|
Example
Query
mutation updateGoal(
$params: UpdateGoalParams!,
$options: UpdateGoalOptions
) {
updateGoal(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": UpdateGoalParams,
"options": UpdateGoalOptions
}
Response
{
"data": {
"updateGoal": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "xyz789",
"goalType": "abc123",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 987,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "xyz789",
"achievement": "abc123",
"goalProgress": 123,
"priority": 987,
"isActive": true,
"isShowInPlannedTask": true,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
updateGoalAppraisal
Description
DEPRECATED To update Goal Appraisal. Access allowed to WeSoar Super Admin.
Response
Returns a Goal
Arguments
| Name | Description |
|---|---|
params - UpdateGoalAppraisalParams!
|
|
options - UpdateGoalAppraisalOptions
|
Example
Query
mutation updateGoalAppraisal(
$params: UpdateGoalAppraisalParams!,
$options: UpdateGoalAppraisalOptions
) {
updateGoalAppraisal(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": UpdateGoalAppraisalParams,
"options": UpdateGoalAppraisalOptions
}
Response
{
"data": {
"updateGoalAppraisal": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "abc123",
"goalType": "xyz789",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "xyz789",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 987,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "xyz789",
"achievement": "xyz789",
"goalProgress": 123,
"priority": 123,
"isActive": true,
"isShowInPlannedTask": false,
"isShowInUnplannedTask": true,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
updateGoalAppraisals
Description
DEPRECATED To update Goal Appraisals. Access allowed to WeSoar Super Admin.
Response
Returns an UpdateGoalAppraisalsPayload
Arguments
| Name | Description |
|---|---|
params - [UpdateGoalAppraisalParams!]
|
|
options - UpdateGoalAppraisalOptions
|
Example
Query
mutation updateGoalAppraisals(
$params: [UpdateGoalAppraisalParams!],
$options: UpdateGoalAppraisalOptions
) {
updateGoalAppraisals(
params: $params,
options: $options
) {
goalsUpdated
goalsNotUpdated
}
}
Variables
{
"params": [UpdateGoalAppraisalParams],
"options": UpdateGoalAppraisalOptions
}
Response
{
"data": {
"updateGoalAppraisals": {
"goalsUpdated": [
"5e5677d71bdc2ae76344968c"
],
"goalsNotUpdated": [
"5e5677d71bdc2ae76344968c"
]
}
}
}
updateGoalCheckIn
Description
DEPRECATED To update Goal CheckIn. Access allowed to WeSoar Super Admin.
Response
Returns a Goal
Arguments
| Name | Description |
|---|---|
params - UpdateGoalCheckInParams!
|
|
options - UpdateGoalCheckInOptions
|
Example
Query
mutation updateGoalCheckIn(
$params: UpdateGoalCheckInParams!,
$options: UpdateGoalCheckInOptions
) {
updateGoalCheckIn(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
assignedToUserId
assignedByUserId
approvedByUserId
trashedByUserId
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
hash
goalType
parentGoalId
conversationId
goalDetail {
...GoalDetailFragment
}
comments {
...CommentFragment
}
obstacles {
...CommentFragment
}
checkInComments {
...CommentFragment
}
appraisalComments {
...CommentFragment
}
views
communityGoalId
trackingStatus
achievement
goalProgress
priority
isActive
isShowInPlannedTask
isShowInUnplannedTask
year {
...YearFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
communityGoal {
...CommunityGoalFragment
}
parentGoal {
...GoalFragment
}
latestCompletedCheckIn {
...CheckInFragment
}
latestCompletedGoalCheckIn {
...GoalCheckInFragment
}
goalCheckIns {
...GoalCheckInFragment
}
goalAppraisals {
...GoalAppraisalFragment
}
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
obstaclesPage {
...CommentsPageFragment
}
obstacle {
...CommentFragment
}
checkInCommentsPage {
...CommentsPageFragment
}
checkInComment {
...CommentFragment
}
appraisalCommentsPage {
...CommentsPageFragment
}
appraisalComment {
...CommentFragment
}
goalCheckInsPage {
...GoalCheckInsPageFragment
}
goalCheckIn {
...GoalCheckInFragment
}
goalAppraisalsPage {
...GoalAppraisalsPageFragment
}
goalAppraisal {
...GoalAppraisalFragment
}
}
}
Variables
{
"params": UpdateGoalCheckInParams,
"options": UpdateGoalCheckInOptions
}
Response
{
"data": {
"updateGoalCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "abc123",
"goalType": "xyz789",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 123,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "abc123",
"achievement": "abc123",
"goalProgress": 123,
"priority": 123,
"isActive": false,
"isShowInPlannedTask": false,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
}
}
updateGoalCheckIns
Description
DEPRECATED To update Goal CheckIns. Access allowed to WeSoar Super Admin.
Response
Returns an UpdateGoalCheckInsPayload
Arguments
| Name | Description |
|---|---|
params - [UpdateGoalCheckInParams!]
|
|
options - UpdateGoalCheckInOptions
|
Example
Query
mutation updateGoalCheckIns(
$params: [UpdateGoalCheckInParams!],
$options: UpdateGoalCheckInOptions
) {
updateGoalCheckIns(
params: $params,
options: $options
) {
goalsUpdated
goalsNotUpdated
}
}
Variables
{
"params": [UpdateGoalCheckInParams],
"options": UpdateGoalCheckInOptions
}
Response
{
"data": {
"updateGoalCheckIns": {
"goalsUpdated": [
"5e5677d71bdc2ae76344968c"
],
"goalsNotUpdated": [
"5e5677d71bdc2ae76344968c"
]
}
}
}
updateGoals
Description
To update Goals. Access allowed to authenticated user as per business logic.
Response
Returns an UpdateGoalsWeightagesPayload!
Arguments
| Name | Description |
|---|---|
params - [UpdateGoalParams]!
|
|
options - UpdateGoalOptions
|
Example
Query
mutation updateGoals(
$params: [UpdateGoalParams]!,
$options: UpdateGoalOptions
) {
updateGoals(
params: $params,
options: $options
) {
goalsUpdated {
...GoalFragment
}
goalsNotUpdated
}
}
Variables
{
"params": [UpdateGoalParams],
"options": UpdateGoalOptions
}
Response
{
"data": {
"updateGoals": {
"goalsUpdated": [Goal],
"goalsNotUpdated": ["abc123"]
}
}
}
updateGoalsWeightages
Description
To update Goals Weightages. Access allowed to authenticated user as per business logic.
Response
Returns an UpdateGoalsWeightagesPayload!
Arguments
| Name | Description |
|---|---|
params - [UpdateGoalWeightageParams]!
|
|
options - UpdateGoalOptions
|
Example
Query
mutation updateGoalsWeightages(
$params: [UpdateGoalWeightageParams]!,
$options: UpdateGoalOptions
) {
updateGoalsWeightages(
params: $params,
options: $options
) {
goalsUpdated {
...GoalFragment
}
goalsNotUpdated
}
}
Variables
{
"params": [UpdateGoalWeightageParams],
"options": UpdateGoalOptions
}
Response
{
"data": {
"updateGoalsWeightages": {
"goalsUpdated": [Goal],
"goalsNotUpdated": ["abc123"]
}
}
}
updateLanguage
Description
To update Language. Access allowed to WeSoar Super Admin.
Response
Returns a Language
Arguments
| Name | Description |
|---|---|
params - UpdateLanguageParams!
|
|
options - UpdateLanguageOptions
|
Example
Query
mutation updateLanguage(
$params: UpdateLanguageParams!,
$options: UpdateLanguageOptions
) {
updateLanguage(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
isRTL
}
}
Variables
{
"params": UpdateLanguageParams,
"options": UpdateLanguageOptions
}
Response
{
"data": {
"updateLanguage": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 123,
"isActive": true,
"isRTL": true
}
}
}
updateMaster
Description
To update Master. Access allowed to WeSoar Super Admin.
Response
Returns a Master!
Arguments
| Name | Description |
|---|---|
params - UpdateMasterParams!
|
|
options - UpdateMasterOptions
|
|
modelName - String
|
Example
Query
mutation updateMaster(
$params: UpdateMasterParams!,
$options: UpdateMasterOptions,
$modelName: String
) {
updateMaster(
params: $params,
options: $options,
modelName: $modelName
) {
_id
name
keyName
priority
isActive
isDeleted
}
}
Variables
{
"params": UpdateMasterParams,
"options": UpdateMasterOptions,
"modelName": "xyz789"
}
Response
{
"data": {
"updateMaster": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 987,
"isActive": true,
"isDeleted": false
}
}
}
updateMessage
Response
Returns a Message
Arguments
| Name | Description |
|---|---|
params - UpdateMessageParams!
|
Example
Query
mutation updateMessage($params: UpdateMessageParams!) {
updateMessage(params: $params) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"params": UpdateMessageParams}
Response
{
"data": {
"updateMessage": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "abc123",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": true,
"isDeleted": true,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
updateMessageReaction
Response
Returns a Message
Arguments
| Name | Description |
|---|---|
params - UpdateMessageReactionParams!
|
Example
Query
mutation updateMessageReaction($params: UpdateMessageReactionParams!) {
updateMessageReaction(params: $params) {
_id
conversationId
type
parentId
text
files {
...FileFragment
}
reactions {
...ReactionFragment
}
shares {
...ShareFragment
}
mentions {
...MentionFragment
}
userId
isEdited
isDeleted
postedDate
messageStatus {
...MessageStatusFragment
}
updatedDate
deletedDate
conversation {
...ConversationFragment
}
parent {
...MessageFragment
}
user {
...UserFragment
}
myReaction {
...ReactionFragment
}
reactionsFacts {
...FactFragment
}
messagesFacts {
...FactFragment
}
filesFacts {
...FactFragment
}
messagesPage {
...MessagesPageFragment
}
filesPage {
...FileFragment
}
reactionsPage {
...ReactionsPageFragment
}
sharesPage {
...SharesPageFragment
}
}
}
Variables
{"params": UpdateMessageReactionParams}
Response
{
"data": {
"updateMessageReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "abc123",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "xyz789",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": false,
"isDeleted": false,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
}
}
updateModule
Description
To update Module. Access allowed to WeSoar Super Admin.
Response
Returns a Module
Arguments
| Name | Description |
|---|---|
params - UpdateModuleParams!
|
|
options - UpdateModuleOptions
|
Example
Query
mutation updateModule(
$params: UpdateModuleParams!,
$options: UpdateModuleOptions
) {
updateModule(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": UpdateModuleParams,
"options": UpdateModuleOptions
}
Response
{
"data": {
"updateModule": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 987,
"isActive": false
}
}
}
updateModuleCategory
Description
To update Module Category. Access allowed to WeSoar Super Admin.
Response
Returns a ModuleCategory
Arguments
| Name | Description |
|---|---|
params - UpdateModuleCategoryParams!
|
|
options - UpdateModuleCategoryOptions
|
Example
Query
mutation updateModuleCategory(
$params: UpdateModuleCategoryParams!,
$options: UpdateModuleCategoryOptions
) {
updateModuleCategory(
params: $params,
options: $options
) {
_id
name
keyName
modules {
...ModuleFragment
}
priority
isActive
}
}
Variables
{
"params": UpdateModuleCategoryParams,
"options": UpdateModuleCategoryOptions
}
Response
{
"data": {
"updateModuleCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"modules": [Module],
"priority": 987,
"isActive": true
}
}
}
updateNotification
Description
DEPRECATED To update Notification. Access allowed to WeSoar Super Admin.
Response
Returns a Notification!
Arguments
| Name | Description |
|---|---|
params - UpdateNotificationParams!
|
|
options - UpdateNotificationOptions
|
Example
Query
mutation updateNotification(
$params: UpdateNotificationParams!,
$options: UpdateNotificationOptions
) {
updateNotification(
params: $params,
options: $options
) {
_id
userId
termProgramId
notificationDate
messageData
payload
isOpened
messageText
messageTitle
messageUri
isActive
isDeleted
}
}
Variables
{
"params": UpdateNotificationParams,
"options": UpdateNotificationOptions
}
Response
{
"data": {
"updateNotification": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"notificationDate": 1592577642,
"messageData": {},
"payload": {},
"isOpened": true,
"messageText": "abc123",
"messageTitle": "abc123",
"messageUri": "xyz789",
"isActive": true,
"isDeleted": false
}
}
}
updateOrgUnit
Description
To update Organisation Unit. Access allowed to WeSoar Super Admin.
Response
Returns an OrgUnit
Arguments
| Name | Description |
|---|---|
params - UpdateOrgUnitParams!
|
|
options - UpdateOrgUnitOptions
|
Example
Query
mutation updateOrgUnit(
$params: UpdateOrgUnitParams!,
$options: UpdateOrgUnitOptions
) {
updateOrgUnit(
params: $params,
options: $options
) {
_id
name
pid
keyName
priority
isActive
myRootOrg {
...OrgUnitFragment
}
childUnitsPage {
...OrgUnitsPageFragment
}
surveyReportWithPrevSurveyReport {
...SurveyReportFragment
}
}
}
Variables
{
"params": UpdateOrgUnitParams,
"options": UpdateOrgUnitOptions
}
Response
{
"data": {
"updateOrgUnit": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"pid": "5e5677d71bdc2ae76344968c",
"keyName": "abc123",
"priority": 123,
"isActive": true,
"myRootOrg": OrgUnit,
"childUnitsPage": OrgUnitsPage,
"surveyReportWithPrevSurveyReport": SurveyReport
}
}
}
updatePlannedTask
Description
To update Planned Task. Access allowed to Authenticated User as per business logic.
Response
Returns a PlannedTask!
Arguments
| Name | Description |
|---|---|
params - UpdatePlannedTaskParams!
|
|
options - UpdatePlannedTaskOptions
|
Example
Query
mutation updatePlannedTask(
$params: UpdatePlannedTaskParams!,
$options: UpdatePlannedTaskOptions
) {
updatePlannedTask(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{
"params": UpdatePlannedTaskParams,
"options": UpdatePlannedTaskOptions
}
Response
{
"data": {
"updatePlannedTask": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "abc123",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "xyz789",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "abc123",
"priority": 987,
"isActive": false,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 123
}
}
}
updatePlannedTaskFollowUp
Description
To update Planned Task follow up. Access allowed to Authenticated User as per business logic.
Response
Returns a PlannedTask
Arguments
| Name | Description |
|---|---|
params - UpdatePlannedTaskFollowUpParams!
|
|
options - UpdatePlannedTaskFollowUpOptions
|
Example
Query
mutation updatePlannedTaskFollowUp(
$params: UpdatePlannedTaskFollowUpParams!,
$options: UpdatePlannedTaskFollowUpOptions
) {
updatePlannedTaskFollowUp(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
plannedTaskType
plannedTaskDetail {
...PlannedTaskDetailFragment
}
followUps {
...FollowUpFragment
}
comments {
...CommentFragment
}
eisenhowerQuadrant
managerFeedback {
...ManagerFeedbackFragment
}
kanbanStageId
kanbanStage {
...KanbanStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
views
}
}
Variables
{
"params": UpdatePlannedTaskFollowUpParams,
"options": UpdatePlannedTaskFollowUpOptions
}
Response
{
"data": {
"updatePlannedTaskFollowUp": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "xyz789",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "xyz789",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "abc123",
"priority": 123,
"isActive": false,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 987
}
}
}
updatePlannedTasksEisenhowerQuadrants
Description
To update Planned Task Eisenhower Quadrants. Access allowed to Authenticated User as per business logic.
Response
Returns an UpdatePlannedTaskEisenhowerQuadrantsPayload!
Arguments
| Name | Description |
|---|---|
params - [UpdatePlannedTaskEisenhowerQuadrantParams!]
|
Example
Query
mutation updatePlannedTasksEisenhowerQuadrants($params: [UpdatePlannedTaskEisenhowerQuadrantParams!]) {
updatePlannedTasksEisenhowerQuadrants(params: $params) {
plannedTasksUpdated {
...PlannedTaskFragment
}
plannedTasksNotUpdated
}
}
Variables
{"params": [UpdatePlannedTaskEisenhowerQuadrantParams]}
Response
{
"data": {
"updatePlannedTasksEisenhowerQuadrants": {
"plannedTasksUpdated": [PlannedTask],
"plannedTasksNotUpdated": ["xyz789"]
}
}
}
updateProfile
Description
To update profile. Access allowed to Authenticated User.
Response
Returns an UpdateProfilePayload
Arguments
| Name | Description |
|---|---|
params - UpdateProfileParams!
|
|
options - UpdateProfileOptions
|
Example
Query
mutation updateProfile(
$params: UpdateProfileParams!,
$options: UpdateProfileOptions
) {
updateProfile(
params: $params,
options: $options
) {
user {
...UserFragment
}
codeDeliveryDetailsList {
...CodeDeliveryDetailsFragment
}
}
}
Variables
{
"params": UpdateProfileParams,
"options": UpdateProfileOptions
}
Response
{
"data": {
"updateProfile": {
"user": User,
"codeDeliveryDetailsList": [CodeDeliveryDetails]
}
}
}
updateProgram
Description
To update Program. Access allowed to WeSoar Super Admin.
Response
Returns a Program
Arguments
| Name | Description |
|---|---|
params - UpdateProgramParams!
|
|
options - UpdateProgramOptions
|
Example
Query
mutation updateProgram(
$params: UpdateProgramParams!,
$options: UpdateProgramOptions
) {
updateProgram(
params: $params,
options: $options
) {
_id
yearId
programCategoryId
name
keyName
moduleKeyName
moduleCategoryKeyName
startDate
endDate
goalSetting {
...GoalSettingFragment
}
plannedTaskSetting {
...PlannedTaskSettingFragment
}
unplannedTaskSetting {
...UnplannedTaskSettingFragment
}
surveySetting {
...SurveySettingFragment
}
userFilterRules
status
programLabels
priority
isActive
isDeleted
year {
...YearFragment
}
programCategory {
...ProgramCategoryFragment
}
kanbanStage {
...KanbanStageFragment
}
impactStage {
...ImpactStageFragment
}
timelineStage {
...TimelineStageFragment
}
unplannedImpactStage {
...ImpactStageFragment
}
previousProgram {
...ProgramFragment
}
surveyReportsPage {
...SurveyReportsPageFragment
}
surveyReportsCount
surveyReport {
...SurveyReportFragment
}
filterOptions {
...FilterOptionFragment
}
}
}
Variables
{
"params": UpdateProgramParams,
"options": UpdateProgramOptions
}
Response
{
"data": {
"updateProgram": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programCategoryId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"moduleKeyName": "abc123",
"moduleCategoryKeyName": "abc123",
"startDate": 1592577642,
"endDate": 1592577642,
"goalSetting": GoalSetting,
"plannedTaskSetting": PlannedTaskSetting,
"unplannedTaskSetting": UnplannedTaskSetting,
"surveySetting": SurveySetting,
"userFilterRules": [{}],
"status": "abc123",
"programLabels": ["xyz789"],
"priority": 987,
"isActive": true,
"isDeleted": false,
"year": Year,
"programCategory": ProgramCategory,
"kanbanStage": KanbanStage,
"impactStage": ImpactStage,
"timelineStage": TimelineStage,
"unplannedImpactStage": ImpactStage,
"previousProgram": Program,
"surveyReportsPage": SurveyReportsPage,
"surveyReportsCount": 123,
"surveyReport": SurveyReport,
"filterOptions": [FilterOption]
}
}
}
updateProgramType
Description
To update Program Type. Access allowed to WeSoar Super Admin.
Response
Returns a ProgramType
Arguments
| Name | Description |
|---|---|
params - UpdateProgramTypeParams!
|
|
options - UpdateProgramTypeOptions
|
Example
Query
mutation updateProgramType(
$params: UpdateProgramTypeParams!,
$options: UpdateProgramTypeOptions
) {
updateProgramType(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
}
}
Variables
{
"params": UpdateProgramTypeParams,
"options": UpdateProgramTypeOptions
}
Response
{
"data": {
"updateProgramType": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"priority": 123,
"isActive": false
}
}
}
updateRatingResponseForCheckIn
Description
To update rating responses for CheckIn. Access allowed to WeSoar Super Admin.
Response
Returns a CheckIn
Example
Query
mutation updateRatingResponseForCheckIn(
$checkInId: ObjectID,
$ratingResponse: String,
$managerTypeId: ObjectID,
$userManagerId: ObjectID
) {
updateRatingResponseForCheckIn(
checkInId: $checkInId,
ratingResponse: $ratingResponse,
managerTypeId: $managerTypeId,
userManagerId: $userManagerId
) {
_id
name
checkInType
termProgramId
userId
programId
checkInSetting {
...CheckInSettingFragment
}
checkInDate
checkInRatings {
...CheckInRatingFragment
}
priority
checkInStatus
user {
...UserFragment
}
program {
...ProgramFragment
}
termProgram {
...TermProgramFragment
}
competencies {
...SurveyQuestionFragment
}
competenciesFPage {
...SurveyQuestionFragment
}
competenciesPage {
...SurveyQuestionsPageFragment
}
isDeleted
latestRating {
...CheckInRatingFragment
}
checkInRatingsPage {
...CheckInRatingsPageFragment
}
checkInRatingsFPage {
...CheckInRatingFragment
}
checkInRatingsFOne {
...CheckInRatingFragment
}
commentTrailId
isActiveForEmp
isActiveForManager
}
}
Variables
{
"checkInId": "5e5677d71bdc2ae76344968c",
"ratingResponse": "abc123",
"managerTypeId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c"
}
Response
{
"data": {
"updateRatingResponseForCheckIn": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"checkInType": "xyz789",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 123,
"checkInStatus": "xyz789",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": true,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": false,
"isActiveForManager": false
}
}
}
updateReport
Description
To update Report Type. Access allowed to WeSoar Super Admin.
Response
Returns a Report
Arguments
| Name | Description |
|---|---|
params - UpdateReportParams!
|
|
options - UpdateReportOptions
|
Example
Query
mutation updateReport(
$params: UpdateReportParams!,
$options: UpdateReportOptions
) {
updateReport(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
isRTL
}
}
Variables
{
"params": UpdateReportParams,
"options": UpdateReportOptions
}
Response
{
"data": {
"updateReport": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 987,
"isActive": true,
"isRTL": false
}
}
}
updateSurveyAnswerCategory
Description
To update Survey Answer Category. Access allowed to WeSoar Super Admin.
Response
Returns a SurveyAnswerCategory
Arguments
| Name | Description |
|---|---|
params - UpdateSurveyAnswerCategoryParams!
|
|
options - UpdateSurveyAnswerCategoryOptions
|
Example
Query
mutation updateSurveyAnswerCategory(
$params: UpdateSurveyAnswerCategoryParams!,
$options: UpdateSurveyAnswerCategoryOptions
) {
updateSurveyAnswerCategory(
params: $params,
options: $options
) {
_id
name
keyName
color
percentage
priority
isActive
}
}
Variables
{
"params": UpdateSurveyAnswerCategoryParams,
"options": UpdateSurveyAnswerCategoryOptions
}
Response
{
"data": {
"updateSurveyAnswerCategory": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"color": "abc123",
"percentage": 987.65,
"priority": 987,
"isActive": true
}
}
}
updateSurveyQuestion
Description
To update Survey Question. Access allowed to WeSoar Super Admin.
Response
Returns a SurveyQuestion
Arguments
| Name | Description |
|---|---|
params - UpdateSurveyQuestionParams!
|
|
options - UpdateSurveyQuestionOptions
|
Example
Query
mutation updateSurveyQuestion(
$params: UpdateSurveyQuestionParams!,
$options: UpdateSurveyQuestionOptions
) {
updateSurveyQuestion(
params: $params,
options: $options
) {
_id
surveyLibraryQuestionId
question {
...QuestionFragment
}
responseBySpecimenKey {
...SurveyResponseFragment
}
responseBySpecimenId {
...SurveyResponseFragment
}
isLibraryQuestion
conversion
stdDev
countResponses
scaleResponseSummary {
...ScaleResponseSummaryFragment
}
responsesByCheckInId {
...ResponseByCheckInFragment
}
sentiments {
...SentimentFragment
}
summary
}
}
Variables
{
"params": UpdateSurveyQuestionParams,
"options": UpdateSurveyQuestionOptions
}
Response
{
"data": {
"updateSurveyQuestion": {
"_id": "5e5677d71bdc2ae76344968c",
"surveyLibraryQuestionId": "5e5677d71bdc2ae76344968c",
"question": Question,
"responseBySpecimenKey": SurveyResponse,
"responseBySpecimenId": SurveyResponse,
"isLibraryQuestion": false,
"conversion": 123.45,
"stdDev": 123.45,
"countResponses": 123,
"scaleResponseSummary": [ScaleResponseSummary],
"responsesByCheckInId": [ResponseByCheckIn],
"sentiments": [Sentiment],
"summary": ["xyz789"]
}
}
}
updateSurveyQuestionFactor
Description
To update Survey Question Factor. Access allowed to WeSoar Super Admin.
Response
Returns a SurveyQuestionFactor
Arguments
| Name | Description |
|---|---|
params - UpdateSurveyQuestionFactorParams!
|
|
options - UpdateSurveyQuestionFactorOptions
|
Example
Query
mutation updateSurveyQuestionFactor(
$params: UpdateSurveyQuestionFactorParams!,
$options: UpdateSurveyQuestionFactorOptions
) {
updateSurveyQuestionFactor(
params: $params,
options: $options
) {
_id
name
keyName
priority
isActive
conversion
stdDev
countQuestions
surveyAnswerCategories {
...SurveyAnswerCategoryFragment
}
overallRankWithGap {
...RankWithGapFragment
}
overallRank
overallGap
wordCloudWords {
...WordCloudWordFragment
}
sentiments {
...SentimentFragment
}
surveyAnswerCompositions {
...SurveyAnswerCategoryFragment
}
summary
responsesByCheckInId {
...ResponseByCheckInFragment
}
responsesTillCheckInId {
...ResponseByCheckInFragment
}
}
}
Variables
{
"params": UpdateSurveyQuestionFactorParams,
"options": UpdateSurveyQuestionFactorOptions
}
Response
{
"data": {
"updateSurveyQuestionFactor": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"priority": 987,
"isActive": false,
"conversion": 123.45,
"stdDev": 987.65,
"countQuestions": 123,
"surveyAnswerCategories": [SurveyAnswerCategory],
"overallRankWithGap": RankWithGap,
"overallRank": 987,
"overallGap": 987.65,
"wordCloudWords": [WordCloudWord],
"sentiments": [Sentiment],
"surveyAnswerCompositions": [SurveyAnswerCategory],
"summary": ["abc123"],
"responsesByCheckInId": [ResponseByCheckIn],
"responsesTillCheckInId": [ResponseByCheckIn]
}
}
}
updateSurveyResponses
Description
To update Survey Response. Access allowed to Survey Respondent.
Response
Returns an UpdateSurveyResponsesPayload
Arguments
| Name | Description |
|---|---|
params - UpdateSurveyResponsesParams
|
|
options - UpdateSurveyResponsesOptions
|
Example
Query
mutation updateSurveyResponses(
$params: UpdateSurveyResponsesParams,
$options: UpdateSurveyResponsesOptions
) {
updateSurveyResponses(
params: $params,
options: $options
) {
surveyResponses {
...SurveyResponseFragment
}
}
}
Variables
{
"params": UpdateSurveyResponsesParams,
"options": UpdateSurveyResponsesOptions
}
Response
{
"data": {
"updateSurveyResponses": {
"surveyResponses": [SurveyResponse]
}
}
}
updateSurveySpecimen
Description
To update Survey Specimen. Access allowed to Survey Respondent.
Response
Returns a SurveySpecimen
Arguments
| Name | Description |
|---|---|
params - UpdateSurveySpecimenParams!
|
|
options - UpdateSurveySpecimenOptions
|
Example
Query
mutation updateSurveySpecimen(
$params: UpdateSurveySpecimenParams!,
$options: UpdateSurveySpecimenOptions
) {
updateSurveySpecimen(
params: $params,
options: $options
) {
_id
programId
program {
...ProgramFragment
}
userId
user {
...UserFragment
}
isOpen
isActive
responses {
...SurveyResponseFragment
}
surveyQuestions {
...SurveyQuestionFragment
}
surveySpecimenKey
participants {
...UserFragment
}
}
}
Variables
{
"params": UpdateSurveySpecimenParams,
"options": UpdateSurveySpecimenOptions
}
Response
{
"data": {
"updateSurveySpecimen": {
"_id": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"user": User,
"isOpen": false,
"isActive": true,
"responses": [SurveyResponse],
"surveyQuestions": [SurveyQuestion],
"surveySpecimenKey": "abc123",
"participants": [User]
}
}
}
updateTermProgram
Description
To update term program. Access allowed to WeSoar Super Admin.
Response
Returns a TermProgram
Arguments
| Name | Description |
|---|---|
params - UpdateTermProgramParams!
|
|
options - UpdateTermProgramOptions
|
Example
Query
mutation updateTermProgram(
$params: UpdateTermProgramParams!,
$options: UpdateTermProgramOptions
) {
updateTermProgram(
params: $params,
options: $options
) {
_id
name
userId
programId
assignDate
deAssignDate
isOpen
isActive
isDeleted
user {
...UserFragment
}
program {
...ProgramFragment
}
myCompanyGoalsPage {
...CommunityGoalsPageFragment
}
myCommunityGoalsPage {
...CommunityGoalsPageFragment
}
approvedGoalsPage {
...GoalsPageFragment
}
withObstacleGoalsPage {
...GoalsPageFragment
}
draftGoalsPage {
...GoalsPageFragment
}
trashedGoalsPage {
...GoalsPageFragment
}
taggedGoalsPage {
...GoalsPageFragment
}
checkInGoalsPage {
...GoalsPageFragment
}
approvedGoalsFacts {
...FactFragment
}
draftGoalsFacts {
...FactFragment
}
trashedGoalsFacts {
...FactFragment
}
taggedGoalsFacts {
...FactFragment
}
submittedGoalsFacts {
...FactFragment
}
goalsFacts {
...FactFragment
}
plannedTasksPage {
...PlannedTasksPageFragment
}
plannedTasksFacts {
...FactFragment
}
taggedPlannedTasksPage {
...PlannedTasksPageFragment
}
taggedPlannedTasksFacts {
...FactFragment
}
unplannedTasksPage {
...UnplannedTasksPageFragment
}
unplannedTasksFacts {
...FactFragment
}
attendancesPage {
...AttendancesPageFragment
}
attendancesFacts {
...FactFragment
}
checkInsPage {
...CheckInsPageFragment
}
checkInsFacts {
...FactFragment
}
appraisalsPage {
...AppraisalsPageFragment
}
appraisalsFacts {
...FactFragment
}
}
}
Variables
{
"params": UpdateTermProgramParams,
"options": UpdateTermProgramOptions
}
Response
{
"data": {
"updateTermProgram": {
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"assignDate": 1592577642,
"deAssignDate": 1592577642,
"isOpen": true,
"isActive": true,
"isDeleted": false,
"user": User,
"program": Program,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"withObstacleGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"checkInGoalsPage": GoalsPage,
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"checkInsPage": CheckInsPage,
"checkInsFacts": [Fact],
"appraisalsPage": AppraisalsPage,
"appraisalsFacts": [Fact]
}
}
}
updateUnplannedTask
Description
To update Unplanned Task. Access allowed to Authenticated User as per business logic.
Response
Returns an UnplannedTask!
Arguments
| Name | Description |
|---|---|
params - UpdateUnplannedTaskParams!
|
|
options - UpdateUnplannedTaskOptions
|
Example
Query
mutation updateUnplannedTask(
$params: UpdateUnplannedTaskParams!,
$options: UpdateUnplannedTaskOptions
) {
updateUnplannedTask(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
unplannedTaskType
unplannedTaskDetail {
...UnplannedTaskDetailFragment
}
comments {
...CommentFragment
}
reactions {
...ReactionFragment
}
impactStageId
impactStage {
...ImpactStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
unplannedTaskCommentsFacts {
...FactFragment
}
myUnplannedTaskReaction {
...ReactionFragment
}
unplannedTaskReactionsFacts {
...FactFragment
}
unplannedTaskReactionsPage {
...ReactionsPageFragment
}
unplannedTasksFacts {
...FactFragment
}
views
}
}
Variables
{
"params": UpdateUnplannedTaskParams,
"options": UpdateUnplannedTaskOptions
}
Response
{
"data": {
"updateUnplannedTask": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "xyz789",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "abc123",
"priority": 987,
"isActive": false,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 987
}
}
}
updateUnplannedTaskReaction
Description
To update Unplanned Task Reaction. Access allowed to Authenticated User as per business logic.
Response
Returns an UnplannedTask
Arguments
| Name | Description |
|---|---|
params - UpdateUnplannedTaskReactionParams!
|
|
options - UpdateUnplannedTaskReactionOptions
|
Example
Query
mutation updateUnplannedTaskReaction(
$params: UpdateUnplannedTaskReactionParams!,
$options: UpdateUnplannedTaskReactionOptions
) {
updateUnplannedTaskReaction(
params: $params,
options: $options
) {
_id
yearId
programId
termProgramId
year {
...YearFragment
}
program {
...ProgramFragment
}
assignedToUser {
...UserFragment
}
assignedByUser {
...UserFragment
}
approvedByUser {
...UserFragment
}
trashedByUser {
...UserFragment
}
assignedDate
updatedDate
submittedDate
approvedDate
trashedDate
deletedDate
unplannedTaskType
unplannedTaskDetail {
...UnplannedTaskDetailFragment
}
comments {
...CommentFragment
}
reactions {
...ReactionFragment
}
impactStageId
impactStage {
...ImpactStageFragment
}
trackingStatus
priority
isActive
isDeleted
commentsPage {
...CommentsPageFragment
}
comment {
...CommentFragment
}
unplannedTaskCommentsFacts {
...FactFragment
}
myUnplannedTaskReaction {
...ReactionFragment
}
unplannedTaskReactionsFacts {
...FactFragment
}
unplannedTaskReactionsPage {
...ReactionsPageFragment
}
unplannedTasksFacts {
...FactFragment
}
views
}
}
Variables
{
"params": UpdateUnplannedTaskReactionParams,
"options": UpdateUnplannedTaskReactionOptions
}
Response
{
"data": {
"updateUnplannedTaskReaction": {
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "abc123",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "xyz789",
"priority": 987,
"isActive": false,
"isDeleted": true,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 987
}
}
}
updateYear
Description
To update Year. Access allowed to WeSoar Super Admin.
Response
Returns a Year
Arguments
| Name | Description |
|---|---|
params - UpdateYearParams!
|
|
options - UpdateYearOptions
|
Example
Query
mutation updateYear(
$params: UpdateYearParams!,
$options: UpdateYearOptions
) {
updateYear(
params: $params,
options: $options
) {
_id
userId
name
keyName
priority
isActive
userModuleCategories {
...UserModuelCategoryFragment
}
}
}
Variables
{
"params": UpdateYearParams,
"options": UpdateYearOptions
}
Response
{
"data": {
"updateYear": {
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 987,
"isActive": false,
"userModuleCategories": [UserModuelCategory]
}
}
}
verifyEmailCode
Description
DEPRECATED To verify email OTP. Access allowed to WeSoar Super Admin.
Response
Returns a VerifyEmailCodePayload
Arguments
| Name | Description |
|---|---|
params - VerifyEmailCodeParams!
|
|
options - VerifyEmailCodeOptions
|
Example
Query
mutation verifyEmailCode(
$params: VerifyEmailCodeParams!,
$options: VerifyEmailCodeOptions
) {
verifyEmailCode(
params: $params,
options: $options
) {
status
}
}
Variables
{
"params": VerifyEmailCodeParams,
"options": VerifyEmailCodeOptions
}
Response
{"data": {"verifyEmailCode": {"status": false}}}
verifyMfaCode
Description
DEPRECATED To Verify MFA Code. Access allowed to WeSoar Super Admin.
Response
Returns a VerifyMfaCodePayload
Arguments
| Name | Description |
|---|---|
params - VerifyMfaCodeParams!
|
|
options - VerifyMfaCodeOptions
|
Example
Query
mutation verifyMfaCode(
$params: VerifyMfaCodeParams!,
$options: VerifyMfaCodeOptions
) {
verifyMfaCode(
params: $params,
options: $options
) {
tokens {
...TokensFragment
}
challenge {
...ChallengeFragment
}
}
}
Variables
{
"params": VerifyMfaCodeParams,
"options": VerifyMfaCodeOptions
}
Response
{
"data": {
"verifyMfaCode": {
"tokens": Tokens,
"challenge": Challenge
}
}
}
verifyMobileNumberCode
Description
DEPRECATED To verify mobile number OTP password. Access allowed to WeSoar Super Admin.
Response
Returns a VerifyMobileNumberCodePayload
Arguments
| Name | Description |
|---|---|
params - VerifyMobileNumberCodeParams!
|
|
options - VerifyMobileNumberCodeOptions
|
Example
Query
mutation verifyMobileNumberCode(
$params: VerifyMobileNumberCodeParams!,
$options: VerifyMobileNumberCodeOptions
) {
verifyMobileNumberCode(
params: $params,
options: $options
) {
status
}
}
Variables
{
"params": VerifyMobileNumberCodeParams,
"options": VerifyMobileNumberCodeOptions
}
Response
{"data": {"verifyMobileNumberCode": {"status": false}}}
Types
Ability
Fields
| Field Name | Description |
|---|---|
action - String
|
|
subject - String
|
|
fields - [String]
|
|
conditions - JSONObject
|
Example
{
"action": "xyz789",
"subject": "xyz789",
"fields": ["xyz789"],
"conditions": {}
}
AddAttendanceLogOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
AddAttendanceLogParams
Fields
| Input Field | Description |
|---|---|
attendanceLog - Attendance_Log_Input
|
|
termProgramId - ObjectID
|
|
userId - ObjectID
|
Example
{
"attendanceLog": Attendance_Log_Input,
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c"
}
AddCommentParams
Fields
| Input Field | Description |
|---|---|
comment - Comment_Input
|
Example
{"comment": Comment_Input}
AddCommentReactionParams
AddConversationMetasOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AddConversationMetasParams
Fields
| Input Field | Description |
|---|---|
conversationId - ObjectID
|
|
metas - [Meta_Input]
|
Example
{
"conversationId": "5e5677d71bdc2ae76344968c",
"metas": [Meta_Input]
}
AddConversationSubscribersOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
AddConversationSubscribersParams
Fields
| Input Field | Description |
|---|---|
conversationId - ObjectID
|
|
userIds - [ObjectID]
|
Example
{
"conversationId": "5e5677d71bdc2ae76344968c",
"userIds": ["5e5677d71bdc2ae76344968c"]
}
AddGoalAppraisalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AddGoalAppraisalParams
Fields
| Input Field | Description |
|---|---|
goalId - ObjectID
|
|
goalCheckIn - GoalAppraisal_Input
|
Example
{
"goalId": "5e5677d71bdc2ae76344968c",
"goalCheckIn": GoalAppraisal_Input
}
AddGoalCheckInOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AddGoalCheckInParams
Fields
| Input Field | Description |
|---|---|
goalId - ObjectID
|
|
goalCheckIn - GoalCheckIn_Input
|
Example
{
"goalId": "5e5677d71bdc2ae76344968c",
"goalCheckIn": GoalCheckIn_Input
}
AddMessageParams
Fields
| Input Field | Description |
|---|---|
message - Message_Input
|
Example
{"message": Message_Input}
AddMessageReactionParams
AddPlannedTaskFollowUpOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
AddPlannedTaskFollowUpParams
Fields
| Input Field | Description |
|---|---|
_id - ObjectID
|
Example
{"_id": "5e5677d71bdc2ae76344968c"}
AddPlannedTaskFollowUpsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AddPlannedTaskFollowUpsParams
Fields
| Input Field | Description |
|---|---|
userIds - [ObjectID]
|
Example
{"userIds": ["5e5677d71bdc2ae76344968c"]}
AddUnplannedTaskReactionOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
AddUnplannedTaskReactionParams
AdminDisableMfaPayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": true}
AdminEnableMfaPayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": true}
Alarm
Alarm_Input
AlarmsPage
Alias
Fields
| Field Name | Description |
|---|---|
userFilterRule - [JSONObject]
|
|
text - String
|
|
isActive - Boolean
|
Example
{
"userFilterRule": [{}],
"text": "xyz789",
"isActive": true
}
Alias_Input
Fields
| Input Field | Description |
|---|---|
userFilterRule - [JSONObject]
|
|
text - String
|
|
isActive - Boolean
|
Example
{
"userFilterRule": [{}],
"text": "xyz789",
"isActive": true
}
Appraisal
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
termProgramId - ObjectID
|
|
appraisalRating - AppraisalRating
|
|
appraisalDate - Timestamp
|
|
name - String
|
|
commentsPage - CommentsPage
|
|
Arguments |
|
comment - Comment
|
|
Arguments
|
|
appraisalGoalsPage - GoalsPage
|
|
Arguments
|
|
priority - Int
|
|
appraisalStatus - String
|
|
appraisalCalculation - String
|
|
isDeleted - Boolean
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"appraisalRating": AppraisalRating,
"appraisalDate": 1592577642,
"name": "abc123",
"commentsPage": CommentsPage,
"comment": Comment,
"appraisalGoalsPage": GoalsPage,
"priority": 123,
"appraisalStatus": "abc123",
"appraisalCalculation": "xyz789",
"isDeleted": true
}
AppraisalRating
Fields
| Field Name | Description |
|---|---|
byEmp - [AppraisalRatingDS]
|
|
byManager - [AppraisalRatingDS]
|
Example
{
"byEmp": [AppraisalRatingDS],
"byManager": [AppraisalRatingDS]
}
AppraisalRatingDS
AppraisalRatingDS_Input
AppraisalRating_Input
Fields
| Input Field | Description |
|---|---|
byEmp - [AppraisalRatingDS_Input]
|
|
byManager - [AppraisalRatingDS_Input]
|
Example
{
"byEmp": [AppraisalRatingDS_Input],
"byManager": [AppraisalRatingDS_Input]
}
Appraisal_Input
Example
{
"termProgramId": "5e5677d71bdc2ae76344968c",
"appraisalRating": AppraisalRating_Input,
"appraisalDate": 1592577642,
"name": "xyz789",
"priority": 123,
"appraisalStatus": "xyz789",
"isDeleted": false
}
AppraisalsPage
Description
type CheckInsPage { docs: [CheckIn!]! pageInfo: PageInfo! }
Fields
| Field Name | Description |
|---|---|
docs - [Appraisal!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Appraisal],
"pageInfo": PageInfo
}
AssignFeaturesToUserOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AssignFeaturesToUserParams
AssignFeaturesToUserPayload
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": false}
AssignFeaturesToUsersOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
AssignFeaturesToUsersParams
AssignFeaturesToUsersPayload
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": false}
AssignManagerToUserOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AssignManagerToUserParams
Fields
| Input Field | Description |
|---|---|
userId - ObjectID
|
|
manager - User_Manager_Input
|
Example
{
"userId": "5e5677d71bdc2ae76344968c",
"manager": User_Manager_Input
}
AssignManagerToUserPayload
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": true}
AssignRolesToUserOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
AssignRolesToUserParams
AssignRolesToUserPayload
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": true}
AssignRolesToUsersOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
AssignRolesToUsersParams
AssignRolesToUsersPayload
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": true}
Attendance
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
yearId - ObjectID
|
|
programId - ObjectID
|
|
termProgramId - ObjectID
|
|
year - Year
|
|
program - Program
|
|
userId - ObjectID
|
|
attendanceLogs - [AttendanceLog]
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
attendanceLogsPage - AttendanceLogsPage
|
|
Arguments
|
|
attendanceLogForDate - AttendanceLog
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [AttendanceLog],
"isActive": false,
"isDeleted": false,
"attendanceLogsPage": AttendanceLogsPage,
"attendanceLogForDate": AttendanceLog
}
AttendanceLog
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
startTimeByEmp - Timestamp
|
|
startTimeByEmpTZOffset - UtcOffset
|
|
endTimeByEmp - Timestamp
|
|
endTimeByEmpTZOffset - UtcOffset
|
|
startTimeByManager - Timestamp
|
|
startTimeByManagerTZOffset - UtcOffset
|
|
endTimeByManager - Timestamp
|
|
endTimeByManagerTZOffset - UtcOffset
|
|
approvedByUserId - ObjectID
|
|
isApproved - Boolean
|
|
approvedByUser - User
|
|
approvedDate - Timestamp
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"startTimeByEmp": 1592577642,
"startTimeByEmpTZOffset": "+03:00",
"endTimeByEmp": 1592577642,
"endTimeByEmpTZOffset": "+03:00",
"startTimeByManager": 1592577642,
"startTimeByManagerTZOffset": "+03:00",
"endTimeByManager": 1592577642,
"endTimeByManagerTZOffset": "+03:00",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"isApproved": true,
"approvedByUser": User,
"approvedDate": 1592577642
}
AttendanceLogsPage
Fields
| Field Name | Description |
|---|---|
docs - [AttendanceLog]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [AttendanceLog],
"pageInfo": PageInfo
}
Attendance_Input
Fields
| Input Field | Description |
|---|---|
yearId - ObjectID
|
|
termProgramId - ObjectID
|
|
programId - ObjectID
|
|
userId - ObjectID
|
|
attendanceLogs - [Attendance_Log_Input]
|
Example
{
"yearId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogs": [Attendance_Log_Input]
}
Attendance_Log_Input
Fields
| Input Field | Description |
|---|---|
startTimeByEmp - Timestamp
|
|
startTimeByEmpTZOffset - UtcOffset
|
|
endTimeByEmp - Timestamp
|
|
endTimeByEmpTZOffset - UtcOffset
|
|
startTimeByManager - Timestamp
|
|
startTimeByManagerTZOffset - UtcOffset
|
|
endTimeByManager - Timestamp
|
|
endTimeByManagerTZOffset - UtcOffset
|
|
isApproved - Boolean
|
|
approvedByUserId - ObjectID
|
|
approvedDate - Timestamp
|
Example
{
"startTimeByEmp": 1592577642,
"startTimeByEmpTZOffset": "+03:00",
"endTimeByEmp": 1592577642,
"endTimeByEmpTZOffset": "+03:00",
"startTimeByManager": 1592577642,
"startTimeByManagerTZOffset": "+03:00",
"endTimeByManager": 1592577642,
"endTimeByManagerTZOffset": "+03:00",
"isApproved": true,
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"approvedDate": 1592577642
}
AttendancesPage
Fields
| Field Name | Description |
|---|---|
docs - [Attendance]
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Attendance],
"pageInfo": PageInfo
}
Boolean
Description
The Boolean scalar type represents true or false.
CascadedGoal
CascadedGoal_Input
Fields
| Input Field | Description |
|---|---|
_id - ObjectID
|
|
userId - ObjectID
|
|
goalId - ObjectID
|
|
goalDetail - GoalDetail_Input
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"goalId": "5e5677d71bdc2ae76344968c",
"goalDetail": GoalDetail_Input
}
Challenge
Fields
| Field Name | Description |
|---|---|
challengeName - String
|
|
challengeParameters - Challenge_ChallengeParameters
|
|
session - String
|
Example
{
"challengeName": "abc123",
"challengeParameters": Challenge_ChallengeParameters,
"session": "xyz789"
}
Challenge_ChallengeParameters
ChangePasswordOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
ChangePasswordParams
ChangePasswordPayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": true}
CheckIn
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
name - String
|
|
checkInType - String
|
|
termProgramId - ObjectID
|
|
userId - ObjectID
|
|
programId - ObjectID
|
|
checkInSetting - CheckInSetting
|
|
checkInDate - Timestamp
|
|
checkInRatings - [CheckInRating]
|
|
priority - Int
|
|
checkInStatus - String
|
|
user - User
|
|
program - Program
|
|
termProgram - TermProgram
|
|
competencies - [SurveyQuestion]
|
name: String checkInType: String termProgramId: ObjectID userId: ObjectID programId: ObjectID checkInDate: Timestamp checkInRatings: [CheckInRating] priority: Int checkInStatus: String |
competenciesFPage - [SurveyQuestion]
|
|
Arguments
|
|
competenciesPage - SurveyQuestionsPage
|
|
Arguments
|
|
isDeleted - Boolean
|
checkInSetting: CheckInSetting |
latestRating - CheckInRating
|
|
checkInRatingsPage - CheckInRatingsPage
|
|
Arguments
|
|
checkInRatingsFPage - [CheckInRating]
|
|
Arguments
|
|
checkInRatingsFOne - CheckInRating
|
|
Arguments
|
|
commentTrailId - ObjectID
|
|
Arguments
|
|
isActiveForEmp - Boolean
|
|
isActiveForManager - Boolean
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"checkInType": "xyz789",
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"checkInSetting": CheckInSetting,
"checkInDate": 1592577642,
"checkInRatings": [CheckInRating],
"priority": 123,
"checkInStatus": "xyz789",
"user": User,
"program": Program,
"termProgram": TermProgram,
"competencies": [SurveyQuestion],
"competenciesFPage": [SurveyQuestion],
"competenciesPage": SurveyQuestionsPage,
"isDeleted": true,
"latestRating": CheckInRating,
"checkInRatingsPage": CheckInRatingsPage,
"checkInRatingsFPage": [CheckInRating],
"checkInRatingsFOne": CheckInRating,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"isActiveForEmp": false,
"isActiveForManager": true
}
CheckInGoal
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
goalId - ObjectID
|
|
goalType - String
|
|
goalDetail - CheckInGoalDetail
|
|
trackingStatus - String
|
|
achievement - String
|
|
goalProgress - Int
|
|
relevance - String
|
|
ratingValue - Int
|
|
goal - Goal
|
|
commentTrailId - ObjectID
|
|
Arguments
|
|
responsesByCheckInId - [ResponseByCheckIn]
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"goalId": "5e5677d71bdc2ae76344968c",
"goalType": "xyz789",
"goalDetail": CheckInGoalDetail,
"trackingStatus": "xyz789",
"achievement": "xyz789",
"goalProgress": 987,
"relevance": "abc123",
"ratingValue": 987,
"goal": Goal,
"commentTrailId": "5e5677d71bdc2ae76344968c",
"responsesByCheckInId": [ResponseByCheckIn]
}
CheckInGoalDetail
Fields
| Field Name | Description |
|---|---|
isQuantitative - Boolean
|
|
goalCategoryId - ObjectID
|
|
description - String
|
|
weightage - Float
|
|
targetFrequency - String
|
|
targetUnit - String
|
|
target - String
|
|
quantitativeTarget - Float
|
|
dueBy - Timestamp
|
|
taggedUserIds - [ObjectID]
|
|
milestones - [CheckInMilestone]
|
|
goalCategory - GoalCategory
|
|
taggedUsers - [User]
|
|
goalId - ObjectID
|
Example
{
"isQuantitative": false,
"goalCategoryId": "5e5677d71bdc2ae76344968c",
"description": "abc123",
"weightage": 987.65,
"targetFrequency": "xyz789",
"targetUnit": "abc123",
"target": "abc123",
"quantitativeTarget": 123.45,
"dueBy": 1592577642,
"taggedUserIds": [
"5e5677d71bdc2ae76344968c"
],
"milestones": [CheckInMilestone],
"goalCategory": GoalCategory,
"taggedUsers": [User],
"goalId": "5e5677d71bdc2ae76344968c"
}
CheckInGoalDetail_Input
Example
{
"isQuantitative": false,
"goalCategoryId": "5e5677d71bdc2ae76344968c",
"description": "xyz789",
"weightage": 987.65,
"targetFrequency": "xyz789",
"targetUnit": "xyz789",
"target": "abc123",
"quantitativeTarget": 987.65,
"dueBy": 1592577642,
"taggedUserIds": [
"5e5677d71bdc2ae76344968c"
],
"milestones": [CheckInMilestone_Input]
}
CheckInGoal_Input
Example
{
"goalId": "5e5677d71bdc2ae76344968c",
"goalType": "xyz789",
"goalDetail": CheckInGoalDetail_Input,
"trackingStatus": "xyz789",
"achievement": "abc123",
"goalProgress": 123,
"relevance": "abc123",
"ratingValue": 987
}
CheckInMilestone
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
milestoneId - ObjectID
|
|
what - String
|
|
when - Timestamp
|
|
whoseUserIds - [ObjectID]
|
|
milestoneProgress - Int
|
|
isQuantitative - Boolean
|
|
targetFrequency - String
|
|
targetUnit - String
|
|
target - String
|
|
quantitativeTarget - Float
|
|
goalId - ObjectID
|
|
whoseUsers - [User]
|
|
milestone - MileStone
|
|
responsesByCheckInId - [ResponseByCheckIn]
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"milestoneId": "5e5677d71bdc2ae76344968c",
"what": "xyz789",
"when": 1592577642,
"whoseUserIds": [
"5e5677d71bdc2ae76344968c"
],
"milestoneProgress": 987,
"isQuantitative": false,
"targetFrequency": "xyz789",
"targetUnit": "abc123",
"target": "xyz789",
"quantitativeTarget": 123.45,
"goalId": "5e5677d71bdc2ae76344968c",
"whoseUsers": [User],
"milestone": MileStone,
"responsesByCheckInId": [ResponseByCheckIn]
}
CheckInMilestone_Input
Example
{
"milestoneId": "5e5677d71bdc2ae76344968c",
"what": "abc123",
"when": 1592577642,
"whoseUserIds": [
"5e5677d71bdc2ae76344968c"
],
"milestoneProgress": 987,
"isQuantitative": true,
"targetFrequency": "abc123",
"targetUnit": "abc123",
"target": "xyz789",
"quantitativeTarget": 987.65
}
CheckInProgress
CheckInProgress_Input
Fields
| Input Field | Description |
|---|---|
byEmp - CheckInProgress_Progress_Input
|
|
byManager - CheckInProgress_Progress_Input
|
Example
{
"byEmp": CheckInProgress_Progress_Input,
"byManager": CheckInProgress_Progress_Input
}
CheckInProgress_Progress_Input
Fields
| Input Field | Description |
|---|---|
actualAchievement - String
|
|
trackingStatus - String
|
|
overallProgress - Int
|
|
milestoneProgress - [CheckInProgress_Progress_MilestoneProgress_Input]
|
|
updatedDate - Timestamp
|
Example
{
"actualAchievement": "abc123",
"trackingStatus": "xyz789",
"overallProgress": 123,
"milestoneProgress": [
CheckInProgress_Progress_MilestoneProgress_Input
],
"updatedDate": 1592577642
}
CheckInProgress_Progress_MilestoneProgress_Input
CheckInRating
Fields
| Field Name | Description |
|---|---|
managerTypeId - ObjectID
|
|
userManagerId - ObjectID
|
|
priority - Int
|
|
checkInGoals - [CheckInGoal]
|
|
competenceTypeResponses - [CompetenceTypeResponse]
|
|
competenceResponses - [CompetenceResponse]
|
|
ratingStatus - String
|
|
ratingResponse - String
|
|
overallRating - Int
|
|
kpiRating - Int
|
|
managerType - ManagerType
|
|
userManager - User
|
|
responsesByCheckInId - [ResponseByCheckIn]
|
|
responsesTillCheckInId - [ResponseByCheckIn]
|
|
avgRatingOfResponsesTillCheckInId - Int
|
|
calcKpiRatingByCheckInId - ResponseByCheckIn
|
|
calcOverallRatingByCheckInId - ResponseByCheckIn
|
|
kpiRatingsByCheckInId - [ResponseByCheckIn]
|
|
Arguments
|
|
kpiWeightageByCheckInId - Float
|
|
Arguments
|
|
Example
{
"managerTypeId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c",
"priority": 987,
"checkInGoals": [CheckInGoal],
"competenceTypeResponses": [CompetenceTypeResponse],
"competenceResponses": [CompetenceResponse],
"ratingStatus": "xyz789",
"ratingResponse": "abc123",
"overallRating": 987,
"kpiRating": 123,
"managerType": ManagerType,
"userManager": User,
"responsesByCheckInId": [ResponseByCheckIn],
"responsesTillCheckInId": [ResponseByCheckIn],
"avgRatingOfResponsesTillCheckInId": 987,
"calcKpiRatingByCheckInId": ResponseByCheckIn,
"calcOverallRatingByCheckInId": ResponseByCheckIn,
"kpiRatingsByCheckInId": [ResponseByCheckIn],
"kpiWeightageByCheckInId": 987.65
}
CheckInRating_Input
Fields
| Input Field | Description |
|---|---|
managerTypeId - ObjectID
|
|
userManagerId - ObjectID
|
|
priority - Int
|
|
checkInGoals - [CheckInGoal_Input]
|
|
competenceTypeResponses - [CompetenceTypeResponse_Input]
|
|
competenceResponses - [CompetenceResponse_Input]
|
|
ratingStatus - String
|
|
ratingResponse - String
|
|
overallRating - Int
|
|
kpiRating - Int
|
Example
{
"managerTypeId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c",
"priority": 987,
"checkInGoals": [CheckInGoal_Input],
"competenceTypeResponses": [
CompetenceTypeResponse_Input
],
"competenceResponses": [CompetenceResponse_Input],
"ratingStatus": "xyz789",
"ratingResponse": "abc123",
"overallRating": 987,
"kpiRating": 123
}
CheckInRatingsPage
Fields
| Field Name | Description |
|---|---|
docs - [CheckInRating!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [CheckInRating],
"pageInfo": PageInfo
}
CheckInRelevance
CheckInRelevance_Input
Fields
| Input Field | Description |
|---|---|
byEmp - CheckInRelevance_Relevance_Input
|
|
byManager - CheckInRelevance_Relevance_Input
|
Example
{
"byEmp": CheckInRelevance_Relevance_Input,
"byManager": CheckInRelevance_Relevance_Input
}
CheckInRelevance_Relevance_Input
CheckInSetting
Fields
| Field Name | Description |
|---|---|
competenceTypes - [CompetenceType]
|
|
competencies - [Competence]
|
|
workflows - [Workflow]
|
|
goalRatingScales - [SurveyAnswerOption]
|
|
overallRatingScales - [SurveyAnswerOption]
|
|
calculationMethod - String
|
|
frequency - String
|
|
startDate - Timestamp
|
|
endDate - Timestamp
|
|
competenceTypesPage - CompetenceTypesPage
|
|
Arguments
|
|
competenceTypesFPage - [CompetenceType]
|
|
Arguments
|
|
competenceTypesFOne - CompetenceType
|
|
Arguments
|
|
workflowsPage - WorkflowsPage
|
|
Arguments
|
|
workflowsFPage - [Workflow]
|
|
Arguments
|
|
workflowsFOne - Workflow
|
|
Arguments
|
|
competenceTypesByCheckInId - [CompetenceType]
|
|
Arguments
|
|
kpiWeightageByCheckInId - Float
|
|
Arguments
|
|
Example
{
"competenceTypes": [CompetenceType],
"competencies": [Competence],
"workflows": [Workflow],
"goalRatingScales": [SurveyAnswerOption],
"overallRatingScales": [SurveyAnswerOption],
"calculationMethod": "abc123",
"frequency": "abc123",
"startDate": 1592577642,
"endDate": 1592577642,
"competenceTypesPage": CompetenceTypesPage,
"competenceTypesFPage": [CompetenceType],
"competenceTypesFOne": CompetenceType,
"workflowsPage": WorkflowsPage,
"workflowsFPage": [Workflow],
"workflowsFOne": Workflow,
"competenceTypesByCheckInId": [CompetenceType],
"kpiWeightageByCheckInId": 987.65
}
CheckInSetting_Input
Fields
| Input Field | Description |
|---|---|
competenceTypes - [CompetenceType_Input]
|
|
competencies - [Competence_Input]
|
|
workflows - [Workflow_Input]
|
|
goalRatingScales - [SurveyAnswerOption_Input]
|
|
overallRatingScales - [SurveyAnswerOption_Input]
|
|
calculationMethod - String
|
|
frequency - String
|
|
startDate - Timestamp
|
|
endDate - Timestamp
|
Example
{
"competenceTypes": [CompetenceType_Input],
"competencies": [Competence_Input],
"workflows": [Workflow_Input],
"goalRatingScales": [SurveyAnswerOption_Input],
"overallRatingScales": [SurveyAnswerOption_Input],
"calculationMethod": "abc123",
"frequency": "abc123",
"startDate": 1592577642,
"endDate": 1592577642
}
CheckIn_Input
Fields
| Input Field | Description |
|---|---|
checkInRatings - [CheckInRating_Input]
|
Example
{"checkInRatings": [CheckInRating_Input]}
CheckInsPage
Fields
| Field Name | Description |
|---|---|
docs - [CheckIn!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [CheckIn],
"pageInfo": PageInfo
}
CodeDeliveryDetails
Comment
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
parentCommentId - ObjectID
|
|
fbMessageId - String
|
|
text - String
|
|
files - [File]
|
|
reactions - [Reaction]
|
|
shares - [Share]
|
|
userId - ObjectID
|
|
mentions - [Mention]
|
|
isEdited - Boolean
|
|
isDeleted - Boolean
|
|
commentDate - Timestamp
|
|
type - String
|
|
updatedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
user - User
|
mentions: [Mention] userId: ObjectID isEdited: Boolean isDeleted: Boolean commentDate: Timestamp |
myReaction - Reaction
|
|
parentComment - Comment
|
|
reactionsFacts - [Fact]
|
|
Arguments
|
|
commentsFacts - [Fact]
|
|
Arguments
|
|
filesFacts - [Fact]
|
|
Arguments
|
|
commentsPage - CommentsPage
|
|
Arguments
|
|
filesPage - [File]
|
|
Arguments
|
|
reactionsPage - ReactionsPage
|
|
Arguments
|
|
sharesPage - SharesPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention],
"isEdited": true,
"isDeleted": false,
"commentDate": 1592577642,
"type": "abc123",
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"user": User,
"myReaction": Reaction,
"parentComment": Comment,
"reactionsFacts": [Fact],
"commentsFacts": [Fact],
"filesFacts": [Fact],
"commentsPage": CommentsPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
Comment_Input
Fields
| Input Field | Description |
|---|---|
parentCommentId - ObjectID
|
|
fbMessageId - String
|
|
text - String
|
|
files - [File_Input]
|
|
reactions - [Reaction_Input]
|
|
shares - [Share_Input]
|
|
userId - ObjectID
|
|
mentions - [Mention_Input]
|
|
isEdited - Boolean
|
|
isDeleted - Boolean
|
|
commentDate - Timestamp
|
|
type - String
|
|
updatedDate - Timestamp
|
|
deletedDate - Timestamp
|
Example
{
"parentCommentId": "5e5677d71bdc2ae76344968c",
"fbMessageId": "abc123",
"text": "abc123",
"files": [File_Input],
"reactions": [Reaction_Input],
"shares": [Share_Input],
"userId": "5e5677d71bdc2ae76344968c",
"mentions": [Mention_Input],
"isEdited": false,
"isDeleted": true,
"commentDate": 1592577642,
"type": "xyz789",
"updatedDate": 1592577642,
"deletedDate": 1592577642
}
CommentsPage
Fields
| Field Name | Description |
|---|---|
docs - [Comment!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Comment],
"pageInfo": PageInfo
}
CommunicationEvent
CommunicationEvent_Input
CommunicationEventsPage
Fields
| Field Name | Description |
|---|---|
docs - [CommunicationEvent]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [CommunicationEvent],
"pageInfo": PageInfo
}
CommunityGoal
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
adminUserId - ObjectID
|
|
adminUser - User
|
|
yearId - ObjectID
|
|
year - Year
|
|
programId - ObjectID
|
|
program - Program
|
|
goalType - String
|
|
trackingStatus - String
|
|
achievement - String
|
|
isCompanyGoal - Boolean
|
|
goalDetail - GoalDetail
|
|
participations - [Participation]
|
|
participationsPage - ParticipationsPage
|
|
Arguments
|
|
participationsFacts - [Fact]
|
|
Arguments
|
|
subscriptions - [Participation]
|
|
subscriptionsPage - SubscriptionsPage
|
|
Arguments
|
|
subscriptionsFacts - [Fact]
|
|
Arguments
|
|
subscribers - [User]
|
|
subscribersPage - UsersPage
|
|
Arguments
|
|
comments - [Comment]
|
|
progress - Int
|
|
goalProgress - Float
|
|
keyName - String
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
hash - String
|
|
isParticipant - Boolean
|
|
Arguments
|
|
isSubscriber - Boolean
|
|
Arguments
|
|
isAdmin - Boolean
|
|
Arguments
|
|
createdDate - Timestamp
|
|
updatedDate - Timestamp
|
|
trashedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
commentsPage - CommentsPage
|
|
Arguments
|
|
comment - Comment
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"adminUserId": "5e5677d71bdc2ae76344968c",
"adminUser": User,
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"goalType": "xyz789",
"trackingStatus": "xyz789",
"achievement": "abc123",
"isCompanyGoal": false,
"goalDetail": GoalDetail,
"participations": [Participation],
"participationsPage": ParticipationsPage,
"participationsFacts": [Fact],
"subscriptions": [Participation],
"subscriptionsPage": SubscriptionsPage,
"subscriptionsFacts": [Fact],
"subscribers": [User],
"subscribersPage": UsersPage,
"comments": [Comment],
"progress": 987,
"goalProgress": 987.65,
"keyName": "abc123",
"priority": 987,
"isActive": true,
"isDeleted": true,
"hash": "abc123",
"isParticipant": false,
"isSubscriber": true,
"isAdmin": true,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"comment": Comment
}
CommunityGoal_Input
Example
{
"keyName": "xyz789",
"yearId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"communityGoalId": "5e5677d71bdc2ae76344968c",
"goalDetail": GoalDetail_Input,
"hash": "xyz789"
}
CommunityGoalsPage
Fields
| Field Name | Description |
|---|---|
docs - [CommunityGoal]
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [CommunityGoal],
"pageInfo": PageInfo
}
Competence
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"surveyLibraryQuestionId": "5e5677d71bdc2ae76344968c",
"question": Question,
"isActive": false,
"surveyLibraryQuestion": Question
}
CompetenceResponse
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"competenceId": "5e5677d71bdc2ae76344968c",
"surveyQuestionId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["abc123"],
"scaleAnswer": 123,
"textAnswer": "xyz789",
"isNotApplicable": true,
"remark": "abc123",
"isActive": true,
"isDeleted": false,
"surveyQuestion": SurveyQuestion
}
CompetenceResponse_Input
Example
{
"surveyQuestionId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["xyz789"],
"scaleAnswer": 123,
"textAnswer": "xyz789",
"isNotApplicable": true,
"remark": "xyz789",
"isActive": true
}
CompetenceType
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
surveyQuestionFactorId - ObjectID
|
|
regularUserFilterRules - [JSONObject]
|
|
appraisalUserFilterRules - [ObjectID]
|
|
userSegmentWeightages - [UserSegmentWeightage]
|
|
ratingScales - [SurveyAnswerOption]
|
|
tooltipText - String
|
|
weightage - Int
|
|
isActive - Boolean
|
|
surveyQuestionFactor - SurveyQuestionFactor
|
|
weightageByCheckInId - Float
|
|
Arguments
|
|
calcScaleAnswerByCheckInId - ResponseByCheckIn
|
|
commentTrailId - ObjectID
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"surveyQuestionFactorId": "5e5677d71bdc2ae76344968c",
"regularUserFilterRules": [{}],
"appraisalUserFilterRules": [
"5e5677d71bdc2ae76344968c"
],
"userSegmentWeightages": [UserSegmentWeightage],
"ratingScales": [SurveyAnswerOption],
"tooltipText": "abc123",
"weightage": 987,
"isActive": false,
"surveyQuestionFactor": SurveyQuestionFactor,
"weightageByCheckInId": 123.45,
"calcScaleAnswerByCheckInId": ResponseByCheckIn,
"commentTrailId": "5e5677d71bdc2ae76344968c"
}
CompetenceTypeResponse
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"surveyQuestionFactorId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["xyz789"],
"scaleAnswer": 987,
"textAnswer": "abc123",
"isNotApplicable": true,
"remark": "xyz789",
"isActive": true,
"surveyQuestionFactor": SurveyQuestionFactor
}
CompetenceTypeResponse_Input
Example
{
"surveyQuestionFactorId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["abc123"],
"scaleAnswer": 123,
"textAnswer": "abc123",
"isNotApplicable": true,
"remark": "abc123",
"isActive": true
}
CompetenceType_Input
Fields
| Input Field | Description |
|---|---|
surveyQuestionFactorId - ObjectID
|
|
regularUserFilterRules - [JSONObject]
|
|
appraisalUserFilterRules - [ObjectID]
|
|
userSegmentWeightages - [UserSegmentWeightage_Input]
|
|
ratingScales - [SurveyAnswerOption_Input]
|
|
tooltipText - String
|
|
weightage - Int
|
|
isActive - Boolean
|
Example
{
"surveyQuestionFactorId": "5e5677d71bdc2ae76344968c",
"regularUserFilterRules": [{}],
"appraisalUserFilterRules": [
"5e5677d71bdc2ae76344968c"
],
"userSegmentWeightages": [UserSegmentWeightage_Input],
"ratingScales": [SurveyAnswerOption_Input],
"tooltipText": "abc123",
"weightage": 123,
"isActive": false
}
CompetenceTypesPage
Fields
| Field Name | Description |
|---|---|
docs - [CompetenceType!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [CompetenceType],
"pageInfo": PageInfo
}
Competence_Input
Fields
| Input Field | Description |
|---|---|
surveyLibraryQuestionId - ObjectID
|
|
question - Question_Input
|
|
isActive - Boolean
|
Example
{
"surveyLibraryQuestionId": "5e5677d71bdc2ae76344968c",
"question": Question_Input,
"isActive": false
}
ConfirmForgotPasswordOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
ConfirmForgotPasswordParams
ConfirmForgotPasswordPayload
Conversation
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
name - String
|
|
description - String
|
|
icon - File
|
|
rootId - ObjectID
|
|
rootType - String
|
|
fldName - String
|
|
subscriptions - [Participation]
|
|
subscriptionsPage - ParticipationsPage
|
|
Arguments
|
|
subscriptionsFacts - [Fact]
|
|
Arguments
|
|
metas - [Meta]
|
|
metasPage - MetasPage
|
|
Arguments
|
|
metasFacts - [Fact]
|
|
Arguments
|
|
comments - [Comment]
|
|
messages - [Message]
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
lastMessageDate - Timestamp
|
|
lastMessage - Message
|
|
createdDate - Timestamp
|
|
updatedDate - Timestamp
|
|
trashedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
commentsPage - CommentsPage
|
|
Arguments
|
|
messagesPage - MessagesPage
|
|
Arguments
|
|
filesPage - FilesPage
|
|
Arguments
|
|
comment - Comment
|
|
Arguments
|
|
subscribersPage - UsersPage
|
|
Arguments
|
|
unseenCount - Int
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"description": "abc123",
"icon": File,
"rootId": "5e5677d71bdc2ae76344968c",
"rootType": "abc123",
"fldName": "xyz789",
"subscriptions": [Participation],
"subscriptionsPage": ParticipationsPage,
"subscriptionsFacts": [Fact],
"metas": [Meta],
"metasPage": MetasPage,
"metasFacts": [Fact],
"comments": [Comment],
"messages": [Message],
"priority": 987,
"isActive": false,
"isDeleted": false,
"lastMessageDate": 1592577642,
"lastMessage": Message,
"createdDate": 1592577642,
"updatedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"commentsPage": CommentsPage,
"messagesPage": MessagesPage,
"filesPage": FilesPage,
"comment": Comment,
"subscribersPage": UsersPage,
"unseenCount": 987
}
Conversation_Input
Fields
| Input Field | Description |
|---|---|
name - String
|
|
description - String
|
|
icon - File_Input
|
|
subscriptions - [Participation_Input]
|
Example
{
"name": "abc123",
"description": "xyz789",
"icon": File_Input,
"subscriptions": [Participation_Input]
}
ConversationsPage
Fields
| Field Name | Description |
|---|---|
docs - [Conversation]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [Conversation],
"pageInfo": PageInfo
}
CopyCommunityGoalsOptions
Fields
| Input Field | Description |
|---|---|
termProgramId - ObjectID
|
Example
{
"termProgramId": "5e5677d71bdc2ae76344968c"
}
CopyCommunityGoalsParams
Fields
| Input Field | Description |
|---|---|
communityGoalIds - [ObjectID]
|
|
assignedToUserIds - [ObjectID]
|
Example
{
"communityGoalIds": [
"5e5677d71bdc2ae76344968c"
],
"assignedToUserIds": [
"5e5677d71bdc2ae76344968c"
]
}
CreateAlarmOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateAlarmParams
Fields
| Input Field | Description |
|---|---|
alarm - Alarm_Input
|
Example
{"alarm": Alarm_Input}
CreateAppraisalForUsersOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateAppraisalForUsersParams
Fields
| Input Field | Description |
|---|---|
userIds - [String]
|
Example
{"userIds": ["abc123"]}
CreateAppraisalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateAppraisalParams
Fields
| Input Field | Description |
|---|---|
appraisal - Appraisal_Input
|
Example
{"appraisal": Appraisal_Input}
CreateAttendanceOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateAttendanceParams
Fields
| Input Field | Description |
|---|---|
attendance - Attendance_Input
|
Example
{"attendance": Attendance_Input}
CreateCheckInForUsersOptions
Example
{
"checkInType": "xyz789",
"checkInName": "abc123",
"checkInRevisionId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c"
}
CreateCheckInForUsersParams
Fields
| Input Field | Description |
|---|---|
search - JSONString
|
Example
{"search": JSONString}
CreateCheckInOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateCheckInParams
Fields
| Input Field | Description |
|---|---|
checkIn - CheckIn_Input
|
Example
{"checkIn": CheckIn_Input}
CreateCommunicationEventOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateCommunicationEventParams
Fields
| Input Field | Description |
|---|---|
communicationEvent - CommunicationEvent_Input
|
Example
{"communicationEvent": CommunicationEvent_Input}
CreateCommunityGoalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateCommunityGoalParams
Fields
| Input Field | Description |
|---|---|
communityGoal - CommunityGoal_Input
|
Example
{"communityGoal": CommunityGoal_Input}
CreateConversationOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateConversationParams
Fields
| Input Field | Description |
|---|---|
conversation - Conversation_Input
|
Example
{"conversation": Conversation_Input}
CreateGoalOptions
CreateGoalParams
Fields
| Input Field | Description |
|---|---|
goal - Goal_Input
|
|
assignedToUserId - ObjectID
|
Example
{
"goal": Goal_Input,
"assignedToUserId": "5e5677d71bdc2ae76344968c"
}
CreateLanguageOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateLanguageParams
Fields
| Input Field | Description |
|---|---|
language - Language_Input
|
Example
{"language": Language_Input}
CreateMasterParams
CreateModuleCategoryOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateModuleCategoryParams
Fields
| Input Field | Description |
|---|---|
moduleCategory - ModuleCategory_Input
|
Example
{"moduleCategory": ModuleCategory_Input}
CreateModuleOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateModuleParams
Fields
| Input Field | Description |
|---|---|
module - Module_Input
|
Example
{"module": Module_Input}
CreateNotificationOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateNotificationParams
Fields
| Input Field | Description |
|---|---|
notification - Notification_Input
|
Example
{"notification": Notification_Input}
CreateOrgAdminOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateOrgAdminParams
Example
{
"organisationId": "xyz789",
"userName": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"empCode": "xyz789",
"email": "abc123",
"mobileNumber": "xyz789",
"isEmailVerified": true,
"isMobileNumberVerified": true
}
CreateOrgAdminPayload
Example
{
"id": "5e5677d71bdc2ae76344968c",
"userName": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"empCode": "abc123",
"email": "xyz789",
"mobileNumber": "abc123",
"isEmailVerified": false,
"isMobileNumberVerified": false
}
CreateOrgUnitOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateOrgUnitParams
Fields
| Input Field | Description |
|---|---|
orgUnit - OrgUnit_Input
|
Example
{"orgUnit": OrgUnit_Input}
CreateOrganisationOptions
Fields
| Input Field | Description |
|---|---|
isCreateDefaultRoles - Boolean
|
Example
{"isCreateDefaultRoles": true}
CreateOrganisationParams
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
keyName - String!
|
|
wesoarDomain - String!
|
|
organisationGroup - String
|
|
contactPerson - CreateOrganisation_Person_Input
|
|
registeredAddress - CreateOrganisation_Address_Input
|
|
website - String
|
|
profilePicUrl - String
|
|
organisationSize - String
|
|
organisationIndustry - String
|
|
organisationType - String
|
|
organisationStatus - String
|
|
yearOfEstablishment - Int
|
|
totalRevenue - Int
|
|
objectives - String
|
|
activationCode - String
|
|
contractDetails - [CreateOrganisation_ContractDetails_Input]
|
|
subscriptions - [CreateOrganisation_Subscription_Input]
|
|
defaultFieldMapping - String
|
|
technicalData - CreateOrganisation_TechnicalData_Input
|
|
adminUser - CreateOrganisation_adminUsesr_Input
|
Example
{
"name": "xyz789",
"keyName": "abc123",
"wesoarDomain": "xyz789",
"organisationGroup": "abc123",
"contactPerson": CreateOrganisation_Person_Input,
"registeredAddress": CreateOrganisation_Address_Input,
"website": "xyz789",
"profilePicUrl": "abc123",
"organisationSize": "abc123",
"organisationIndustry": "abc123",
"organisationType": "xyz789",
"organisationStatus": "abc123",
"yearOfEstablishment": 987,
"totalRevenue": 123,
"objectives": "abc123",
"activationCode": "abc123",
"contractDetails": [
CreateOrganisation_ContractDetails_Input
],
"subscriptions": [
CreateOrganisation_Subscription_Input
],
"defaultFieldMapping": "abc123",
"technicalData": CreateOrganisation_TechnicalData_Input,
"adminUser": CreateOrganisation_adminUsesr_Input
}
CreateOrganisationPayload
Fields
| Field Name | Description |
|---|---|
organisation - CreateOrganisation_Organisation_Payload
|
Example
{"organisation": CreateOrganisation_Organisation_Payload}
CreateOrganisation_Address_Input
Example
{
"addressLine1": "abc123",
"addressLine2": "xyz789",
"addressLine3": "xyz789",
"city": "abc123",
"county": "abc123",
"country": "xyz789",
"postcode": "xyz789"
}
CreateOrganisation_Address_Payload
Example
{
"addressLine1": "abc123",
"addressLine2": "xyz789",
"addressLine3": "xyz789",
"city": "xyz789",
"county": "abc123",
"country": "abc123",
"postcode": "abc123"
}
CreateOrganisation_ContractDetails_Input
Example
{
"startDate": 1592577642,
"endDate": 1592577642,
"commissionDate": 1592577642,
"billingFrequency": 987,
"commissionPercentage": 123,
"plan": "xyz789"
}
CreateOrganisation_ContractDetails_Payload
Example
{
"startDate": 1592577642,
"endDate": 1592577642,
"commissionDate": 1592577642,
"billingFrequency": 123,
"commissionPercentage": 123,
"plan": "xyz789"
}
CreateOrganisation_Organisation_Payload
Fields
| Field Name | Description |
|---|---|
id - ObjectID!
|
|
name - String!
|
|
keyName - String!
|
|
wesoarDomain - String!
|
|
organisationGroup - String
|
|
contactPerson - CreateOrganisation_Person_Payload
|
|
registeredAddress - CreateOrganisation_Address_Payload
|
|
website - String
|
|
profilePicUrl - String
|
|
organisationSize - String
|
|
organisationIndustry - String
|
|
organisationType - String
|
|
organisationStatus - String
|
|
yearOfEstablishment - Int
|
|
totalRevenue - Int
|
|
objectives - String
|
|
activationCode - String
|
|
contractDetails - [CreateOrganisation_ContractDetails_Payload]
|
|
subscriptions - [CreateOrganisation_Subscription_Payload]
|
|
defaultFieldMapping - String
|
|
technicalData - CreateOrganisation_TechnicalData_Payload
|
Example
{
"id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"wesoarDomain": "abc123",
"organisationGroup": "xyz789",
"contactPerson": CreateOrganisation_Person_Payload,
"registeredAddress": CreateOrganisation_Address_Payload,
"website": "xyz789",
"profilePicUrl": "xyz789",
"organisationSize": "abc123",
"organisationIndustry": "abc123",
"organisationType": "xyz789",
"organisationStatus": "abc123",
"yearOfEstablishment": 123,
"totalRevenue": 123,
"objectives": "abc123",
"activationCode": "abc123",
"contractDetails": [
CreateOrganisation_ContractDetails_Payload
],
"subscriptions": [
CreateOrganisation_Subscription_Payload
],
"defaultFieldMapping": "abc123",
"technicalData": CreateOrganisation_TechnicalData_Payload
}
CreateOrganisation_Person_Input
Example
{
"title": "abc123",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"designation": "abc123",
"contactNumber": "abc123",
"mobileNumber": "abc123",
"email": "xyz789"
}
CreateOrganisation_Person_Payload
Example
{
"title": "xyz789",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"designation": "abc123",
"contactNumber": "xyz789",
"mobileNumber": "xyz789",
"email": "abc123"
}
CreateOrganisation_Subscription_Input
CreateOrganisation_Subscription_Payload
CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Input
CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Payload
CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_Input
Fields
| Input Field | Description |
|---|---|
apiVersion - String
|
|
region - String
|
|
userPoolId - String
|
|
cognitoClient - [CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Input]
|
Example
{
"apiVersion": "xyz789",
"region": "xyz789",
"userPoolId": "abc123",
"cognitoClient": [
CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Input
]
}
CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_Payload
Fields
| Field Name | Description |
|---|---|
apiVersion - String
|
|
region - String
|
|
userPoolId - String
|
|
cognitoClient - [CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Payload]
|
Example
{
"apiVersion": "xyz789",
"region": "abc123",
"userPoolId": "xyz789",
"cognitoClient": [
CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Payload
]
}
CreateOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Input
CreateOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Payload
CreateOrganisation_TechnicalData_AWSConfig_Input
Fields
| Input Field | Description |
|---|---|
developerConfig - CreateOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Input
|
|
cognitoConfig - CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_Input
|
Example
{
"developerConfig": CreateOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Input,
"cognitoConfig": CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_Input
}
CreateOrganisation_TechnicalData_AWSConfig_Payload
Fields
| Field Name | Description |
|---|---|
developerConfig - CreateOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Payload
|
|
cognitoConfig - CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_Payload
|
Example
{
"developerConfig": CreateOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Payload,
"cognitoConfig": CreateOrganisation_TechnicalData_AWSConfig_CognitoConfig_Payload
}
CreateOrganisation_TechnicalData_DBConfig_Input
CreateOrganisation_TechnicalData_DBConfig_Payload
CreateOrganisation_TechnicalData_Input
Fields
| Input Field | Description |
|---|---|
dbConfig - CreateOrganisation_TechnicalData_DBConfig_Input
|
|
sendGridConfig - CreateOrganisation_TechnicalData_SendGridConfig_Input
|
|
awsConfig - CreateOrganisation_TechnicalData_AWSConfig_Input
|
Example
{
"dbConfig": CreateOrganisation_TechnicalData_DBConfig_Input,
"sendGridConfig": CreateOrganisation_TechnicalData_SendGridConfig_Input,
"awsConfig": CreateOrganisation_TechnicalData_AWSConfig_Input
}
CreateOrganisation_TechnicalData_Payload
Fields
| Field Name | Description |
|---|---|
dbConfiguration - CreateOrganisation_TechnicalData_DBConfig_Payload
|
|
sendGridConfiguration - CreateOrganisation_TechnicalData_SendGridConfig_Payload
|
|
awsConfiguration - CreateOrganisation_TechnicalData_AWSConfig_Payload
|
Example
{
"dbConfiguration": CreateOrganisation_TechnicalData_DBConfig_Payload,
"sendGridConfiguration": CreateOrganisation_TechnicalData_SendGridConfig_Payload,
"awsConfiguration": CreateOrganisation_TechnicalData_AWSConfig_Payload
}
CreateOrganisation_TechnicalData_SendGridConfig_Input
Fields
| Input Field | Description |
|---|---|
apiKey - String
|
Example
{"apiKey": "xyz789"}
CreateOrganisation_TechnicalData_SendGridConfig_Payload
Fields
| Field Name | Description |
|---|---|
apiKey - String
|
Example
{"apiKey": "xyz789"}
CreateOrganisation_adminUsesr_Input
Example
{
"userName": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"empCode": "abc123",
"email": "xyz789",
"mobileNumber": "xyz789",
"isEmailVerified": false,
"isMobileNumberVerified": true
}
CreatePlannedTaskOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreatePlannedTaskParams
Fields
| Input Field | Description |
|---|---|
plannedTask - PlannedTask_Input
|
|
assignedToUserId - ObjectID
|
Example
{
"plannedTask": PlannedTask_Input,
"assignedToUserId": "5e5677d71bdc2ae76344968c"
}
CreateProgramOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateProgramParams
Fields
| Input Field | Description |
|---|---|
program - Program_Input
|
Example
{"program": Program_Input}
CreateProgramTypeOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateProgramTypeParams
Fields
| Input Field | Description |
|---|---|
programType - ProgramType_Input
|
Example
{"programType": ProgramType_Input}
CreateReportOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateReportParams
Fields
| Input Field | Description |
|---|---|
report - Report_Input
|
Example
{"report": Report_Input}
CreateSuperOrganisationOptions
Fields
| Input Field | Description |
|---|---|
isCreateDefaultRoles - Boolean
|
Example
{"isCreateDefaultRoles": false}
CreateSuperOrganisationParams
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
keyName - String!
|
|
wesoarDomain - String!
|
|
organisationGroup - String
|
|
contactPerson - CreateSuperOrganisation_Person_Input
|
|
registeredAddress - CreateSuperOrganisation_Address_Input
|
|
website - String
|
|
profilePicUrl - String
|
|
organisationSize - String
|
|
organisationIndustry - String
|
|
organisationType - String
|
|
organisationStatus - String
|
|
yearOfEstablishment - Int
|
|
totalRevenue - Int
|
|
objectives - String
|
|
activationCode - String
|
|
contractDetails - [CreateSuperOrganisation_ContractDetails_Input]
|
|
subscriptions - [CreateSuperOrganisation_Subscription_Input]
|
|
defaultFieldMapping - String
|
|
technicalData - CreateSuperOrganisation_TechnicalData_Input
|
Example
{
"name": "abc123",
"keyName": "abc123",
"wesoarDomain": "xyz789",
"organisationGroup": "xyz789",
"contactPerson": CreateSuperOrganisation_Person_Input,
"registeredAddress": CreateSuperOrganisation_Address_Input,
"website": "abc123",
"profilePicUrl": "xyz789",
"organisationSize": "xyz789",
"organisationIndustry": "xyz789",
"organisationType": "abc123",
"organisationStatus": "abc123",
"yearOfEstablishment": 123,
"totalRevenue": 987,
"objectives": "xyz789",
"activationCode": "abc123",
"contractDetails": [
CreateSuperOrganisation_ContractDetails_Input
],
"subscriptions": [
CreateSuperOrganisation_Subscription_Input
],
"defaultFieldMapping": "abc123",
"technicalData": CreateSuperOrganisation_TechnicalData_Input
}
CreateSuperOrganisationPayload
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
keyName - String!
|
|
wesoarDomain - String!
|
|
organisationGroup - String
|
|
contactPerson - CreateSuperOrganisation_Person_Payload
|
|
registeredAddress - CreateSuperOrganisation_Address_Payload
|
|
website - String
|
|
profilePicUrl - String
|
|
organisationSize - String
|
|
organisationIndustry - String
|
|
organisationType - String
|
|
organisationStatus - String
|
|
yearOfEstablishment - Int
|
|
totalRevenue - Int
|
|
objectives - String
|
|
activationCode - String
|
|
contractDetails - [CreateSuperOrganisation_ContractDetails_Payload]
|
|
subscriptions - [CreateSuperOrganisation_Subscription_Payload]
|
|
defaultFieldMapping - String
|
|
technicalData - CreateSuperOrganisation_TechnicalData_Payload
|
Example
{
"id": "4",
"name": "xyz789",
"keyName": "abc123",
"wesoarDomain": "abc123",
"organisationGroup": "xyz789",
"contactPerson": CreateSuperOrganisation_Person_Payload,
"registeredAddress": CreateSuperOrganisation_Address_Payload,
"website": "abc123",
"profilePicUrl": "xyz789",
"organisationSize": "abc123",
"organisationIndustry": "abc123",
"organisationType": "xyz789",
"organisationStatus": "abc123",
"yearOfEstablishment": 987,
"totalRevenue": 123,
"objectives": "abc123",
"activationCode": "xyz789",
"contractDetails": [
CreateSuperOrganisation_ContractDetails_Payload
],
"subscriptions": [
CreateSuperOrganisation_Subscription_Payload
],
"defaultFieldMapping": "xyz789",
"technicalData": CreateSuperOrganisation_TechnicalData_Payload
}
CreateSuperOrganisation_Address_Input
Example
{
"addressLine1": "xyz789",
"addressLine2": "abc123",
"addressLine3": "abc123",
"city": "abc123",
"county": "abc123",
"country": "abc123",
"postcode": "xyz789"
}
CreateSuperOrganisation_Address_Payload
Example
{
"addressLine1": "xyz789",
"addressLine2": "abc123",
"addressLine3": "xyz789",
"city": "abc123",
"county": "abc123",
"country": "abc123",
"postcode": "xyz789"
}
CreateSuperOrganisation_ContractDetails_Input
Example
{
"startDate": 1592577642,
"endDate": 1592577642,
"commissionDate": 1592577642,
"billingFrequency": 123,
"commissionPercentage": 987,
"plan": "abc123"
}
CreateSuperOrganisation_ContractDetails_Payload
Example
{
"startDate": 1592577642,
"endDate": 1592577642,
"commissionDate": 1592577642,
"billingFrequency": 987,
"commissionPercentage": 123,
"plan": "xyz789"
}
CreateSuperOrganisation_Person_Input
Example
{
"title": "xyz789",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"designation": "abc123",
"contactNumber": "xyz789",
"mobileNumber": "abc123",
"email": "abc123"
}
CreateSuperOrganisation_Person_Payload
Example
{
"title": "xyz789",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "abc123",
"designation": "abc123",
"contactNumber": "xyz789",
"mobileNumber": "abc123",
"email": "xyz789"
}
CreateSuperOrganisation_Subscription_Input
CreateSuperOrganisation_Subscription_Payload
CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Input
CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Payload
CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_Input
Fields
| Input Field | Description |
|---|---|
apiVersion - String
|
|
region - String
|
|
userPoolId - String
|
|
cognitoClient - [CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Input]
|
Example
{
"apiVersion": "xyz789",
"region": "xyz789",
"userPoolId": "xyz789",
"cognitoClient": [
CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Input
]
}
CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_Payload
Fields
| Field Name | Description |
|---|---|
apiVersion - String
|
|
region - String
|
|
userPoolId - String
|
|
cognitoClient - [CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Payload]
|
Example
{
"apiVersion": "abc123",
"region": "abc123",
"userPoolId": "abc123",
"cognitoClient": [
CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient_Payload
]
}
CreateSuperOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Input
CreateSuperOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Payload
CreateSuperOrganisation_TechnicalData_AWSConfig_Input
Fields
| Input Field | Description |
|---|---|
developerConfig - CreateSuperOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Input
|
|
cognitoConfig - CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_Input
|
Example
{
"developerConfig": CreateSuperOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Input,
"cognitoConfig": CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_Input
}
CreateSuperOrganisation_TechnicalData_AWSConfig_Payload
Fields
| Field Name | Description |
|---|---|
developerConfig - CreateSuperOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Payload
|
|
cognitoConfig - CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_Payload
|
Example
{
"developerConfig": CreateSuperOrganisation_TechnicalData_AWSConfig_DeveloperConfig_Payload,
"cognitoConfig": CreateSuperOrganisation_TechnicalData_AWSConfig_CognitoConfig_Payload
}
CreateSuperOrganisation_TechnicalData_DBConfig_Input
CreateSuperOrganisation_TechnicalData_DBConfig_Payload
CreateSuperOrganisation_TechnicalData_Input
Fields
| Input Field | Description |
|---|---|
dbConfiguration - CreateSuperOrganisation_TechnicalData_DBConfig_Input
|
|
sendGridConfiguration - CreateSuperOrganisation_TechnicalData_SendGridConfig_Input
|
|
awsConfiguration - CreateSuperOrganisation_TechnicalData_AWSConfig_Input
|
Example
{
"dbConfiguration": CreateSuperOrganisation_TechnicalData_DBConfig_Input,
"sendGridConfiguration": CreateSuperOrganisation_TechnicalData_SendGridConfig_Input,
"awsConfiguration": CreateSuperOrganisation_TechnicalData_AWSConfig_Input
}
CreateSuperOrganisation_TechnicalData_Payload
Fields
| Field Name | Description |
|---|---|
dbConfiguration - CreateSuperOrganisation_TechnicalData_DBConfig_Payload
|
|
sendGridConfiguration - CreateSuperOrganisation_TechnicalData_SendGridConfig_Payload
|
|
awsConfiguration - CreateSuperOrganisation_TechnicalData_AWSConfig_Payload
|
Example
{
"dbConfiguration": CreateSuperOrganisation_TechnicalData_DBConfig_Payload,
"sendGridConfiguration": CreateSuperOrganisation_TechnicalData_SendGridConfig_Payload,
"awsConfiguration": CreateSuperOrganisation_TechnicalData_AWSConfig_Payload
}
CreateSuperOrganisation_TechnicalData_SendGridConfig_Input
CreateSuperOrganisation_TechnicalData_SendGridConfig_Payload
CreateSurveyAnswerCategoryOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateSurveyAnswerCategoryParams
Fields
| Input Field | Description |
|---|---|
surveyAnswerCategory - SurveyAnswerCategory_Input
|
Example
{"surveyAnswerCategory": SurveyAnswerCategory_Input}
CreateSurveyQuestionFactorOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateSurveyQuestionFactorParams
Fields
| Input Field | Description |
|---|---|
surveyQuestionFactor - SurveyQuestionFactor_Input
|
Example
{"surveyQuestionFactor": SurveyQuestionFactor_Input}
CreateSurveyQuestionOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateSurveyQuestionParams
Fields
| Input Field | Description |
|---|---|
surveyQuestion - SurveyQuestion_Input
|
Example
{"surveyQuestion": SurveyQuestion_Input}
CreateSurveyResponseOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateSurveyResponseParams
Fields
| Input Field | Description |
|---|---|
surveyResponse - SurveyResponse_Input
|
Example
{"surveyResponse": SurveyResponse_Input}
CreateSurveySpecimenOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateSurveySpecimenParams
Fields
| Input Field | Description |
|---|---|
surveySpecimen - SurveySpecimen_Input
|
Example
{"surveySpecimen": SurveySpecimen_Input}
CreateTermProgramOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateTermProgramParams
Fields
| Input Field | Description |
|---|---|
termProgram - TermProgram_Input
|
Example
{"termProgram": TermProgram_Input}
CreateUnplannedTaskOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateUnplannedTaskParams
Fields
| Input Field | Description |
|---|---|
unplannedTask - UnplannedTask_Input
|
|
assignedToUserId - ObjectID
|
Example
{
"unplannedTask": UnplannedTask_Input,
"assignedToUserId": "5e5677d71bdc2ae76344968c"
}
CreateUserOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
CreateUserParams
Example
{
"userName": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"empCode": "abc123",
"email": "abc123",
"mobileNumber": "xyz789",
"isEmailVerified": true,
"isMobileNumberVerified": false,
"roles": ["abc123"]
}
CreateYearOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
CreateYearParams
Fields
| Input Field | Description |
|---|---|
year - Year_Input
|
Example
{"year": Year_Input}
DeleteAlarmsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteAlarmsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteAlarmsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteAppraisalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteAppraisalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteAppraisalsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteAttendancesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteAttendancesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteAttendancesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteCheckInsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteCheckInsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteCheckInsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteCommentParams
Fields
| Input Field | Description |
|---|---|
commentId - ObjectID
|
Example
{"commentId": "5e5677d71bdc2ae76344968c"}
DeleteCommunicationEventsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteCommunicationEventsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteCommunicationEventsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteCommunityGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteCommunityGoalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteCommunityGoalsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteConversationMetasOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteConversationMetasParams
Fields
| Input Field | Description |
|---|---|
conversationId - ObjectID
|
|
metas - [ObjectID]
|
Example
{
"conversationId": "5e5677d71bdc2ae76344968c",
"metas": ["5e5677d71bdc2ae76344968c"]
}
DeleteConversationSubscribersOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteConversationSubscribersParams
Fields
| Input Field | Description |
|---|---|
conversationId - ObjectID
|
|
userIds - [ObjectID]
|
Example
{
"conversationId": "5e5677d71bdc2ae76344968c",
"userIds": ["5e5677d71bdc2ae76344968c"]
}
DeleteConversationsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteConversationsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteConversationsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteGoalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteGoalsPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 987}
DeleteLanguagesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteLanguagesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteLanguagesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteMasterOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteMasterParams
Fields
| Input Field | Description |
|---|---|
_id - [ObjectID!]!
|
Example
{"_id": ["5e5677d71bdc2ae76344968c"]}
DeleteMasterPayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": true}
DeleteMessageParams
Fields
| Input Field | Description |
|---|---|
messageId - ObjectID
|
Example
{"messageId": "5e5677d71bdc2ae76344968c"}
DeleteModuleCategoriesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteModuleCategoriesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteModuleCategoriesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteModulesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteModulesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteModulesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteNotificationsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteNotificationsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteNotificationsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteOrgUnitsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteOrgUnitsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteOrgUnitsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeletePlannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeletePlannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeletePlannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteProgramTypesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteProgramTypesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteProgramTypesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteProgramsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteProgramsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteProgramsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteReportsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteReportsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteReportsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteSurveyAnswerCategoriesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteSurveyAnswerCategoriesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteSurveyAnswerCategoriesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteSurveyQuestionFactorsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteSurveyQuestionFactorsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteSurveyQuestionFactorsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteSurveyQuestionsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteSurveyQuestionsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteSurveyQuestionsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteSurveyResponsesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteSurveyResponsesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteSurveyResponsesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteSurveySpecimensOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
DeleteSurveySpecimensParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteSurveySpecimensPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteTermProgramsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteTermProgramsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteTermProgramsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DeleteUnplannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteUnplannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteUnplannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
DeleteYearsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
DeleteYearsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
DeleteYearsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
DisableMfaPayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": false}
Duration
Example
"P3Y6M4DT12H30M5S"
EnableMfaPayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": true}
EngReport
Fields
| Field Name | Description |
|---|---|
programId - ObjectID
|
|
userManagerId - ObjectID
|
|
reportType - String
|
|
grpFld - String
|
|
medal - Medal
|
|
scoreOverall - Float
|
|
countQuestions - Int
|
|
countRespondents - Int
|
|
surveyQuestionFactors - [SurveyQuestionFactor]
|
|
surveyQuestionFactorsPage - SurveyQuestionFactorsPage
|
|
Arguments
|
|
surveyQuestionsPage - SurveyQuestionsPage
|
|
Arguments
|
|
averageTimeTaken - Float
|
|
surveyAnswerCategories - [SurveyAnswerCategory]
|
|
surveyAnswerCompositions - [SurveyAnswerCategory]
|
|
countInvitationsSent - Int
|
|
percentageParticipation - Float
|
|
teamHighestSurveyQuestionFactor - SurveyQuestionFactor
|
|
overallHighestFactor - SurveyQuestionFactor
|
|
wordCloudWords - [WordCloudWord]
|
|
sentiments - [Sentiment]
|
|
Example
{
"programId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c",
"reportType": "abc123",
"grpFld": "xyz789",
"medal": Medal,
"scoreOverall": 987.65,
"countQuestions": 123,
"countRespondents": 987,
"surveyQuestionFactors": [SurveyQuestionFactor],
"surveyQuestionFactorsPage": SurveyQuestionFactorsPage,
"surveyQuestionsPage": SurveyQuestionsPage,
"averageTimeTaken": 987.65,
"surveyAnswerCategories": [SurveyAnswerCategory],
"surveyAnswerCompositions": [SurveyAnswerCategory],
"countInvitationsSent": 123,
"percentageParticipation": 123.45,
"teamHighestSurveyQuestionFactor": SurveyQuestionFactor,
"overallHighestFactor": SurveyQuestionFactor,
"wordCloudWords": [WordCloudWord],
"sentiments": [Sentiment]
}
Fact
Fields
| Field Name | Description |
|---|---|
key - String
|
|
values - [JSONObject]
|
Example
{"key": "xyz789", "values": [{}]}
FactOptions
Fields
| Input Field | Description |
|---|---|
facts - [String]
|
Example
{"facts": ["xyz789"]}
File
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"fileName": "abc123",
"fileKeyName": "xyz789",
"contentType": "xyz789",
"fileDate": 1592577642,
"fileUrl": "abc123",
"fileSize": 987.65
}
FileUploadUrlPayload
Fields
| Field Name | Description |
|---|---|
uploadUrl - String
|
|
fileKeyName - String
|
|
uploadFields - [uploadField]
|
Example
{
"uploadUrl": "abc123",
"fileKeyName": "abc123",
"uploadFields": [uploadField]
}
File_Input
FilesPage
FilterOption
Fields
| Field Name | Description |
|---|---|
filterOptionName - FilterOptionName
|
|
filterOptionValues - [String]
|
|
Arguments
|
|
Example
{
"filterOptionName": FilterOptionName,
"filterOptionValues": ["abc123"]
}
FilterOptionName
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FollowUp
ForgotPasswordOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
ForgotPasswordParams
Fields
| Input Field | Description |
|---|---|
userName - String
|
Example
{"userName": "xyz789"}
ForgotPasswordPayload
Fields
| Field Name | Description |
|---|---|
codeDeliveryDetails - CodeDeliveryDetails
|
Example
{"codeDeliveryDetails": CodeDeliveryDetails}
GetFileUploadUrlOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
GetFileUploadUrlParams
GetLoginFromRefreshTokenParams
GetLoginFromRefreshTokenPayload
Fields
| Field Name | Description |
|---|---|
tokens - Tokens
|
Example
{"tokens": Tokens}
Goal
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
yearId - ObjectID
|
|
programId - ObjectID
|
|
termProgramId - ObjectID
|
|
assignedToUserId - ObjectID
|
|
assignedByUserId - ObjectID
|
|
approvedByUserId - ObjectID
|
|
trashedByUserId - ObjectID
|
|
assignedDate - Timestamp
|
|
updatedDate - Timestamp
|
|
submittedDate - Timestamp
|
|
approvedDate - Timestamp
|
|
trashedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
hash - String
|
|
goalType - String
|
|
parentGoalId - ObjectID
|
|
conversationId - String
|
|
goalDetail - GoalDetail
|
|
comments - [Comment]
|
|
obstacles - [Comment]
|
|
checkInComments - [Comment]
|
|
appraisalComments - [Comment]
|
|
views - Int
|
|
communityGoalId - ObjectID
|
|
trackingStatus - String
|
|
achievement - String
|
|
goalProgress - Int
|
|
priority - Int
|
|
isActive - Boolean
|
|
isShowInPlannedTask - Boolean
|
|
isShowInUnplannedTask - Boolean
|
|
year - Year
|
|
program - Program
|
|
termProgram - TermProgram
|
|
assignedToUser - User
|
|
assignedByUser - User
|
|
approvedByUser - User
|
|
trashedByUser - User
|
|
communityGoal - CommunityGoal
|
|
parentGoal - Goal
|
|
latestCompletedCheckIn - CheckIn
|
_id: ObjectID! yearId: ObjectID programId: ObjectID termProgramId: ObjectID hash: String assignedDate: Timestamp updatedDate: Timestamp submittedDate: Timestamp approvedDate: Timestamp trashedDate: Timestamp deletedDate: Timestamp goalType: String comments: [Comment] obstacles: [Comment] checkInComments: [Comment] appraisalComments: [Comment] goalDetail: GoalDetail views: Int communityGoalId: ObjectID trackingStatus: String goalProgress: Float achievement: String priority: Int isActive: Boolean isDeleted: Boolean |
latestCompletedGoalCheckIn - GoalCheckIn
|
|
goalCheckIns - [GoalCheckIn]
|
|
goalAppraisals - [GoalAppraisal]
|
|
commentsPage - CommentsPage
|
|
Arguments |
|
comment - Comment
|
|
Arguments
|
|
obstaclesPage - CommentsPage
|
|
Arguments
|
|
obstacle - Comment
|
|
Arguments
|
|
checkInCommentsPage - CommentsPage
|
|
Arguments
|
|
checkInComment - Comment
|
|
Arguments
|
|
appraisalCommentsPage - CommentsPage
|
|
Arguments
|
|
appraisalComment - Comment
|
|
Arguments
|
|
goalCheckInsPage - GoalCheckInsPage
|
|
Arguments
|
|
goalCheckIn - GoalCheckIn
|
|
Arguments
|
|
goalAppraisalsPage - GoalAppraisalsPage
|
|
Arguments
|
|
goalAppraisal - GoalAppraisal
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"assignedByUserId": "5e5677d71bdc2ae76344968c",
"approvedByUserId": "5e5677d71bdc2ae76344968c",
"trashedByUserId": "5e5677d71bdc2ae76344968c",
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"hash": "xyz789",
"goalType": "abc123",
"parentGoalId": "5e5677d71bdc2ae76344968c",
"conversationId": "abc123",
"goalDetail": GoalDetail,
"comments": [Comment],
"obstacles": [Comment],
"checkInComments": [Comment],
"appraisalComments": [Comment],
"views": 123,
"communityGoalId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "xyz789",
"achievement": "abc123",
"goalProgress": 987,
"priority": 987,
"isActive": true,
"isShowInPlannedTask": false,
"isShowInUnplannedTask": false,
"year": Year,
"program": Program,
"termProgram": TermProgram,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"communityGoal": CommunityGoal,
"parentGoal": Goal,
"latestCompletedCheckIn": CheckIn,
"latestCompletedGoalCheckIn": GoalCheckIn,
"goalCheckIns": [GoalCheckIn],
"goalAppraisals": [GoalAppraisal],
"commentsPage": CommentsPage,
"comment": Comment,
"obstaclesPage": CommentsPage,
"obstacle": Comment,
"checkInCommentsPage": CommentsPage,
"checkInComment": Comment,
"appraisalCommentsPage": CommentsPage,
"appraisalComment": Comment,
"goalCheckInsPage": GoalCheckInsPage,
"goalCheckIn": GoalCheckIn,
"goalAppraisalsPage": GoalAppraisalsPage,
"goalAppraisal": GoalAppraisal
}
GoalAppraisal
Fields
| Field Name | Description |
|---|---|
_id - ID
|
|
appraisalId - ID
|
|
relevance - CheckInRelevance
|
|
progress - CheckInProgress
|
|
appraisalRatingOnGoal - AppraisalRating
|
Example
{
"_id": 4,
"appraisalId": 4,
"relevance": CheckInRelevance,
"progress": CheckInProgress,
"appraisalRatingOnGoal": AppraisalRating
}
GoalAppraisal_Input
Description
input MileStone_Input { what: String when: Timestamp whoseUserIds: [ObjectID] }
input GoalDetail_Input { goalCategoryId: ObjectID description: String weightage: Int target: String dueBy: Timestamp milestones: [MileStone_Input] taggedUserIds: [ObjectID] }
input Goal_Input { yearId: ObjectID termProgramId: ObjectID programId: ObjectID communityGoalId: ObjectID goalDetail: GoalDetail_Input hash: String comments:[Comment_Input] }
Fields
| Input Field | Description |
|---|---|
appraisalId - ObjectID
|
|
relevance - CheckInRelevance_Input
|
|
progress - CheckInProgress_Input
|
|
appraisalRatingOnGoal - AppraisalRating_Input
|
Example
{
"appraisalId": "5e5677d71bdc2ae76344968c",
"relevance": CheckInRelevance_Input,
"progress": CheckInProgress_Input,
"appraisalRatingOnGoal": AppraisalRating_Input
}
GoalAppraisalsPage
Fields
| Field Name | Description |
|---|---|
docs - [GoalAppraisal]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [GoalAppraisal],
"pageInfo": PageInfo
}
GoalCategoriesPage
Fields
| Field Name | Description |
|---|---|
docs - [GoalCategory!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [GoalCategory],
"pageInfo": PageInfo
}
GoalCategory
GoalCheckIn
Fields
| Field Name | Description |
|---|---|
_id - ID
|
|
checkInId - ID
|
|
relevance - CheckInRelevance
|
|
progress - CheckInProgress
|
Example
{
"_id": 4,
"checkInId": "4",
"relevance": CheckInRelevance,
"progress": CheckInProgress
}
GoalCheckIn_Input
Fields
| Input Field | Description |
|---|---|
checkInId - ObjectID
|
|
relevance - CheckInRelevance_Input
|
|
progress - CheckInProgress_Input
|
Example
{
"checkInId": "5e5677d71bdc2ae76344968c",
"relevance": CheckInRelevance_Input,
"progress": CheckInProgress_Input
}
GoalCheckInsPage
Fields
| Field Name | Description |
|---|---|
docs - [GoalCheckIn]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [GoalCheckIn],
"pageInfo": PageInfo
}
GoalDetail
Fields
| Field Name | Description |
|---|---|
isQuantitative - Boolean
|
|
goalCategoryId - ObjectID
|
|
description - String
|
|
hash - String
|
|
weightage - Float
|
|
targetFrequency - String
|
|
targetUnit - String
|
|
target - String
|
|
quantitativeTarget - Float
|
|
dueBy - Timestamp
|
|
taggedUserIds - [ObjectID]
|
|
milestones - [MileStone]
|
|
keyNotes - [KeyNote]
|
|
tags - [String]
|
|
cascadedGoals - [CascadedGoal]
|
|
goalCategory - GoalCategory
|
|
taggedUsers - [User]
|
Example
{
"isQuantitative": true,
"goalCategoryId": "5e5677d71bdc2ae76344968c",
"description": "xyz789",
"hash": "xyz789",
"weightage": 123.45,
"targetFrequency": "abc123",
"targetUnit": "abc123",
"target": "xyz789",
"quantitativeTarget": 123.45,
"dueBy": 1592577642,
"taggedUserIds": [
"5e5677d71bdc2ae76344968c"
],
"milestones": [MileStone],
"keyNotes": [KeyNote],
"tags": ["xyz789"],
"cascadedGoals": [CascadedGoal],
"goalCategory": GoalCategory,
"taggedUsers": [User]
}
GoalDetail_Input
Fields
| Input Field | Description |
|---|---|
isQuantitative - Boolean
|
|
goalCategoryId - ObjectID
|
|
description - String
|
|
hash - String
|
|
weightage - Float
|
|
targetFrequency - String
|
|
targetUnit - String
|
|
target - String
|
|
quantitativeTarget - Float
|
|
dueBy - Timestamp
|
|
taggedUserIds - [ObjectID]
|
|
milestones - [MileStone_Input]
|
|
keyNotes - [KeyNote_Input]
|
|
tags - [String]
|
|
cascadedGoals - [CascadedGoal_Input]
|
Example
{
"isQuantitative": false,
"goalCategoryId": "5e5677d71bdc2ae76344968c",
"description": "abc123",
"hash": "abc123",
"weightage": 987.65,
"targetFrequency": "abc123",
"targetUnit": "abc123",
"target": "abc123",
"quantitativeTarget": 987.65,
"dueBy": 1592577642,
"taggedUserIds": [
"5e5677d71bdc2ae76344968c"
],
"milestones": [MileStone_Input],
"keyNotes": [KeyNote_Input],
"tags": ["xyz789"],
"cascadedGoals": [CascadedGoal_Input]
}
GoalSetting
Fields
| Field Name | Description |
|---|---|
isEnableGoal - Boolean
|
|
goalParam - String
|
|
isEnableCheckIn - Boolean
|
|
checkInParam - String
|
|
isEnableAppraisal - Boolean
|
|
appraisalParam - String
|
|
isShowGoalCategory - Boolean
|
|
isShowWeightage - Boolean
|
|
isShowQuantitativeTarget - Boolean
|
|
isShowQualitativeTarget - Boolean
|
|
isShowCascade - Boolean
|
|
isShowTagging - Boolean
|
|
isShowKeyNotes - Boolean
|
|
isMandatoryGoalTarget - Boolean
|
|
targetUnits - [String]
|
|
isShowSelfProgress - Boolean
|
|
isShowPeerProgress - Boolean
|
|
isShowIndirectProgress - Boolean
|
|
isShowDirectProgress - Boolean
|
|
isShowTaggedProgress - Boolean
|
|
isShowGoalTitle - Boolean
|
|
isShowGoalObstacles - Boolean
|
|
isShowGoalDependencies - Boolean
|
|
isEnableVision - Boolean
|
|
isEnableValues - Boolean
|
|
isEnableObstacles - Boolean
|
|
isEnableRecognition - Boolean
|
|
isEnableFeedback - Boolean
|
|
isEnableReports - Boolean
|
|
isShowMilestones - Boolean
|
|
isCanEscalate - Boolean
|
|
communityGoalIds - [ObjectID]
|
|
checkInSetting - CheckInSetting
|
|
params - JSONObject
|
|
communityGoals - [CommunityGoal]
|
Example
{
"isEnableGoal": false,
"goalParam": "abc123",
"isEnableCheckIn": false,
"checkInParam": "abc123",
"isEnableAppraisal": false,
"appraisalParam": "abc123",
"isShowGoalCategory": true,
"isShowWeightage": false,
"isShowQuantitativeTarget": true,
"isShowQualitativeTarget": true,
"isShowCascade": false,
"isShowTagging": true,
"isShowKeyNotes": false,
"isMandatoryGoalTarget": false,
"targetUnits": ["xyz789"],
"isShowSelfProgress": true,
"isShowPeerProgress": false,
"isShowIndirectProgress": true,
"isShowDirectProgress": false,
"isShowTaggedProgress": false,
"isShowGoalTitle": true,
"isShowGoalObstacles": false,
"isShowGoalDependencies": true,
"isEnableVision": true,
"isEnableValues": false,
"isEnableObstacles": true,
"isEnableRecognition": false,
"isEnableFeedback": true,
"isEnableReports": true,
"isShowMilestones": true,
"isCanEscalate": false,
"communityGoalIds": [
"5e5677d71bdc2ae76344968c"
],
"checkInSetting": CheckInSetting,
"params": {},
"communityGoals": [CommunityGoal]
}
GoalSetting_Input
Fields
| Input Field | Description |
|---|---|
isEnableGoal - Boolean
|
|
goalParam - String
|
|
isEnableCheckIn - Boolean
|
|
checkInParam - String
|
|
isEnableAppraisal - Boolean
|
|
appraisalParam - String
|
|
isShowGoalCategory - Boolean
|
|
isShowWeightage - Boolean
|
|
isShowQuantitativeTarget - Boolean
|
|
isShowQualitativeTarget - Boolean
|
|
isShowCascade - Boolean
|
|
isShowTagging - Boolean
|
|
isShowKeyNotes - Boolean
|
|
isMandatoryGoalTarget - Boolean
|
|
targetUnits - [String]
|
|
isShowSelfProgress - Boolean
|
|
isShowPeerProgress - Boolean
|
|
isShowIndirectProgress - Boolean
|
|
isShowDirectProgress - Boolean
|
|
isShowTaggedProgress - Boolean
|
|
isShowGoalTitle - Boolean
|
|
isShowGoalObstacles - Boolean
|
|
isShowGoalDependencies - Boolean
|
|
isEnableVision - Boolean
|
|
isEnableValues - Boolean
|
|
isCanEscalate - Boolean
|
|
communityGoalIds - [ObjectID]
|
|
checkInSetting - CheckInSetting_Input
|
|
params - JSONObject
|
Example
{
"isEnableGoal": true,
"goalParam": "abc123",
"isEnableCheckIn": true,
"checkInParam": "xyz789",
"isEnableAppraisal": false,
"appraisalParam": "abc123",
"isShowGoalCategory": true,
"isShowWeightage": false,
"isShowQuantitativeTarget": false,
"isShowQualitativeTarget": false,
"isShowCascade": false,
"isShowTagging": false,
"isShowKeyNotes": false,
"isMandatoryGoalTarget": true,
"targetUnits": ["xyz789"],
"isShowSelfProgress": true,
"isShowPeerProgress": true,
"isShowIndirectProgress": true,
"isShowDirectProgress": false,
"isShowTaggedProgress": false,
"isShowGoalTitle": true,
"isShowGoalObstacles": false,
"isShowGoalDependencies": true,
"isEnableVision": true,
"isEnableValues": false,
"isCanEscalate": false,
"communityGoalIds": [
"5e5677d71bdc2ae76344968c"
],
"checkInSetting": CheckInSetting_Input,
"params": {}
}
Goal_Input
Example
{
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"assignedToUserId": "5e5677d71bdc2ae76344968c",
"hash": "abc123",
"goalDetail": GoalDetail_Input
}
GoalsPage
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
"4"
ImpactStage
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"color": "xyz789",
"eisenhowerQuadrants": "xyz789",
"isHigh": true,
"isMedium": true,
"isLow": false,
"priority": 987,
"isActive": true,
"isDeleted": true
}
ImpactStage_Input
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"color": "xyz789",
"eisenhowerQuadrants": "abc123",
"isHigh": false,
"isMedium": false,
"isLow": false,
"priority": 987,
"isActive": false
}
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
123
JSONObject
Example
{}
JSONString
Example
JSONString
KanbanStage
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"isBacklog": false,
"isToDo": false,
"isInProgress": false,
"isDone": false,
"color": "xyz789",
"priority": 123,
"isActive": false,
"isDeleted": true
}
KanbanStage_Input
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"isBacklog": false,
"isToDo": true,
"isInProgress": false,
"isDone": true,
"color": "xyz789",
"priority": 987,
"isActive": false
}
KeyNote
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"title": "abc123",
"valueType": "xyz789",
"textValue": "abc123",
"numberValue": 123.45,
"unit": "abc123",
"dateValue": 1592577642,
"userValueIds": [
"5e5677d71bdc2ae76344968c"
],
"userValues": [User]
}
KeyNote_Input
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"title": "abc123",
"valueType": "xyz789",
"textValue": "abc123",
"numberValue": 987.65,
"unit": "xyz789",
"dateValue": 1592577642,
"userValueIds": [
"5e5677d71bdc2ae76344968c"
]
}
Label
LabelsPage
Language
LanguageString
LanguageString_Input
Language_Input
LanguagesPage
Fields
| Field Name | Description |
|---|---|
docs - [Language]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [Language],
"pageInfo": PageInfo
}
ListOptions
Manager
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"managerTypeId": "xyz789",
"managerId": "xyz789",
"user": User,
"manager": User,
"managerType": ManagerType
}
ManagerFeedback
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"rating": 987,
"observations": [
"5e5677d71bdc2ae76344968c"
],
"otherObservation": "abc123",
"feedbackByUserId": "5e5677d71bdc2ae76344968c",
"feedbackDate": 1592577642,
"feedbackByUser": User
}
ManagerFeedback_Input
Fields
| Input Field | Description |
|---|---|
rating - Int
|
|
observations - [ObjectID]
|
|
otherObservation - String
|
|
feedbackByUserId - ObjectID
|
|
feedbackDate - Timestamp
|
Example
{
"rating": 123,
"observations": [
"5e5677d71bdc2ae76344968c"
],
"otherObservation": "abc123",
"feedbackByUserId": "5e5677d71bdc2ae76344968c",
"feedbackDate": 1592577642
}
ManagerType
ManagerTypesPage
Fields
| Field Name | Description |
|---|---|
docs - [ManagerType!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [ManagerType],
"pageInfo": PageInfo
}
Master
Masters
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
yearsPage - YearsPage
|
|
Arguments
|
|
goalCategoriesPage - GoalCategoriesPage
|
|
Arguments
|
|
trackingStatusesPage - TrackingStatusesPage
|
|
Arguments
|
|
alarmsPage - AlarmsPage
|
|
Arguments
|
|
observationsPage - ObservationsPage
|
|
Arguments
|
|
labelsPage - LabelsPage
|
|
Arguments
|
|
tagsPage - TagsPage
|
|
Arguments
|
|
moduleCategoriesPage - ModuleCategoriesPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearsPage": YearsPage,
"goalCategoriesPage": GoalCategoriesPage,
"trackingStatusesPage": TrackingStatusesPage,
"alarmsPage": AlarmsPage,
"observationsPage": ObservationsPage,
"labelsPage": LabelsPage,
"tagsPage": TagsPage,
"moduleCategoriesPage": ModuleCategoriesPage
}
Me
Medal
Mention
Mention_Input
Message
Description
type Reaction { _id: ObjectID reactionType: String userId: ObjectID reactionDate: Timestamp user: User }
type ReactionsPage { docs: [Reaction] pageInfo: PageInfo }
type Share { _id: ObjectID shareByUserId: ObjectID shareToUserId: ObjectID shareDate: Timestamp }
type SharesPage { docs: [Share] pageInfo: PageInfo }
input Mention_Input { _id: ObjectID, objId: ObjectID, objType: String, objText: String, index: Int, length: Int }
type Mention { _id: ObjectID, objId: ObjectID, objType: String, objText: String, index: Int, length: Int }
type MentionsPage { docs: [Mention] pageInfo: PageInfo }
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
conversationId - ObjectID
|
|
type - String
|
|
parentId - ObjectID
|
|
text - String
|
|
files - [File]
|
|
reactions - [Reaction]
|
|
shares - [Share]
|
|
mentions - [Mention]
|
|
userId - ObjectID
|
|
isEdited - Boolean
|
|
isDeleted - Boolean
|
|
postedDate - Timestamp
|
|
messageStatus - [MessageStatus]
|
|
updatedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
conversation - Conversation
|
|
parent - Message
|
|
user - User
|
|
myReaction - Reaction
|
|
reactionsFacts - [Fact]
|
|
Arguments
|
|
messagesFacts - [Fact]
|
|
Arguments
|
|
filesFacts - [Fact]
|
|
Arguments
|
|
messagesPage - MessagesPage
|
|
Arguments
|
|
filesPage - [File]
|
|
Arguments
|
|
reactionsPage - ReactionsPage
|
|
Arguments
|
|
sharesPage - SharesPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"conversationId": "5e5677d71bdc2ae76344968c",
"type": "xyz789",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "abc123",
"files": [File],
"reactions": [Reaction],
"shares": [Share],
"mentions": [Mention],
"userId": "5e5677d71bdc2ae76344968c",
"isEdited": false,
"isDeleted": true,
"postedDate": 1592577642,
"messageStatus": [MessageStatus],
"updatedDate": 1592577642,
"deletedDate": 1592577642,
"conversation": Conversation,
"parent": Message,
"user": User,
"myReaction": Reaction,
"reactionsFacts": [Fact],
"messagesFacts": [Fact],
"filesFacts": [Fact],
"messagesPage": MessagesPage,
"filesPage": [File],
"reactionsPage": ReactionsPage,
"sharesPage": SharesPage
}
MessageStatus
Message_Input
Description
input Reaction_Input { reactionType: String userId: ObjectID }
Fields
| Input Field | Description |
|---|---|
conversationId - ObjectID
|
|
parentId - ObjectID
|
|
text - String
|
|
files - [File_Input]
|
|
mentions - [Mention_Input]
|
Example
{
"conversationId": "5e5677d71bdc2ae76344968c",
"parentId": "5e5677d71bdc2ae76344968c",
"text": "xyz789",
"files": [File_Input],
"mentions": [Mention_Input]
}
MessagesPage
Meta
Meta_Input
MetasPage
MileStone
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"what": "xyz789",
"when": 1592577642,
"whoseUserIds": [
"5e5677d71bdc2ae76344968c"
],
"isQuantitative": false,
"targetFrequency": "abc123",
"targetUnit": "xyz789",
"target": "xyz789",
"quantitativeTarget": 987.65,
"whoseUsers": [User]
}
MileStone_Input
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"what": "xyz789",
"when": 1592577642,
"whoseUserIds": [
"5e5677d71bdc2ae76344968c"
],
"isQuantitative": true,
"targetFrequency": "abc123",
"targetUnit": "xyz789",
"target": "xyz789",
"quantitativeTarget": 987.65
}
MilestoneProgress
Module
ModuleCategoriesPage
Fields
| Field Name | Description |
|---|---|
docs - [ModuleCategory]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [ModuleCategory],
"pageInfo": PageInfo
}
ModuleCategory
ModuleCategory_Input
Module_Input
ModulesPage
Notification
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"notificationDate": 1592577642,
"messageData": {},
"payload": {},
"isOpened": false,
"messageText": "abc123",
"messageTitle": "xyz789",
"messageUri": "abc123",
"isActive": true,
"isDeleted": false
}
Notification_Input
Fields
| Input Field | Description |
|---|---|
userId - ObjectID
|
|
termProgramId - ObjectID
|
|
payload - JSONObject
|
|
isOpened - Boolean
|
|
notificationDate - Timestamp
|
|
messageData - JSONObject
|
|
messageText - String
|
|
messageTitle - String
|
|
messageUri - String
|
|
isActive - Boolean
|
Example
{
"userId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"payload": {},
"isOpened": false,
"notificationDate": 1592577642,
"messageData": {},
"messageText": "xyz789",
"messageTitle": "xyz789",
"messageUri": "xyz789",
"isActive": true
}
NotificationsPage
Fields
| Field Name | Description |
|---|---|
docs - [Notification]
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Notification],
"pageInfo": PageInfo
}
ObjectID
Example
"5e5677d71bdc2ae76344968c"
Observation
ObservationsPage
Fields
| Field Name | Description |
|---|---|
docs - [Observation!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Observation],
"pageInfo": PageInfo
}
OrgUnit
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
name - String
|
|
pid - ObjectID
|
|
keyName - String
|
|
priority - Int
|
|
isActive - Boolean
|
|
myRootOrg - OrgUnit
|
|
childUnitsPage - OrgUnitsPage
|
|
Arguments
|
|
surveyReportWithPrevSurveyReport - SurveyReport
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"pid": "5e5677d71bdc2ae76344968c",
"keyName": "abc123",
"priority": 987,
"isActive": true,
"myRootOrg": OrgUnit,
"childUnitsPage": OrgUnitsPage,
"surveyReportWithPrevSurveyReport": SurveyReport
}
OrgUnit_Input
OrgUnitsPage
Fields
| Field Name | Description |
|---|---|
docs - [OrgUnit!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [OrgUnit],
"pageInfo": PageInfo
}
Organisation
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
name - String!
|
|
keyName - String!
|
|
wesoarDomain - String!
|
|
organisationGroup - String
|
|
contactPerson - Organisation_Person
|
|
registeredAddress - Organisation_Address
|
|
website - String
|
|
profilePicUrl - String
|
|
organisationSize - String
|
|
organisationIndustry - String
|
|
organisationType - String
|
|
organisationStatus - String
|
|
yearOfEstablishment - Int
|
|
totalRevenue - Int
|
|
objectives - String
|
|
activationCode - String
|
|
contractDetails - [Organisation_ContractDetails]
|
|
subscriptions - [Organisation_Subscription]
|
|
defaultFieldMapping - String
|
|
technicalData - Organisation_TechnicalData
|
|
designSetting - Organisation_DesignSetting
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"wesoarDomain": "abc123",
"organisationGroup": "abc123",
"contactPerson": Organisation_Person,
"registeredAddress": Organisation_Address,
"website": "xyz789",
"profilePicUrl": "xyz789",
"organisationSize": "xyz789",
"organisationIndustry": "xyz789",
"organisationType": "xyz789",
"organisationStatus": "abc123",
"yearOfEstablishment": 123,
"totalRevenue": 123,
"objectives": "xyz789",
"activationCode": "abc123",
"contractDetails": [Organisation_ContractDetails],
"subscriptions": [Organisation_Subscription],
"defaultFieldMapping": "abc123",
"technicalData": Organisation_TechnicalData,
"designSetting": Organisation_DesignSetting
}
OrganisationOverviewByDomain
Fields
| Field Name | Description |
|---|---|
id - ObjectID!
|
|
name - String!
|
|
keyName - String!
|
|
wesoarDomain - String!
|
|
organisationGroup - String
|
|
contactPerson - Organisation_Person
|
|
registeredAddress - Organisation_Address
|
|
website - String
|
|
profilePicUrl - String
|
|
organisationSize - String
|
|
organisationIndustry - String
|
|
organisationType - String
|
|
organisationStatus - String
|
|
yearOfEstablishment - Int
|
|
objectives - String
|
|
clientId - String
|
|
designSetting - Organisation_DesignSetting
|
|
technicalData - Organisation_TechnicalData
|
Example
{
"id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"wesoarDomain": "xyz789",
"organisationGroup": "xyz789",
"contactPerson": Organisation_Person,
"registeredAddress": Organisation_Address,
"website": "xyz789",
"profilePicUrl": "xyz789",
"organisationSize": "xyz789",
"organisationIndustry": "xyz789",
"organisationType": "xyz789",
"organisationStatus": "xyz789",
"yearOfEstablishment": 123,
"objectives": "xyz789",
"clientId": "xyz789",
"designSetting": Organisation_DesignSetting,
"technicalData": Organisation_TechnicalData
}
OrganisationOverviewByDomainParams
Organisation_Address
Example
{
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"addressLine3": "abc123",
"city": "abc123",
"county": "abc123",
"country": "abc123",
"postcode": "xyz789"
}
Organisation_ContractDetails
Example
{
"startDate": 1592577642,
"endDate": 1592577642,
"commissionDate": 1592577642,
"billingFrequency": 123,
"commissionPercentage": 987,
"plan": "xyz789"
}
Organisation_DesignSetting
Example
{
"splashIcon": "xyz789",
"headerIcon": "xyz789",
"logoIcon": "abc123",
"primaryColor": "xyz789",
"secondaryColor": "abc123",
"selectionColor": "abc123",
"primaryTextColor": "abc123",
"secondaryTextColor": "abc123",
"selectionTextColor": "abc123",
"appTitle": "xyz789",
"appTitleTextColor": "xyz789"
}
Organisation_Person
Example
{
"title": "abc123",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"designation": "abc123",
"contactNumber": "abc123",
"mobileNumber": "abc123",
"email": "abc123"
}
Organisation_Subscription
Organisation_TechnicalData
Fields
| Field Name | Description |
|---|---|
dbConfiguration - Organisation_TechnicalData_DBConfig
|
|
sendGridConfiguration - Organisation_TechnicalData_SendGridConfig
|
|
awsConfig - Organisation_TechnicalData_AWSConfig
|
|
azureConfig - Organisation_TechnicalData_AzureConfig
|
|
authType - String
|
Example
{
"dbConfiguration": Organisation_TechnicalData_DBConfig,
"sendGridConfiguration": Organisation_TechnicalData_SendGridConfig,
"awsConfig": Organisation_TechnicalData_AWSConfig,
"azureConfig": Organisation_TechnicalData_AzureConfig,
"authType": "xyz789"
}
Organisation_TechnicalData_AWSConfig
Fields
| Field Name | Description |
|---|---|
developerConfig - Organisation_TechnicalData_AWSConfig_DeveloperConfig
|
|
cognitoConfig - Organisation_TechnicalData_AWSConfig_CognitoConfig
|
Example
{
"developerConfig": Organisation_TechnicalData_AWSConfig_DeveloperConfig,
"cognitoConfig": Organisation_TechnicalData_AWSConfig_CognitoConfig
}
Organisation_TechnicalData_AWSConfig_CognitoConfig
Fields
| Field Name | Description |
|---|---|
apiVersion - String
|
|
region - String
|
|
userPoolId - String
|
|
cognitoClient - [Organisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient]
|
|
mfaConfiguration - String
|
Example
{
"apiVersion": "xyz789",
"region": "abc123",
"userPoolId": "xyz789",
"cognitoClient": [
Organisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient
],
"mfaConfiguration": "abc123"
}
Organisation_TechnicalData_AWSConfig_CognitoConfig_CognitoClient
Organisation_TechnicalData_AWSConfig_DeveloperConfig
Organisation_TechnicalData_AzureConfig
Fields
| Field Name | Description |
|---|---|
authConfig - Organisation_TechnicalData_AzureConfig_AuthConfig
|
Example
{
"authConfig": Organisation_TechnicalData_AzureConfig_AuthConfig
}
Organisation_TechnicalData_AzureConfig_AuthConfig
Organisation_TechnicalData_DBConfig
Organisation_TechnicalData_SendGridConfig
Organisations
Fields
| Field Name | Description |
|---|---|
edges - [Organisation!]!
|
|
pageInfo - PageInfo!
|
Example
{
"edges": [Organisation],
"pageInfo": PageInfo
}
PageInfo
Example
{
"totalDocs": 123,
"limit": 987,
"hasPrevPage": true,
"hasNextPage": true,
"page": 123,
"totalPages": 987,
"offset": 987,
"prevPage": 987,
"nextPage": 123,
"pagingCounter": 987
}
Participation
Participation_Input
ParticipationsPage
Fields
| Field Name | Description |
|---|---|
docs - [Participation]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [Participation],
"pageInfo": PageInfo
}
PlannedTask
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
yearId - ObjectID
|
|
programId - ObjectID
|
|
termProgramId - ObjectID
|
|
year - Year
|
|
program - Program
|
|
assignedToUser - User
|
|
assignedByUser - User
|
|
approvedByUser - User
|
|
trashedByUser - User
|
|
assignedDate - Timestamp
|
|
updatedDate - Timestamp
|
|
submittedDate - Timestamp
|
|
approvedDate - Timestamp
|
|
trashedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
plannedTaskType - String
|
|
plannedTaskDetail - PlannedTaskDetail
|
|
followUps - [FollowUp]
|
|
comments - [Comment]
|
|
eisenhowerQuadrant - String
|
|
managerFeedback - ManagerFeedback
|
|
kanbanStageId - ObjectID
|
|
kanbanStage - KanbanStage
|
|
trackingStatus - String
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
commentsPage - CommentsPage
|
|
Arguments
|
|
comment - Comment
|
|
Arguments
|
|
views - Int
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"plannedTaskType": "abc123",
"plannedTaskDetail": PlannedTaskDetail,
"followUps": [FollowUp],
"comments": [Comment],
"eisenhowerQuadrant": "xyz789",
"managerFeedback": ManagerFeedback,
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"kanbanStage": KanbanStage,
"trackingStatus": "xyz789",
"priority": 987,
"isActive": false,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"views": 123
}
PlannedTaskDetail
Example
{
"description": "xyz789",
"dueBy": 1592577642,
"startTime": 1592577642,
"endTime": 1592577642,
"alarm": "P3Y6M4DT12H30M5S",
"labels": ["xyz789"],
"taggedUserIds": [
"5e5677d71bdc2ae76344968c"
],
"taggedUsers": [User]
}
PlannedTaskDetail_Input
Example
{
"description": "xyz789",
"dueBy": 1592577642,
"startTime": 1592577642,
"endTime": 1592577642,
"alarm": "P3Y6M4DT12H30M5S",
"labels": ["xyz789"],
"taggedUserIds": [
"5e5677d71bdc2ae76344968c"
]
}
PlannedTaskSetting
Fields
| Field Name | Description |
|---|---|
impactStages - [ImpactStage]
|
|
timelineStages - [TimelineStage]
|
|
kanbanStages - [KanbanStage]
|
Example
{
"impactStages": [ImpactStage],
"timelineStages": [TimelineStage],
"kanbanStages": [KanbanStage]
}
PlannedTaskSetting_Input
Fields
| Input Field | Description |
|---|---|
impactStages - [ImpactStage_Input]
|
|
timelineStages - [TimelineStage_Input]
|
|
kanbanStages - [KanbanStage_Input]
|
Example
{
"impactStages": [ImpactStage_Input],
"timelineStages": [TimelineStage_Input],
"kanbanStages": [KanbanStage_Input]
}
PlannedTask_Input
Fields
| Input Field | Description |
|---|---|
yearId - ObjectID
|
|
termProgramId - ObjectID
|
|
programId - ObjectID
|
|
trackingStatus - String
|
|
kanbanStageId - ObjectID
|
|
plannedTaskDetail - PlannedTaskDetail_Input
|
|
managerFeedback - ManagerFeedback_Input
|
|
approvedDate - Timestamp
|
|
comments - [Comment_Input]
|
Example
{
"yearId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"trackingStatus": "xyz789",
"kanbanStageId": "5e5677d71bdc2ae76344968c",
"plannedTaskDetail": PlannedTaskDetail_Input,
"managerFeedback": ManagerFeedback_Input,
"approvedDate": 1592577642,
"comments": [Comment_Input]
}
PlannedTasksPage
Description
type GoalsPage { docs: [Goal!]! pageInfo: PageInfo! }
Fields
| Field Name | Description |
|---|---|
docs - [PlannedTask]
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [PlannedTask],
"pageInfo": PageInfo
}
Program
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
yearId - ObjectID
|
|
programCategoryId - ObjectID
|
|
name - String
|
|
keyName - String
|
|
moduleKeyName - String
|
|
moduleCategoryKeyName - String
|
|
startDate - Timestamp
|
|
endDate - Timestamp
|
|
goalSetting - GoalSetting
|
|
plannedTaskSetting - PlannedTaskSetting
|
|
unplannedTaskSetting - UnplannedTaskSetting
|
|
surveySetting - SurveySetting
|
|
userFilterRules - [JSONObject]
|
|
status - String
|
|
programLabels - [String]
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
year - Year
|
|
programCategory - ProgramCategory
|
|
kanbanStage - KanbanStage
|
endDate: Timestamp unplannedTaskSetting: UnplannedTaskSetting surveySetting: SurveySetting |
Arguments
|
|
impactStage - ImpactStage
|
|
Arguments
|
|
timelineStage - TimelineStage
|
|
Arguments
|
|
unplannedImpactStage - ImpactStage
|
|
Arguments
|
|
previousProgram - Program
|
|
surveyReportsPage - SurveyReportsPage!
|
|
Arguments
|
|
surveyReportsCount - Int
|
|
surveyReport - SurveyReport
|
|
Arguments
|
|
filterOptions - [FilterOption]
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programCategoryId": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"moduleKeyName": "xyz789",
"moduleCategoryKeyName": "abc123",
"startDate": 1592577642,
"endDate": 1592577642,
"goalSetting": GoalSetting,
"plannedTaskSetting": PlannedTaskSetting,
"unplannedTaskSetting": UnplannedTaskSetting,
"surveySetting": SurveySetting,
"userFilterRules": [{}],
"status": "xyz789",
"programLabels": ["xyz789"],
"priority": 987,
"isActive": true,
"isDeleted": false,
"year": Year,
"programCategory": ProgramCategory,
"kanbanStage": KanbanStage,
"impactStage": ImpactStage,
"timelineStage": TimelineStage,
"unplannedImpactStage": ImpactStage,
"previousProgram": Program,
"surveyReportsPage": SurveyReportsPage,
"surveyReportsCount": 123,
"surveyReport": SurveyReport,
"filterOptions": [FilterOption]
}
ProgramCategoriesPage
Fields
| Field Name | Description |
|---|---|
docs - [ProgramCategory!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [ProgramCategory],
"pageInfo": PageInfo
}
ProgramCategory
ProgramType
ProgramType_Input
ProgramTypesPage
Fields
| Field Name | Description |
|---|---|
docs - [ProgramType]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [ProgramType],
"pageInfo": PageInfo
}
Program_Input
Fields
| Input Field | Description |
|---|---|
yearId - ObjectID
|
|
programCategoryId - ObjectID
|
|
name - String
|
|
keyName - String
|
|
moduleKeyName - String
|
|
moduleCategoryKeyName - String
|
|
startDate - Timestamp
|
|
endDate - Timestamp
|
|
goalSetting - GoalSetting_Input
|
|
plannedTaskSetting - PlannedTaskSetting_Input
|
|
unplannedTaskSetting - UnplannedTaskSetting_Input
|
|
surveySetting - SurveySetting_Input
|
|
userFilterRules - [JSONObject]
|
|
status - String
|
|
programLabels - [String]
|
|
priority - Int
|
|
isActive - Boolean
|
Example
{
"yearId": "5e5677d71bdc2ae76344968c",
"programCategoryId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"moduleKeyName": "xyz789",
"moduleCategoryKeyName": "xyz789",
"startDate": 1592577642,
"endDate": 1592577642,
"goalSetting": GoalSetting_Input,
"plannedTaskSetting": PlannedTaskSetting_Input,
"unplannedTaskSetting": UnplannedTaskSetting_Input,
"surveySetting": SurveySetting_Input,
"userFilterRules": [{}],
"status": "abc123",
"programLabels": ["xyz789"],
"priority": 123,
"isActive": true
}
ProgramsPage
Fields
| Field Name | Description |
|---|---|
docs - [Program!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Program],
"pageInfo": PageInfo
}
Progress
Fields
| Field Name | Description |
|---|---|
actualAchievement - String
|
|
trackingStatus - String
|
|
overallProgress - Int
|
|
milestoneProgress - [MilestoneProgress]
|
|
updatedDate - Timestamp
|
Example
{
"actualAchievement": "abc123",
"trackingStatus": "abc123",
"overallProgress": 987,
"milestoneProgress": [MilestoneProgress],
"updatedDate": 1592577642
}
Question
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
name - String
|
|
keyName - String
|
|
title - String
|
|
questionText - String
|
|
questionType - String
|
|
surveyQuestionFactorId - ObjectID
|
|
surveyTypeId - ObjectID
|
|
surveyFactor - String
|
|
answerOptions - [SurveyAnswerOption]
|
|
surveyLibraryIds - [ObjectID]
|
|
languageStrings - [LanguageString]
|
|
isIndex - Boolean
|
|
weightage - Int
|
|
aliases - [Alias]
|
|
isMandatory - Boolean
|
|
isValidated - Boolean
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
surveyQuestionFactor - SurveyQuestionFactor
|
|
surveyType - SurveyType
|
|
surveyLibraries - [SurveyLibrary]
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"title": "xyz789",
"questionText": "abc123",
"questionType": "xyz789",
"surveyQuestionFactorId": "5e5677d71bdc2ae76344968c",
"surveyTypeId": "5e5677d71bdc2ae76344968c",
"surveyFactor": "xyz789",
"answerOptions": [SurveyAnswerOption],
"surveyLibraryIds": [
"5e5677d71bdc2ae76344968c"
],
"languageStrings": [LanguageString],
"isIndex": false,
"weightage": 123,
"aliases": [Alias],
"isMandatory": true,
"isValidated": false,
"priority": 123,
"isActive": false,
"isDeleted": false,
"surveyQuestionFactor": SurveyQuestionFactor,
"surveyType": SurveyType,
"surveyLibraries": [SurveyLibrary]
}
Question_Input
Fields
| Input Field | Description |
|---|---|
name - String
|
|
keyName - String
|
|
title - String
|
|
questionText - String
|
|
questionType - String
|
|
surveyQuestionFactorId - ObjectID
|
|
surveyTypeId - ObjectID
|
|
surveyFactor - String
|
|
answerOptions - [SurveyAnswerOption_Input]
|
|
surveyLibraryIds - [ObjectID]
|
|
languageStrings - [LanguageString_Input]
|
|
isIndex - Boolean
|
|
weightage - Int
|
|
aliases - [Alias_Input]
|
|
isMandatory - Boolean
|
|
isValidated - Boolean
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
Example
{
"name": "xyz789",
"keyName": "xyz789",
"title": "xyz789",
"questionText": "xyz789",
"questionType": "abc123",
"surveyQuestionFactorId": "5e5677d71bdc2ae76344968c",
"surveyTypeId": "5e5677d71bdc2ae76344968c",
"surveyFactor": "abc123",
"answerOptions": [SurveyAnswerOption_Input],
"surveyLibraryIds": [
"5e5677d71bdc2ae76344968c"
],
"languageStrings": [LanguageString_Input],
"isIndex": false,
"weightage": 987,
"aliases": [Alias_Input],
"isMandatory": false,
"isValidated": false,
"priority": 123,
"isActive": false,
"isDeleted": true
}
RankWithGap
Reaction
Reaction_Input
ReactionsPage
Fields
| Field Name | Description |
|---|---|
docs - [Reaction!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Reaction],
"pageInfo": PageInfo
}
Relevance
Description
type MileStone { _id: ObjectID what: String when: Timestamp whoseUsers: [User] progressByEmp(checkInId: ObjectID): MilestoneProgress progressByManager(checkInId: ObjectID): MilestoneProgress }
type GoalDetail { goalCategory: GoalCategory description: String weightage: Int target: String dueBy: Timestamp taggedUsers: [User] milestones: [MileStone] }
Example
{
"value": "xyz789",
"updatedDate": 1592577642
}
RemoveAttendanceLogOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
RemoveAttendanceLogParams
RemoveAttendancesOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemoveAttendancesParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RemoveAttendancesPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
RemoveCommentReactionParams
RemoveGoalAppraisalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemoveGoalAppraisalParams
RemoveGoalCheckInOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
RemoveGoalCheckInParams
RemoveGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemoveGoalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RemoveGoalsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
RemoveMessageReactionParams
RemoveNotificationsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemoveNotificationsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RemoveNotificationsPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
RemovePlannedTaskFollowUpOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemovePlannedTaskFollowUpParams
RemovePlannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
RemovePlannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RemovePlannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 123}
RemoveUnplannedTaskReactionOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemoveUnplannedTaskReactionParams
RemoveUnplannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RemoveUnplannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RemoveUnplannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsDeleted - Int
|
Example
{"recordsDeleted": 987}
Report
Report_Input
ReportsPage
ResendEmailCodePayload
Fields
| Field Name | Description |
|---|---|
codeDeliveryDetails - CodeDeliveryDetails
|
Example
{"codeDeliveryDetails": CodeDeliveryDetails}
ResendMobileNumberCodePayload
Fields
| Field Name | Description |
|---|---|
codeDeliveryDetails - CodeDeliveryDetails
|
Example
{"codeDeliveryDetails": CodeDeliveryDetails}
ResetPasswordOnFirstLoginOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
ResetPasswordOnFirstLoginParams
ResponseByCheckIn
Example
{
"checkInId": "5e5677d71bdc2ae76344968c",
"managerTypeId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c",
"ratingStatus": "xyz789",
"scaleAnswer": 987,
"textAnswer": "abc123",
"intAnswer": 987,
"floatAnswer": 123.45,
"booleanAnswer": false,
"managerType": ManagerType,
"userManager": User,
"checkIn": CheckIn
}
RestoreGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RestoreGoalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RestoreGoalsPayload
RestorePlannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
RestorePlannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RestorePlannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 987}
RestoreUnplannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
RestoreUnplannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
RestoreUnplannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 987}
Role
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"parentRoleKeyName": "abc123",
"ability": [Ability],
"features": ["xyz789"],
"priority": 987,
"isActive": true
}
RolesPage
RootOptions
ScaleResponseSummary
SearchOptions
Fields
| Input Field | Description |
|---|---|
parentId - ObjectID
|
user.approvedGoals:- programTermId user.draftGoals:- programTermId user.trashedGoals:- programTermId user.taggedGoals:- programTermId |
refParentId - ObjectID
|
|
search - JSONString
|
Example
{
"parentId": "5e5677d71bdc2ae76344968c",
"refParentId": "5e5677d71bdc2ae76344968c",
"search": JSONString
}
Sentiment
Fields
| Field Name | Description |
|---|---|
sentiment - String
|
|
wordCloudWords - [WordCloudWord]
|
Example
{
"sentiment": "xyz789",
"wordCloudWords": [WordCloudWord]
}
SignInOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
SignInParams
SignInPayload
StartSurveyOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
StartSurveyParams
Fields
| Input Field | Description |
|---|---|
surveySpecimenId - ObjectID
|
Example
{
"surveySpecimenId": "5e5677d71bdc2ae76344968c"
}
String
Description
The String scalar 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
"abc123"
SubscribeCommunityGoalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
SubscribeCommunityGoalParams
Fields
| Input Field | Description |
|---|---|
communityGoalId - ObjectID
|
Example
{
"communityGoalId": "5e5677d71bdc2ae76344968c"
}
SubscribeCommunityGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
SubscribeCommunityGoalsParams
Fields
| Input Field | Description |
|---|---|
communityGoalIds - [ObjectID]
|
|
userIds - [ObjectID]
|
Example
{
"communityGoalIds": [
"5e5677d71bdc2ae76344968c"
],
"userIds": ["5e5677d71bdc2ae76344968c"]
}
SubscriptionsPage
Fields
| Field Name | Description |
|---|---|
docs - [Participation]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [Participation],
"pageInfo": PageInfo
}
SupportTicket
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
userId - ObjectID
|
|
ticketType - String
|
|
comments - [Comment]
|
|
ticketStatus - String
|
|
priority - Int
|
|
isActive - Boolean
|
|
commentsPage - CommentsPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"ticketType": "xyz789",
"comments": [Comment],
"ticketStatus": "xyz789",
"priority": 987,
"isActive": true,
"commentsPage": CommentsPage
}
SupportTicketsPage
Fields
| Field Name | Description |
|---|---|
docs - [SupportTicket!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [SupportTicket],
"pageInfo": PageInfo
}
SurveyAnswerCategoriesPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyAnswerCategory]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [SurveyAnswerCategory],
"pageInfo": PageInfo
}
SurveyAnswerCategory
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"color": "abc123",
"percentage": 987.65,
"priority": 123,
"isActive": true
}
SurveyAnswerCategory_Input
SurveyAnswerOption
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"keyName": "xyz789",
"name": "abc123",
"min": 123.45,
"max": 987.65,
"value": 123,
"grade": "xyz789",
"surveyAnswerCategoryId": "5e5677d71bdc2ae76344968c",
"answerOptionType": "xyz789",
"languageStrings": [LanguageString],
"priority": 987,
"isActive": false,
"isDeleted": false
}
SurveyAnswerOption_Input
Example
{
"keyName": "abc123",
"name": "abc123",
"value": 987,
"surveyAnswerCategoryId": "5e5677d71bdc2ae76344968c",
"answerOptionType": "abc123",
"languageStrings": [LanguageString_Input],
"priority": 123,
"isActive": false
}
SurveyFrontend
Fields
| Field Name | Description |
|---|---|
welcomeTitle - String
|
|
welcomeMsg - String
|
|
welcomeImg - String
|
|
finishTitle - String
|
|
finishMsg - String
|
|
finishImg - String
|
|
isShuffle - Boolean
|
|
isUseFactorNameAsTitle - Boolean
|
|
leftLogo - String
|
|
centerLogo - String
|
|
rightLogo - String
|
|
layout - String
|
|
inputType - String
|
|
isAllowReview - Boolean
|
|
fixTopHeaderContent - String
|
|
theme - Theme
|
Example
{
"welcomeTitle": "abc123",
"welcomeMsg": "xyz789",
"welcomeImg": "abc123",
"finishTitle": "abc123",
"finishMsg": "xyz789",
"finishImg": "xyz789",
"isShuffle": false,
"isUseFactorNameAsTitle": true,
"leftLogo": "xyz789",
"centerLogo": "abc123",
"rightLogo": "xyz789",
"layout": "abc123",
"inputType": "abc123",
"isAllowReview": false,
"fixTopHeaderContent": "abc123",
"theme": Theme
}
SurveyFrontend_Input
Fields
| Input Field | Description |
|---|---|
welcomeTitle - String
|
|
welcomeMsg - String
|
|
welcomeImg - String
|
|
finishTitle - String
|
|
finishMsg - String
|
|
finishImg - String
|
|
isShuffle - Boolean
|
|
isUseFactorNameAsTitle - Boolean
|
|
leftLogo - String
|
|
centerLogo - String
|
|
rightLogo - String
|
|
layout - String
|
|
inputType - String
|
|
isAllowReview - Boolean
|
|
fixTopHeaderContent - String
|
|
theme - Theme_Input
|
Example
{
"welcomeTitle": "xyz789",
"welcomeMsg": "abc123",
"welcomeImg": "abc123",
"finishTitle": "abc123",
"finishMsg": "xyz789",
"finishImg": "abc123",
"isShuffle": false,
"isUseFactorNameAsTitle": true,
"leftLogo": "xyz789",
"centerLogo": "xyz789",
"rightLogo": "xyz789",
"layout": "xyz789",
"inputType": "abc123",
"isAllowReview": false,
"fixTopHeaderContent": "xyz789",
"theme": Theme_Input
}
SurveyLibrariesPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyLibrary!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [SurveyLibrary],
"pageInfo": PageInfo
}
SurveyLibrary
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "xyz789",
"version": "abc123",
"isSystem": true,
"priority": 123,
"isActive": true
}
SurveyQuestion
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
surveyLibraryQuestionId - ObjectID
|
|
question - Question
|
|
responseBySpecimenKey - SurveyResponse
|
|
Arguments
|
|
responseBySpecimenId - SurveyResponse
|
|
Arguments
|
|
isLibraryQuestion - Boolean
|
|
conversion - Float
|
|
stdDev - Float
|
|
countResponses - Int
|
|
scaleResponseSummary - [ScaleResponseSummary]
|
|
responsesByCheckInId - [ResponseByCheckIn]
|
|
Arguments
|
|
sentiments - [Sentiment]
|
|
summary - [String]
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"surveyLibraryQuestionId": "5e5677d71bdc2ae76344968c",
"question": Question,
"responseBySpecimenKey": SurveyResponse,
"responseBySpecimenId": SurveyResponse,
"isLibraryQuestion": false,
"conversion": 123.45,
"stdDev": 987.65,
"countResponses": 123,
"scaleResponseSummary": [ScaleResponseSummary],
"responsesByCheckInId": [ResponseByCheckIn],
"sentiments": [Sentiment],
"summary": ["xyz789"]
}
SurveyQuestionFactor
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
name - String
|
|
keyName - String
|
|
priority - Int
|
|
isActive - Boolean
|
|
conversion - Float
|
|
stdDev - Float
|
|
countQuestions - Int
|
|
surveyAnswerCategories - [SurveyAnswerCategory]
|
|
overallRankWithGap - RankWithGap
|
|
overallRank - Int
|
|
overallGap - Float
|
|
wordCloudWords - [WordCloudWord]
|
|
sentiments - [Sentiment]
|
|
surveyAnswerCompositions - [SurveyAnswerCategory]
|
|
summary - [String]
|
|
responsesByCheckInId - [ResponseByCheckIn]
|
|
Arguments
|
|
responsesTillCheckInId - [ResponseByCheckIn]
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "xyz789",
"keyName": "abc123",
"priority": 123,
"isActive": false,
"conversion": 987.65,
"stdDev": 123.45,
"countQuestions": 987,
"surveyAnswerCategories": [SurveyAnswerCategory],
"overallRankWithGap": RankWithGap,
"overallRank": 123,
"overallGap": 123.45,
"wordCloudWords": [WordCloudWord],
"sentiments": [Sentiment],
"surveyAnswerCompositions": [SurveyAnswerCategory],
"summary": ["xyz789"],
"responsesByCheckInId": [ResponseByCheckIn],
"responsesTillCheckInId": [ResponseByCheckIn]
}
SurveyQuestionFactor_Input
SurveyQuestionFactorsPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyQuestionFactor!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [SurveyQuestionFactor],
"pageInfo": PageInfo
}
SurveyQuestion_Input
SurveyQuestionsPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyQuestion]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [SurveyQuestion],
"pageInfo": PageInfo
}
SurveyReport
Fields
| Field Name | Description |
|---|---|
reportMode - String
|
|
programId - ObjectID
|
|
userManagerId - ObjectID
|
|
orgUnitId - ObjectID
|
|
filters - SurveyReportFilters
|
|
grpFld - String
|
|
options - SurveyReportOptions
|
|
program - Program
|
|
previousProgram - Program
|
|
myEngReport - [EngReport]
|
|
myPrevEngReport - [EngReport]
|
|
myDDEngReport - [EngReport]
|
|
myDDPrevEngReport - [EngReport]
|
|
deptEngReport - [EngReport]
|
|
deptPrevEngReport - [EngReport]
|
|
deptDDEngReport - [EngReport]
|
|
deptDDPrevEngReport - [EngReport]
|
|
orgDDEngReport - [EngReport]
|
|
orgDDPrevEngReport - [EngReport]
|
Example
{
"reportMode": "abc123",
"programId": "5e5677d71bdc2ae76344968c",
"userManagerId": "5e5677d71bdc2ae76344968c",
"orgUnitId": "5e5677d71bdc2ae76344968c",
"filters": SurveyReportFilters,
"grpFld": "xyz789",
"options": SurveyReportOptions,
"program": Program,
"previousProgram": Program,
"myEngReport": [EngReport],
"myPrevEngReport": [EngReport],
"myDDEngReport": [EngReport],
"myDDPrevEngReport": [EngReport],
"deptEngReport": [EngReport],
"deptPrevEngReport": [EngReport],
"deptDDEngReport": [EngReport],
"deptDDPrevEngReport": [EngReport],
"orgDDEngReport": [EngReport],
"orgDDPrevEngReport": [EngReport]
}
SurveyReportFilters
Fields
| Field Name | Description |
|---|---|
specimenFilter - JSONString
|
|
resFilter - JSONString
|
|
userFilter - JSONString
|
|
quesFilter - JSONString
|
Example
{
"specimenFilter": JSONString,
"resFilter": JSONString,
"userFilter": JSONString,
"quesFilter": JSONString
}
SurveyReportFilters_Input
Fields
| Input Field | Description |
|---|---|
specimenFilter - JSONString
|
|
resFilter - JSONString
|
|
userFilter - JSONString
|
|
quesFilter - JSONString
|
Example
{
"specimenFilter": JSONString,
"resFilter": JSONString,
"userFilter": JSONString,
"quesFilter": JSONString
}
SurveyReportOptions
Fields
| Field Name | Description |
|---|---|
isSurveyScore - Boolean
|
|
isExtendedScore - Boolean
|
|
reportType - String
|
|
isSurveyStrength - Boolean
|
|
isFWSurveyStrength - Boolean
|
|
isSurveyComposition - Boolean
|
|
isFWSurveyComposition - Boolean
|
|
isFWSurveyScore - Boolean
|
|
isOrgReport - Boolean
|
|
isOrgUnitWise - Boolean
|
|
isFWText - Boolean
|
|
isQWText - Boolean
|
|
isOverallText - Boolean
|
Example
{
"isSurveyScore": false,
"isExtendedScore": false,
"reportType": "xyz789",
"isSurveyStrength": false,
"isFWSurveyStrength": true,
"isSurveyComposition": false,
"isFWSurveyComposition": true,
"isFWSurveyScore": true,
"isOrgReport": true,
"isOrgUnitWise": true,
"isFWText": true,
"isQWText": false,
"isOverallText": false
}
SurveyReportOptions_Input
Fields
| Input Field | Description |
|---|---|
isSurveyScore - Boolean
|
|
isExtendedScore - Boolean
|
|
reportType - String
|
|
isSurveyStrength - Boolean
|
|
isFWSurveyStrength - Boolean
|
|
isSurveyComposition - Boolean
|
|
isFWSurveyComposition - Boolean
|
|
isFWSurveyScore - Boolean
|
|
isOrgReport - Boolean
|
|
isOrgUnitWise - Boolean
|
|
isFWText - Boolean
|
|
isQWText - Boolean
|
|
isOverallText - Boolean
|
Example
{
"isSurveyScore": true,
"isExtendedScore": true,
"reportType": "xyz789",
"isSurveyStrength": false,
"isFWSurveyStrength": false,
"isSurveyComposition": false,
"isFWSurveyComposition": true,
"isFWSurveyScore": false,
"isOrgReport": true,
"isOrgUnitWise": false,
"isFWText": false,
"isQWText": false,
"isOverallText": true
}
SurveyReportsPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyReport]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [SurveyReport],
"pageInfo": PageInfo
}
SurveyResponse
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"surveyForUserId": "5e5677d71bdc2ae76344968c",
"surveyQuestionId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["abc123"],
"scaleAnswer": 987,
"textAnswer": "abc123",
"isNotApplicable": true,
"remark": "xyz789",
"isActive": true,
"isDeleted": true
}
SurveyResponse_Input
Example
{
"surveyForUserId": "5e5677d71bdc2ae76344968c",
"surveySpecimenId": "5e5677d71bdc2ae76344968c",
"surveyQuestionId": "5e5677d71bdc2ae76344968c",
"choiceAnswers": ["xyz789"],
"scaleAnswer": 123,
"textAnswer": "xyz789",
"isNotApplicable": false,
"remark": "xyz789",
"isActive": true,
"isDeleted": true
}
SurveyResponsesPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyResponse]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [SurveyResponse],
"pageInfo": PageInfo
}
SurveySetting
Fields
| Field Name | Description |
|---|---|
isClosed - Boolean
|
|
snapshotCat - String
|
|
surveyCat - String
|
|
isShuffle - Boolean
|
|
surveyStatus - String
|
|
ratingScale - [SurveyAnswerOption]
|
|
managerReportThreshold - Int
|
|
defaultSurveyAnswerCategoryId - ObjectID
|
|
defaultRating - String
|
|
surveyFrontend - SurveyFrontend
|
Example
{
"isClosed": false,
"snapshotCat": "xyz789",
"surveyCat": "abc123",
"isShuffle": false,
"surveyStatus": "abc123",
"ratingScale": [SurveyAnswerOption],
"managerReportThreshold": 987,
"defaultSurveyAnswerCategoryId": "5e5677d71bdc2ae76344968c",
"defaultRating": "xyz789",
"surveyFrontend": SurveyFrontend
}
SurveySetting_Input
Fields
| Input Field | Description |
|---|---|
isClosed - Boolean
|
|
snapshotCat - String
|
|
surveyCat - String
|
|
surveyStatus - String
|
|
ratingScale - [SurveyAnswerOption_Input]
|
|
managerReportThreshold - Int
|
|
defaultSurveyAnswerCategoryId - ObjectID
|
|
defaultRating - String
|
|
surveyFrontend - SurveyFrontend_Input
|
Example
{
"isClosed": false,
"snapshotCat": "abc123",
"surveyCat": "xyz789",
"surveyStatus": "xyz789",
"ratingScale": [SurveyAnswerOption_Input],
"managerReportThreshold": 123,
"defaultSurveyAnswerCategoryId": "5e5677d71bdc2ae76344968c",
"defaultRating": "xyz789",
"surveyFrontend": SurveyFrontend_Input
}
SurveySpecimen
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"program": Program,
"userId": "5e5677d71bdc2ae76344968c",
"user": User,
"isOpen": true,
"isActive": true,
"responses": [SurveyResponse],
"surveyQuestions": [SurveyQuestion],
"surveySpecimenKey": "xyz789",
"participants": [User]
}
SurveySpecimen_Input
SurveySpecimensPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveySpecimen]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [SurveySpecimen],
"pageInfo": PageInfo
}
SurveyType
SurveyTypesPage
Fields
| Field Name | Description |
|---|---|
docs - [SurveyType!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [SurveyType],
"pageInfo": PageInfo
}
Tag
TagsPage
Tenant
Example
{
"id": "xyz789",
"clientId": "xyz789",
"tenantId": "xyz789",
"countryCode": "abc123",
"displayName": "xyz789",
"tenantCategory": "abc123",
"defaultDomain": "xyz789",
"wesoarDomain": "xyz789",
"tenantType": "xyz789",
"isExist": true,
"designSetting": Organisation_DesignSetting,
"params": {}
}
Term
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
yearId - ObjectID
|
|
year - Year
|
|
termModuleCategories - [TermModuleCategory]
|
|
termModuleCategoriesPage - TermModuleCategoriesPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"year": Year,
"termModuleCategories": [TermModuleCategory],
"termModuleCategoriesPage": TermModuleCategoriesPage
}
TermModule
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
keyName - String
|
|
termPrograms - [TermProgram]
|
|
termProgramsPage - TermProgramsPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"keyName": "xyz789",
"termPrograms": [TermProgram],
"termProgramsPage": TermProgramsPage
}
TermModuleCategoriesPage
Fields
| Field Name | Description |
|---|---|
docs - [TermModuleCategory]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [TermModuleCategory],
"pageInfo": PageInfo
}
TermModuleCategory
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
keyName - String
|
|
termModules - [TermModule]
|
|
termModulesPage - TermModulesPage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"keyName": "xyz789",
"termModules": [TermModule],
"termModulesPage": TermModulesPage
}
TermModulesPage
Fields
| Field Name | Description |
|---|---|
docs - [TermModule]
|
|
pageInfo - PageInfo
|
Example
{
"docs": [TermModule],
"pageInfo": PageInfo
}
TermProgram
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
name - String!
|
|
userId - ObjectID
|
|
programId - ObjectID
|
|
assignDate - Timestamp
|
|
deAssignDate - Timestamp
|
|
isOpen - Boolean
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
user - User
|
|
program - Program
|
|
myCompanyGoalsPage - CommunityGoalsPage
|
|
Arguments
|
|
myCommunityGoalsPage - CommunityGoalsPage
|
|
Arguments
|
|
approvedGoalsPage - GoalsPage
|
|
Arguments
|
|
withObstacleGoalsPage - GoalsPage
|
|
Arguments
|
|
draftGoalsPage - GoalsPage
|
|
Arguments
|
|
trashedGoalsPage - GoalsPage
|
|
Arguments
|
|
taggedGoalsPage - GoalsPage
|
|
Arguments
|
|
checkInGoalsPage - GoalsPage
|
|
Arguments
|
|
approvedGoalsFacts - [Fact]
|
|
Arguments
|
|
draftGoalsFacts - [Fact]
|
|
Arguments
|
|
trashedGoalsFacts - [Fact]
|
|
Arguments
|
|
taggedGoalsFacts - [Fact]
|
|
Arguments
|
|
submittedGoalsFacts - [Fact]
|
|
Arguments
|
|
goalsFacts - [Fact]
|
|
Arguments
|
|
plannedTasksPage - PlannedTasksPage
|
|
Arguments
|
|
plannedTasksFacts - [Fact]
|
|
Arguments
|
|
taggedPlannedTasksPage - PlannedTasksPage
|
|
Arguments
|
|
taggedPlannedTasksFacts - [Fact]
|
|
Arguments
|
|
unplannedTasksPage - UnplannedTasksPage
|
|
Arguments
|
|
unplannedTasksFacts - [Fact]
|
|
Arguments
|
|
attendancesPage - AttendancesPage
|
|
Arguments
|
|
attendancesFacts - [Fact]
|
|
Arguments
|
|
checkInsPage - CheckInsPage!
|
|
Arguments
|
|
checkInsFacts - [Fact]
|
|
Arguments
|
|
appraisalsPage - AppraisalsPage!
|
|
Arguments
|
|
appraisalsFacts - [Fact]
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"assignDate": 1592577642,
"deAssignDate": 1592577642,
"isOpen": false,
"isActive": false,
"isDeleted": true,
"user": User,
"program": Program,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"withObstacleGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"checkInGoalsPage": GoalsPage,
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"checkInsPage": CheckInsPage,
"checkInsFacts": [Fact],
"appraisalsPage": AppraisalsPage,
"appraisalsFacts": [Fact]
}
TermProgram_Input
Example
{
"name": "xyz789",
"userId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"assignDate": 1592577642,
"deAssignDate": 1592577642,
"isOpen": false,
"isActive": false,
"isDeleted": false
}
TermProgramsPage
Fields
| Field Name | Description |
|---|---|
docs - [TermProgram!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [TermProgram],
"pageInfo": PageInfo
}
TermsPage
Theme
Fields
| Field Name | Description |
|---|---|
css - String
|
|
colors - JSONObject
|
|
images - JSONObject
|
Example
{
"css": "xyz789",
"colors": {},
"images": {}
}
Theme_Input
Fields
| Input Field | Description |
|---|---|
css - String
|
|
colors - JSONObject
|
|
images - JSONObject
|
Example
{
"css": "abc123",
"colors": {},
"images": {}
}
TimelineStage
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"color": "xyz789",
"isOverdue": false,
"isToday": false,
"isTomorrow": true,
"isLater": false,
"priority": 987,
"isActive": false,
"isDeleted": false
}
TimelineStage_Input
Example
{
"name": "xyz789",
"keyName": "xyz789",
"color": "xyz789",
"isOverdue": false,
"isToday": false,
"isTomorrow": true,
"isLater": false,
"priority": 987,
"isActive": true
}
Timestamp
Example
1592577642
Tokens
TrackingStatus
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "abc123",
"isGoalTrackingStatus": false,
"isTaskTrackingStatus": false,
"priority": 123,
"isActive": false
}
TrackingStatusesPage
Fields
| Field Name | Description |
|---|---|
docs - [TrackingStatus!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [TrackingStatus],
"pageInfo": PageInfo
}
TrashGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
TrashGoalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
TrashGoalsPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 123}
TrashPlannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
TrashPlannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
TrashPlannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 123}
TrashUnplannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
TrashUnplannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
Example
{"_ids": ["5e5677d71bdc2ae76344968c"]}
TrashUnplannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 987}
UnfollowGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UnfollowGoalsParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
|
userId - ObjectID
|
Example
{
"_ids": ["5e5677d71bdc2ae76344968c"],
"userId": "5e5677d71bdc2ae76344968c"
}
UnfollowGoalsPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 987}
UnfollowPlannedTasksOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UnfollowPlannedTasksParams
Fields
| Input Field | Description |
|---|---|
_ids - [ObjectID!]!
|
|
userId - ObjectID
|
Example
{
"_ids": ["5e5677d71bdc2ae76344968c"],
"userId": "5e5677d71bdc2ae76344968c"
}
UnfollowPlannedTasksPayload
Fields
| Field Name | Description |
|---|---|
recordsUpdated - Int
|
Example
{"recordsUpdated": 987}
UnplannedTask
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
yearId - ObjectID
|
|
programId - ObjectID
|
|
termProgramId - ObjectID
|
|
year - Year
|
|
program - Program
|
|
assignedToUser - User
|
|
assignedByUser - User
|
|
approvedByUser - User
|
|
trashedByUser - User
|
|
assignedDate - Timestamp
|
|
updatedDate - Timestamp
|
|
submittedDate - Timestamp
|
|
approvedDate - Timestamp
|
|
trashedDate - Timestamp
|
|
deletedDate - Timestamp
|
|
unplannedTaskType - String
|
|
unplannedTaskDetail - UnplannedTaskDetail
|
|
comments - [Comment]
|
|
reactions - [Reaction]
|
|
impactStageId - ObjectID
|
|
impactStage - ImpactStage
|
|
trackingStatus - String
|
|
priority - Int
|
|
isActive - Boolean
|
|
isDeleted - Boolean
|
|
commentsPage - CommentsPage
|
|
Arguments
|
|
comment - Comment
|
|
Arguments
|
|
unplannedTaskCommentsFacts - [Fact]
|
|
Arguments
|
|
myUnplannedTaskReaction - Reaction
|
|
unplannedTaskReactionsFacts - [Fact]
|
|
Arguments
|
|
unplannedTaskReactionsPage - ReactionsPage!
|
|
Arguments
|
|
unplannedTasksFacts - [Fact]
|
|
Arguments
|
|
views - Int
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"yearId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"year": Year,
"program": Program,
"assignedToUser": User,
"assignedByUser": User,
"approvedByUser": User,
"trashedByUser": User,
"assignedDate": 1592577642,
"updatedDate": 1592577642,
"submittedDate": 1592577642,
"approvedDate": 1592577642,
"trashedDate": 1592577642,
"deletedDate": 1592577642,
"unplannedTaskType": "xyz789",
"unplannedTaskDetail": UnplannedTaskDetail,
"comments": [Comment],
"reactions": [Reaction],
"impactStageId": "5e5677d71bdc2ae76344968c",
"impactStage": ImpactStage,
"trackingStatus": "abc123",
"priority": 123,
"isActive": true,
"isDeleted": false,
"commentsPage": CommentsPage,
"comment": Comment,
"unplannedTaskCommentsFacts": [Fact],
"myUnplannedTaskReaction": Reaction,
"unplannedTaskReactionsFacts": [Fact],
"unplannedTaskReactionsPage": ReactionsPage,
"unplannedTasksFacts": [Fact],
"views": 123
}
UnplannedTaskDetail
UnplannedTaskDetail_Input
Fields
| Input Field | Description |
|---|---|
description - String
|
|
taskDate - Timestamp
|
|
timeTaken - Duration
|
|
labels - [String]
|
|
files - [File_Input]
|
Example
{
"description": "xyz789",
"taskDate": 1592577642,
"timeTaken": "P3Y6M4DT12H30M5S",
"labels": ["abc123"],
"files": [File_Input]
}
UnplannedTaskSetting
Fields
| Field Name | Description |
|---|---|
impactStages - [ImpactStage]
|
Example
{"impactStages": [ImpactStage]}
UnplannedTaskSetting_Input
Fields
| Input Field | Description |
|---|---|
impactStages - [ImpactStage_Input]
|
Example
{"impactStages": [ImpactStage_Input]}
UnplannedTask_Input
Fields
| Input Field | Description |
|---|---|
yearId - ObjectID
|
|
termProgramId - ObjectID
|
|
programId - ObjectID
|
|
unplannedTaskDetail - UnplannedTaskDetail_Input
|
|
comments - [Comment_Input]
|
|
reactions - [Reaction_Input]
|
|
impactStageId - ObjectID
|
Example
{
"yearId": "5e5677d71bdc2ae76344968c",
"termProgramId": "5e5677d71bdc2ae76344968c",
"programId": "5e5677d71bdc2ae76344968c",
"unplannedTaskDetail": UnplannedTaskDetail_Input,
"comments": [Comment_Input],
"reactions": [Reaction_Input],
"impactStageId": "5e5677d71bdc2ae76344968c"
}
UnplannedTasksPage
Fields
| Field Name | Description |
|---|---|
docs - [UnplannedTask]
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [UnplannedTask],
"pageInfo": PageInfo
}
UnsubscribeCommunityGoalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UnsubscribeCommunityGoalParams
Fields
| Input Field | Description |
|---|---|
communityGoalId - ObjectID
|
Example
{
"communityGoalId": "5e5677d71bdc2ae76344968c"
}
UnsubscribeCommunityGoalsOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UnsubscribeCommunityGoalsParams
Fields
| Input Field | Description |
|---|---|
communityGoalIds - [ObjectID]
|
|
userIds - [ObjectID]
|
Example
{
"communityGoalIds": [
"5e5677d71bdc2ae76344968c"
],
"userIds": ["5e5677d71bdc2ae76344968c"]
}
UpdateAlarmOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateAlarmParams
Fields
| Input Field | Description |
|---|---|
alarm - Alarm_Input
|
|
_id - ObjectID!
|
Example
{
"alarm": Alarm_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateAppraisalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateAppraisalParams
Fields
| Input Field | Description |
|---|---|
appraisal - Appraisal_Input
|
|
_id - ObjectID!
|
Example
{
"appraisal": Appraisal_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateAttendanceLogOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateAttendanceLogParams
Fields
| Input Field | Description |
|---|---|
termProgramId - ObjectID
|
|
userId - ObjectID
|
|
attendanceLogId - ObjectID
|
|
attendanceLog - Attendance_Log_Input
|
Example
{
"termProgramId": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"attendanceLogId": "5e5677d71bdc2ae76344968c",
"attendanceLog": Attendance_Log_Input
}
UpdateAttendanceLogsPayload
Fields
| Field Name | Description |
|---|---|
attendancesUpdated - [ObjectID]
|
|
attendancesNotUpdated - [ObjectID]
|
Example
{
"attendancesUpdated": [
"5e5677d71bdc2ae76344968c"
],
"attendancesNotUpdated": [
"5e5677d71bdc2ae76344968c"
]
}
UpdateAttendanceOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateAttendanceParams
Fields
| Input Field | Description |
|---|---|
attendance - Attendance_Input
|
|
_id - ObjectID!
|
Example
{
"attendance": Attendance_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateCheckInOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateCheckInParams
Fields
| Input Field | Description |
|---|---|
checkIn - CheckIn_Input
|
|
_id - ObjectID!
|
Example
{
"checkIn": CheckIn_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateCommentParams
Fields
| Input Field | Description |
|---|---|
commentId - ObjectID
|
|
comment - Comment_Input
|
Example
{
"commentId": "5e5677d71bdc2ae76344968c",
"comment": Comment_Input
}
UpdateCommentReactionParams
UpdateCommunicationEventOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateCommunicationEventParams
Fields
| Input Field | Description |
|---|---|
communicationEvent - CommunicationEvent_Input
|
|
_id - ObjectID!
|
Example
{
"communicationEvent": CommunicationEvent_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateCommunityGoalOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateCommunityGoalParams
Fields
| Input Field | Description |
|---|---|
communityGoal - CommunityGoal_Input
|
|
_id - ObjectID!
|
Example
{
"communityGoal": CommunityGoal_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateConversationOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateConversationParams
Fields
| Input Field | Description |
|---|---|
conversation - Conversation_Input
|
|
_id - ObjectID!
|
Example
{
"conversation": Conversation_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateGoalAppraisalOptions
Fields
| Input Field | Description |
|---|---|
appraisalStatus - String
|
Example
{"appraisalStatus": "abc123"}
UpdateGoalAppraisalParams
Fields
| Input Field | Description |
|---|---|
goalId - ObjectID
|
|
goalAppraisalId - ObjectID
|
|
goalAppraisal - GoalAppraisal_Input
|
Example
{
"goalId": "5e5677d71bdc2ae76344968c",
"goalAppraisalId": "5e5677d71bdc2ae76344968c",
"goalAppraisal": GoalAppraisal_Input
}
UpdateGoalAppraisalsPayload
Fields
| Field Name | Description |
|---|---|
goalsUpdated - [ObjectID]
|
|
goalsNotUpdated - [ObjectID]
|
Example
{
"goalsUpdated": [
"5e5677d71bdc2ae76344968c"
],
"goalsNotUpdated": [
"5e5677d71bdc2ae76344968c"
]
}
UpdateGoalCheckInOptions
Fields
| Input Field | Description |
|---|---|
checkInStatus - String
|
Example
{"checkInStatus": "xyz789"}
UpdateGoalCheckInParams
Fields
| Input Field | Description |
|---|---|
goalId - ObjectID
|
|
goalCheckInId - ObjectID
|
|
goalCheckIn - GoalCheckIn_Input
|
Example
{
"goalId": "5e5677d71bdc2ae76344968c",
"goalCheckInId": "5e5677d71bdc2ae76344968c",
"goalCheckIn": GoalCheckIn_Input
}
UpdateGoalCheckInsPayload
Fields
| Field Name | Description |
|---|---|
goalsUpdated - [ObjectID]
|
|
goalsNotUpdated - [ObjectID]
|
Example
{
"goalsUpdated": [
"5e5677d71bdc2ae76344968c"
],
"goalsNotUpdated": [
"5e5677d71bdc2ae76344968c"
]
}
UpdateGoalOptions
UpdateGoalParams
Fields
| Input Field | Description |
|---|---|
goal - Goal_Input
|
|
_id - ObjectID
|
Example
{
"goal": Goal_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateGoalWeightageParams
UpdateGoalsWeightagesPayload
UpdateLanguageOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateLanguageParams
Fields
| Input Field | Description |
|---|---|
language - Language_Input
|
|
_id - ObjectID!
|
Example
{
"language": Language_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateMasterOptions
Fields
| Input Field | Description |
|---|---|
_id - ObjectID
|
Example
{"_id": "5e5677d71bdc2ae76344968c"}
UpdateMasterParams
UpdateMessageParams
Fields
| Input Field | Description |
|---|---|
messageId - ObjectID
|
|
message - Message_Input
|
Example
{
"messageId": "5e5677d71bdc2ae76344968c",
"message": Message_Input
}
UpdateMessageReactionParams
UpdateModuleCategoryOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateModuleCategoryParams
Fields
| Input Field | Description |
|---|---|
moduleCategory - ModuleCategory_Input
|
|
_id - ObjectID!
|
Example
{
"moduleCategory": ModuleCategory_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateModuleOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateModuleParams
Fields
| Input Field | Description |
|---|---|
module - Module_Input
|
|
_id - ObjectID!
|
Example
{
"module": Module_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateNotificationOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateNotificationParams
Fields
| Input Field | Description |
|---|---|
notification - Notification_Input
|
|
_id - ObjectID!
|
Example
{
"notification": Notification_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateOrgUnitOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateOrgUnitParams
Fields
| Input Field | Description |
|---|---|
orgUnit - OrgUnit_Input
|
|
_id - ObjectID!
|
Example
{
"orgUnit": OrgUnit_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdatePlannedTaskEisenhowerQuadrantParams
UpdatePlannedTaskEisenhowerQuadrantsPayload
Fields
| Field Name | Description |
|---|---|
plannedTasksUpdated - [PlannedTask]
|
|
plannedTasksNotUpdated - [String]
|
Example
{
"plannedTasksUpdated": [PlannedTask],
"plannedTasksNotUpdated": ["abc123"]
}
UpdatePlannedTaskFollowUpOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdatePlannedTaskFollowUpParams
UpdatePlannedTaskOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdatePlannedTaskParams
Fields
| Input Field | Description |
|---|---|
plannedTask - PlannedTask_Input
|
|
_id - ObjectID!
|
Example
{
"plannedTask": PlannedTask_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateProfileOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateProfileParams
Example
{
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789",
"mobileNumber": "abc123",
"profilePic": File_Input,
"aboutMe": "xyz789",
"myStatus": "xyz789",
"isReportAppDiagnosticData": false
}
UpdateProfilePayload
Fields
| Field Name | Description |
|---|---|
user - User
|
|
codeDeliveryDetailsList - [CodeDeliveryDetails]
|
Example
{
"user": User,
"codeDeliveryDetailsList": [CodeDeliveryDetails]
}
UpdateProgramOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateProgramParams
Fields
| Input Field | Description |
|---|---|
program - Program_Input
|
|
_id - ObjectID!
|
Example
{
"program": Program_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateProgramTypeOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateProgramTypeParams
Fields
| Input Field | Description |
|---|---|
programType - ProgramType_Input
|
|
_id - ObjectID!
|
Example
{
"programType": ProgramType_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateReportOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateReportParams
Fields
| Input Field | Description |
|---|---|
report - Report_Input
|
|
_id - ObjectID!
|
Example
{
"report": Report_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateSurveyAnswerCategoryOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateSurveyAnswerCategoryParams
Fields
| Input Field | Description |
|---|---|
surveyAnswerCategory - SurveyAnswerCategory_Input
|
|
_id - ObjectID!
|
Example
{
"surveyAnswerCategory": SurveyAnswerCategory_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateSurveyQuestionFactorOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateSurveyQuestionFactorParams
Fields
| Input Field | Description |
|---|---|
surveyQuestionFactor - SurveyQuestionFactor_Input
|
|
_id - ObjectID!
|
Example
{
"surveyQuestionFactor": SurveyQuestionFactor_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateSurveyQuestionOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateSurveyQuestionParams
Fields
| Input Field | Description |
|---|---|
surveyQuestion - SurveyQuestion_Input
|
|
_id - ObjectID!
|
Example
{
"surveyQuestion": SurveyQuestion_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateSurveyResponsesOptions
Fields
| Input Field | Description |
|---|---|
isSubmit - Boolean
|
Example
{"isSubmit": false}
UpdateSurveyResponsesParams
Fields
| Input Field | Description |
|---|---|
surveyResponses - [SurveyResponse_Input]
|
|
surveySpecimenId - ObjectID
|
Example
{
"surveyResponses": [SurveyResponse_Input],
"surveySpecimenId": "5e5677d71bdc2ae76344968c"
}
UpdateSurveyResponsesPayload
Fields
| Field Name | Description |
|---|---|
surveyResponses - [SurveyResponse]
|
Example
{"surveyResponses": [SurveyResponse]}
UpdateSurveySpecimenOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateSurveySpecimenParams
Fields
| Input Field | Description |
|---|---|
surveySpecimen - SurveySpecimen_Input
|
|
_id - ObjectID!
|
Example
{
"surveySpecimen": SurveySpecimen_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateTermProgramOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
UpdateTermProgramParams
Fields
| Input Field | Description |
|---|---|
termProgram - TermProgram_Input
|
|
_id - ObjectID!
|
Example
{
"termProgram": TermProgram_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateUnplannedTaskOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateUnplannedTaskParams
Fields
| Input Field | Description |
|---|---|
unplannedTask - UnplannedTask_Input
|
|
_id - ObjectID!
|
Example
{
"unplannedTask": UnplannedTask_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
UpdateUnplannedTaskReactionOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateUnplannedTaskReactionParams
UpdateYearOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
UpdateYearParams
Fields
| Input Field | Description |
|---|---|
year - Year_Input
|
|
_id - ObjectID!
|
Example
{
"year": Year_Input,
"_id": "5e5677d71bdc2ae76344968c"
}
User
Fields
| Field Name | Description |
|---|---|
_id - ObjectID!
|
|
userName - String!
|
|
empCode - String
|
|
preferredName - String
|
|
firstName - String
|
|
lastName - String
|
|
email - String
|
|
mobileNumber - String
|
|
isEmailVerified - Boolean
|
|
isMobileNumberVerified - Boolean
|
|
imageUrl - String
|
|
profilePic - File
|
|
managers - [Manager]
|
|
orgUnits - [ObjectID]
|
|
designation - String
|
|
path - String
|
|
aboutMe - String
|
|
myStatus - String
|
|
isReportAppDiagnosticData - Boolean
|
|
isActive - Boolean
|
|
dummy - String
|
|
progress - Float
|
|
Arguments
|
|
overallGoalProgress - Float
|
|
Arguments
|
|
ytdRating - Float
|
|
Arguments
|
|
teamOverallGoalProgress - Float
|
|
Arguments
|
|
peersOverallGoalProgress - Float
|
|
isManager - Boolean
|
|
managerId - String
|
|
myRoles - [ManagerType]
|
|
cognitoInfo - User_CognitoInfo
|
|
cognitoGroups - [User_CognitoGroup]
|
|
tokenRoles - [String]
|
|
tokenAbility - [Ability]
|
|
roles - [Role]
|
|
ability - [Ability]
|
|
rbacRoles - [String]
|
|
permissions - [User_Permission]
|
|
Arguments
|
|
terms - [Term]
|
|
isMFAEnabled - Boolean
|
|
years - [Year]
|
|
moduleCategories - [UserModuelCategory]
|
|
Arguments
|
|
termPrograms - [TermProgram]
|
|
termProgramsPage - TermProgramsPage
|
|
Arguments
|
|
termsPage - TermsPage
|
|
Arguments
|
|
termsFacts - [Fact]
|
|
Arguments
|
|
latestSupportTicket - SupportTicket
|
|
peersPage - UsersPage
|
|
Arguments
|
|
myManager - User
|
|
Arguments
|
|
myEvaluator - User
|
|
directReportsPage - UsersPage
|
|
Arguments |
|
directReportsFact - [Fact]
|
|
Arguments
|
|
managersInMyDirectReportsPage - UsersPage
|
|
Arguments
|
|
orgUnit - String
|
|
organizationUnit - OrgUnit
|
|
myCEO - User
|
|
inDirectReportsPage - UsersPage
|
|
Arguments
|
|
termProgram - TermProgram
|
|
Arguments
|
|
latestTermProgram - TermProgram
|
|
userFilterOptions - [UserFilterOption]
|
|
subUsersPage - UsersPage
|
|
Arguments
|
|
myCompanyGoalsPage - CommunityGoalsPage
|
|
Arguments
|
|
myCommunityGoalsPage - CommunityGoalsPage
|
|
Arguments
|
|
approvedGoalsPage - GoalsPage
|
|
Arguments
|
|
completedGoalsPage - GoalsPage
|
|
Arguments
|
|
canceledGoalsPage - GoalsPage
|
|
Arguments
|
|
draftGoalsPage - GoalsPage
|
|
Arguments
|
|
trashedGoalsPage - GoalsPage
|
|
Arguments
|
|
taggedGoalsPage - GoalsPage
|
|
Arguments
|
|
goalCreationStatus - String
|
|
goalCreationStatusFacts - [Fact]
|
|
Arguments
|
|
approvedGoalsFacts - [Fact]
|
|
Arguments
|
|
draftGoalsFacts - [Fact]
|
|
Arguments
|
|
trashedGoalsFacts - [Fact]
|
|
Arguments
|
|
taggedGoalsFacts - [Fact]
|
|
Arguments
|
|
submittedGoalsFacts - [Fact]
|
|
Arguments
|
|
goalsFacts - [Fact]
|
|
Arguments
|
|
plannedTasksPage - PlannedTasksPage
|
|
Arguments
|
|
plannedTasksFacts - [Fact]
|
|
Arguments
|
|
taggedPlannedTasksPage - PlannedTasksPage
|
|
Arguments
|
|
taggedPlannedTasksFacts - [Fact]
|
|
Arguments
|
|
unplannedTasksPage - UnplannedTasksPage
|
|
Arguments
|
|
unplannedTasksFacts - [Fact]
|
|
Arguments
|
|
attendancesPage - AttendancesPage
|
|
Arguments
|
|
attendancesFacts - [Fact]
|
|
Arguments
|
|
notificationsPage - NotificationsPage
|
|
Arguments
|
|
surveyScore - String
|
|
Arguments
|
|
surveySpecimensPage - SurveySpecimensPage
|
|
Arguments
|
|
socketUrl - String
|
|
programsOfDirectReportsPage - ProgramsPage
|
|
Arguments
|
|
surveyReport - SurveyReport
|
|
Arguments
|
|
surveyReportWithPrevSurveyReport - SurveyReport
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"userName": "abc123",
"empCode": "abc123",
"preferredName": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"mobileNumber": "abc123",
"isEmailVerified": false,
"isMobileNumberVerified": false,
"imageUrl": "xyz789",
"profilePic": File,
"managers": [Manager],
"orgUnits": ["5e5677d71bdc2ae76344968c"],
"designation": "abc123",
"path": "abc123",
"aboutMe": "abc123",
"myStatus": "xyz789",
"isReportAppDiagnosticData": true,
"isActive": false,
"dummy": "abc123",
"progress": 987.65,
"overallGoalProgress": 987.65,
"ytdRating": 987.65,
"teamOverallGoalProgress": 987.65,
"peersOverallGoalProgress": 987.65,
"isManager": false,
"managerId": "abc123",
"myRoles": [ManagerType],
"cognitoInfo": User_CognitoInfo,
"cognitoGroups": [User_CognitoGroup],
"tokenRoles": ["abc123"],
"tokenAbility": [Ability],
"roles": [Role],
"ability": [Ability],
"rbacRoles": ["abc123"],
"permissions": [User_Permission],
"terms": [Term],
"isMFAEnabled": true,
"years": [Year],
"moduleCategories": [UserModuelCategory],
"termPrograms": [TermProgram],
"termProgramsPage": TermProgramsPage,
"termsPage": TermsPage,
"termsFacts": [Fact],
"latestSupportTicket": SupportTicket,
"peersPage": UsersPage,
"myManager": User,
"myEvaluator": User,
"directReportsPage": UsersPage,
"directReportsFact": [Fact],
"managersInMyDirectReportsPage": UsersPage,
"orgUnit": "abc123",
"organizationUnit": OrgUnit,
"myCEO": User,
"inDirectReportsPage": UsersPage,
"termProgram": TermProgram,
"latestTermProgram": TermProgram,
"userFilterOptions": [UserFilterOption],
"subUsersPage": UsersPage,
"myCompanyGoalsPage": CommunityGoalsPage,
"myCommunityGoalsPage": CommunityGoalsPage,
"approvedGoalsPage": GoalsPage,
"completedGoalsPage": GoalsPage,
"canceledGoalsPage": GoalsPage,
"draftGoalsPage": GoalsPage,
"trashedGoalsPage": GoalsPage,
"taggedGoalsPage": GoalsPage,
"goalCreationStatus": "abc123",
"goalCreationStatusFacts": [Fact],
"approvedGoalsFacts": [Fact],
"draftGoalsFacts": [Fact],
"trashedGoalsFacts": [Fact],
"taggedGoalsFacts": [Fact],
"submittedGoalsFacts": [Fact],
"goalsFacts": [Fact],
"plannedTasksPage": PlannedTasksPage,
"plannedTasksFacts": [Fact],
"taggedPlannedTasksPage": PlannedTasksPage,
"taggedPlannedTasksFacts": [Fact],
"unplannedTasksPage": UnplannedTasksPage,
"unplannedTasksFacts": [Fact],
"attendancesPage": AttendancesPage,
"attendancesFacts": [Fact],
"notificationsPage": NotificationsPage,
"surveyScore": "xyz789",
"surveySpecimensPage": SurveySpecimensPage,
"socketUrl": "xyz789",
"programsOfDirectReportsPage": ProgramsPage,
"surveyReport": SurveyReport,
"surveyReportWithPrevSurveyReport": SurveyReport
}
UserFilterOption
Fields
| Field Name | Description |
|---|---|
userFilterOptionName - UserFilterOptionName
|
|
userFilterOptionValues - [String]
|
Example
{
"userFilterOptionName": UserFilterOptionName,
"userFilterOptionValues": ["xyz789"]
}
UserFilterOptionName
UserModuelCategory
Fields
| Field Name | Description |
|---|---|
yearId - ID
|
|
keyName - String
|
|
userModules - [UserModule]
|
|
userId - ID
|
Example
{
"yearId": "4",
"keyName": "xyz789",
"userModules": [UserModule],
"userId": 4
}
UserModule
Fields
| Field Name | Description |
|---|---|
keyName - String
|
|
userId - ID
|
|
yearId - ID
|
|
termPrograms - [TermProgram]
|
Example
{
"keyName": "abc123",
"userId": "4",
"yearId": "4",
"termPrograms": [TermProgram]
}
UserSegmentWeightage
UserSegmentWeightage_Input
User_CognitoGroup
User_CognitoInfo
User_Manager_Input
User_Permission
UsersPage
UtcOffset
Example
"+03:00"
VerifyEmailCodeOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
VerifyEmailCodeParams
Fields
| Input Field | Description |
|---|---|
code - String
|
Example
{"code": "abc123"}
VerifyEmailCodePayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": true}
VerifyMfaCodeOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": true}
VerifyMfaCodeParams
VerifyMfaCodePayload
VerifyMobileNumberCodeOptions
Fields
| Input Field | Description |
|---|---|
dummy - Boolean
|
Example
{"dummy": false}
VerifyMobileNumberCodeParams
Fields
| Input Field | Description |
|---|---|
code - String
|
Example
{"code": "abc123"}
VerifyMobileNumberCodePayload
Fields
| Field Name | Description |
|---|---|
status - Boolean
|
Example
{"status": false}
WordCloudWord
Workflow
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
workflowType - String
|
|
workflowStages - [WorkflowStage]
|
|
isActive - Boolean
|
|
workflowStagesPage - WorkflowStagesPage
|
|
Arguments
|
|
workflowStagesFPage - [WorkflowStage]
|
|
Arguments
|
|
workflowStagesFOne - WorkflowStage
|
|
Arguments
|
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"workflowType": "xyz789",
"workflowStages": [WorkflowStage],
"isActive": true,
"workflowStagesPage": WorkflowStagesPage,
"workflowStagesFPage": [WorkflowStage],
"workflowStagesFOne": WorkflowStage
}
WorkflowStage
Fields
| Field Name | Description |
|---|---|
_id - ObjectID
|
|
managerTypeId - ObjectID
|
|
name - String
|
|
userFilterRules - [JSONObject]
|
|
params - JSONObject
|
|
priority - Int
|
|
isActive - Boolean
|
|
managerType - ManagerType
|
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"managerTypeId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"userFilterRules": [{}],
"params": {},
"priority": 123,
"isActive": false,
"managerType": ManagerType
}
WorkflowStage_Input
Fields
| Input Field | Description |
|---|---|
managerTypeId - ObjectID
|
|
name - String
|
|
userFilterRules - [JSONObject]
|
|
params - JSONObject
|
|
priority - Int
|
|
isActive - Boolean
|
Example
{
"managerTypeId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"userFilterRules": [{}],
"params": {},
"priority": 123,
"isActive": true
}
WorkflowStagesPage
Fields
| Field Name | Description |
|---|---|
docs - [WorkflowStage!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [WorkflowStage],
"pageInfo": PageInfo
}
Workflow_Input
Fields
| Input Field | Description |
|---|---|
workflowType - String
|
|
workflowStages - [WorkflowStage_Input]
|
|
isActive - Boolean
|
Example
{
"workflowType": "abc123",
"workflowStages": [WorkflowStage_Input],
"isActive": false
}
WorkflowsPage
Fields
| Field Name | Description |
|---|---|
docs - [Workflow!]!
|
|
pageInfo - PageInfo!
|
Example
{
"docs": [Workflow],
"pageInfo": PageInfo
}
Year
Example
{
"_id": "5e5677d71bdc2ae76344968c",
"userId": "5e5677d71bdc2ae76344968c",
"name": "abc123",
"keyName": "xyz789",
"priority": 123,
"isActive": false,
"userModuleCategories": [UserModuelCategory]
}