OBJECT

Query

Query root type

link GraphQL Schema definition

  • type Query {
  • # Arguments
  • # family:
  • picturesSignaturesByFamily(family: Long!): [SnapshotFileDto]
  • # Returns a list of projects by user
  • #
  • # Arguments
  • # user: Required
  • projectsBySurveyUser(user: Long): [ProjectModel]
  • # Get the list of users filtered by organization, username or email
  • #
  • # Arguments
  • # filter:
  • # sortDirection:
  • # role:
  • # organizations:
  • # sortBy:
  • # page:
  • # hubs:
  • searchUsers(
  • filter: String,
  • sortDirection: String,
  • role: String,
  • organizations: [Long],
  • sortBy: String,
  • page: Int,
  • hubs: [Long]
  • ): PaginationModel_UserModel
  • # Arguments
  • # version:
  • apiVersionStatus(version: String): StoplightApiVersionEntity
  • surveysDefinitionByUser: [SurveyDefinitionModel]
  • # Arguments
  • # snapshotId:
  • prioritiesAchievementsBySnapshot(
  • snapshotId: Long!
  • ): SnapshotPrioritiesAchievements
  • # Return full list of existing articles
  • #
  • # Arguments
  • # articles: Articles for reordering
  • reOrderArticles(articles: [HelpArticleModelInput]): [HelpArticleModel]
  • # List verified economic questions
  • #
  • # Arguments
  • # filter:
  • # stoplightType:
  • # language: Required
  • listEconomicQuestion(
  • filter: String,
  • stoplightType: String,
  • language: String
  • ): [EconomicLibraryQuestionModel]
  • # Retrieve the data for a specific user of type Family User
  • familyUserData: FamilyMapDTO
  • # Return an article object
  • #
  • # Arguments
  • # language: Language
  • # section: Section
  • # collection: Collection
  • # id: Article ID
  • getArticleById(
  • language: String,
  • section: String,
  • collection: String,
  • id: Long
  • ): HelpArticleModel
  • # Get a list of organizations
  • #
  • # Arguments
  • # filter:
  • # hubFilter:
  • # orgFilter:
  • listOrganizations(filter: String, hubFilter: Long, orgFilter: Long): [OrganizationDTO]
  • # Returns a list of projects by organization
  • #
  • # Arguments
  • # hub:
  • # organizations: Required
  • projectsByOrganization(hub: Long, organizations: [Long]): [ProjectModel]
  • # Retrieve the list of indicators questions filtered by lang and a string
  • #
  • # Arguments
  • # filter: Required
  • # lang: Required
  • indicatorsPool(filter: String, lang: String): [SurveyStoplightModel]
  • # Arguments
  • # familyId:
  • prioritiesByFamily(familyId: Long!): [PriorityDto]
  • solutionTypes: [StoplightSolutionTypeModel]
  • # Return list of dimensions related to the user
  • getDimensions: [SurveyStoplightDimension]
  • # Return article types
  • listArticlesTypes: [PropertyModel]
  • # Service that returns a list of stoplights indicators filtered by parameters
  • #
  • # Arguments
  • # country: Required
  • # verified: Required
  • # stoplightType: Required
  • # zones:
  • # targets:
  • # generic:
  • # measurementUnit: Required
  • # filter: Required
  • # dimensionId: Required
  • # page: Required
  • # tag: Required
  • # lang: Required
  • # status: Required
  • listStoplightIndicatorsBy(
  • country: String,
  • verified: Boolean,
  • stoplightType: String,
  • zones: [String],
  • targets: [String],
  • generic: Boolean,
  • measurementUnit: String,
  • filter: String,
  • dimensionId: Long,
  • page: Int,
  • tag: String,
  • lang: String,
  • status: String
  • ): PaginationModel_StoplightIndicatorModel
  • # Return numbers of achievements, priorities, and stoplight colors by dimension
  • # and indicators
  • #
  • # Arguments
  • # fromDate: Optional. Started from date
  • # projects: Optional. List of projects id
  • # hub: Optional.HUB id
  • # unified: Optional. Unify data flag
  • # snapshotNumber: Optional. Snapshot number
  • # toDate: Optional. To date
  • # surveys: Optional. List of surveys id
  • # organizations: Optional. List of organization ids
  • dimensionIndicators(
  • fromDate: Long,
  • projects: [Long],
  • hub: Long,
  • unified: Boolean,
  • snapshotNumber: Long,
  • toDate: Long,
  • surveys: [Long],
  • organizations: [Long]
  • ): [DimensionIndicatorModel]
  • # Returns a list of projects filtered by the given arguments
  • #
  • # Arguments
  • # filter:
  • # sortDirection:
  • # organizations:
  • # sortBy:
  • # page:
  • searchProjects(
  • filter: String,
  • sortDirection: String,
  • organizations: [Long],
  • sortBy: String,
  • page: Int
  • ): PaginationModel_ProjectModel
  • # Get the list of families filtered by organization
  • #
  • # Arguments
  • # organizationId: Optional
  • # name: Optional
  • familiesByOrganization(organizationId: Long, name: String): [FamilyDTO]
  • surveysInfoWithOrgs: [SurveyDefinitionDto]
  • solutionsAccess: [PropertyModel]
  • # List All PsTeam Users
  • listAllPsTeamUsers: [UserModel]
  • # Get the list of families filtered by user
  • #
  • # Arguments
  • # name: Optional
  • familiesByUser(name: String): [FamilyDTO]
  • interventionsDefinitionByUser: [InterventionDefinitionModel]
  • # Arguments
  • # snapshotId:
  • prioritiesBySnapshot(snapshotId: Long!): [PriorityDto]
  • # Retrieve the list of economic questions filtered by lang and a string
  • #
  • # Arguments
  • # filter: Required
  • # lang: Required
  • economicQuestionsPool(filter: String, lang: String): [SurveyEconomicModel]
  • # Get a list of organizations related to the user without interventions
  • #
  • # Arguments
  • # hub: Hub id
  • organizationsWithoutInterventions(hub: Long): [OrganizationDTO]
  • # Arguments
  • # id:
  • getSolutionById(id: Long!): StoplightSolutionModel
  • # List notes from a stoplight indicator
  • #
  • # Arguments
  • # id:
  • listNotesByIndicator(id: Long): [SurveyStoplightNoteModel]
  • # Graphql service to retrieve the list of families with the last snapshot taken
  • #
  • # Arguments
  • # fromDate:
  • # sortDirection:
  • # locationAvailable:
  • # toDate:
  • # sortBy:
  • # surveyUsers:
  • # page:
  • # orgs:
  • # followupSurveys:
  • # surveyDefinition:
  • # hubs:
  • familiesSnapshot(
  • fromDate: Long,
  • sortDirection: String,
  • locationAvailable: Boolean,
  • toDate: Long,
  • sortBy: String,
  • surveyUsers: [Long],
  • page: Int,
  • orgs: [Long],
  • followupSurveys: Boolean,
  • surveyDefinition: Long!,
  • hubs: [Long]
  • ): PaginationModel_FamilySnapshotModel
  • # Arguments
  • # family: Required
  • interventionsByFamily(family: Long): [InterventionModel]
  • # Retrieve the list of organizations final user types
  • organizationFinalUserTypes: [PropertyModel]
  • listUsersWithInvitations: [String]
  • # List All Hub Users
  • #
  • # Arguments
  • # hubs:
  • listAllHubUsersByHub(hubs: [Long]): [UserModel]
  • # Arguments
  • # snapshotId:
  • picturesSignaturesBySnapshot(snapshotId: Long!): [SnapshotFileDto]
  • # Get all the TC by survey ID.
  • #
  • # Arguments
  • # applicationId: Required.
  • allTermsAndConditions(applicationId: Long): [TermCondPolDTO]
  • # Get the list of families filtered by organization, name or document number
  • #
  • # Arguments
  • # filterList: Optional. List of families to filter the query
  • familiesDataByUser(filterList: [Long]): [FamilyModel]
  • surveysByUser: [SurveyDefinitionEntity]
  • # Arguments
  • # url:
  • generateImageProxyUrl(url: String!): String
  • # List all notifications by user
  • listAllNotificationsByUser: [NotificationModel]
  • # Retrieves the information for the user specified
  • #
  • # Arguments
  • # userId:
  • # username:
  • retrieveUser(userId: Long, username: String): UserModel
  • # Arguments
  • # familyId:
  • prioritiesAchievementsByFamily(familyId: Long!): SnapshotPrioritiesAchievements
  • # List surveys by assigned user
  • #
  • # Arguments
  • # user:
  • listSurveyDefinitionsByAssignedUser(
  • user: Long
  • ): [SurveyDefinitionModel]
  • # Arguments
  • # surveyId:
  • surveyById(surveyId: Long!): SurveyDefinitionEntity
  • # Return the list of verified indicators code names
  • #
  • # Arguments
  • # onlyWithTranslations: Required
  • allVerifiedCodeNames(onlyWithTranslations: Boolean): [String]
  • # Arguments
  • # sortDirection:
  • # sortBy:
  • # page:
  • reportsGenerationByUser(
  • sortDirection: String,
  • sortBy: String,
  • page: Int
  • ): PaginationModel_ReportGenerationModel
  • # Retrieve the list of organizations end survey types
  • organizationEndSurveyTypes: [PropertyModel]
  • # Retrieve the list of dimensions by language filter
  • #
  • # Arguments
  • # lang: Required
  • dimensionsByLang(lang: String): [SurveyStoplightDimension]
  • # List avaliable economic question
  • #
  • # Arguments
  • # filter:
  • # country:
  • # verified:
  • # stoplightType:
  • # language: Required
  • # page:
  • # measurementUnit:
  • # status:
  • listEconomicLibraryQuestions(
  • filter: String,
  • country: String,
  • verified: Boolean,
  • stoplightType: String,
  • language: String,
  • page: Int,
  • measurementUnit: String,
  • status: String
  • ): PaginationModel_EconomicLibraryQuestionModel
  • # Return list of mentors related to a list of organizations
  • #
  • # Arguments
  • # hub:
  • # organizations:
  • mentorsByOrganizations(hub: Long, organizations: [Long]): [UserModel]
  • # Service for operations overview
  • #
  • # Arguments
  • # projects: Optional. List of projects id
  • # hub: Optional.HUB id
  • # snapshotNumber: Optional. Snapshot number
  • # surveys: Optional. List of surveys id
  • # fromTime: Optional
  • # organizations: Optional
  • # toTime: Optional
  • operationsOverview(
  • projects: [Long],
  • hub: Long,
  • snapshotNumber: Long,
  • surveys: [Long],
  • fromTime: Long,
  • organizations: [Long],
  • toTime: Long
  • ): OperationsOverviewModel
  • # Graphql service to retrieve the paginated list of snapshots by the given filters
  • #
  • # Arguments
  • # fromDate:
  • # sortDirection:
  • # projects:
  • # toDate:
  • # sortBy:
  • # surveyUsers:
  • # page:
  • # orgs:
  • # stoplightFilters:
  • # followupSurveys:
  • # surveyDefinition:
  • # hubs:
  • searchSnapshots(
  • fromDate: Long,
  • sortDirection: String,
  • projects: [Long],
  • toDate: Long,
  • sortBy: String,
  • surveyUsers: [Long],
  • page: Int,
  • orgs: [Long],
  • stoplightFilters: [StoplightFilterInput],
  • followupSurveys: Boolean,
  • surveyDefinition: Long!,
  • hubs: [Long]
  • ): PaginationModel_SnapshotReportModel
  • # Return activities feed to show in the dashboard
  • recentActivity: [ActivityModel]
  • # Recover the last snapshot of a Family.
  • #
  • # Arguments
  • # familyId: Required
  • getLastSnapshot(familyId: Long): SnapshotDTO
  • # Return list of indicators related to the user
  • #
  • # Arguments
  • # dimension:
  • getIndicators(dimension: String): [SurveyStopligthIndicator]
  • # Get the list of families.
  • familiesNewStructure: [FamilyModel]
  • # Retrieve the list of organizations types
  • organizantionTypes: [PropertyModel]
  • # Arguments
  • # family:
  • interventionDefinitionByFamily(family: Long!): InterventionDefinitionModel
  • # Return true if the survey is locked
  • #
  • # Arguments
  • # surveyDefinitionId:
  • isSurveyLocked(surveyDefinitionId: Long): SurveyBuilderLockModel
  • offlineMaps: [SurveyOfflineMap]
  • # Retrieves the list of survey definition taken by family
  • #
  • # Arguments
  • # family: Required
  • surveysDefinitionByFamily(family: Long): [SurveyDefinitionModel]
  • # Arguments
  • # familyId: Required
  • familySnapshotsOverview(familyId: Long): FamilySnapshotsOverview
  • # Returns the data for the block overview of the dashboard
  • #
  • # Arguments
  • # fromDate: Optional
  • # projects: Optional
  • # hub: Optional.HUB id
  • # snapshotNumber: Optional. Snapshot number
  • # toDate: Optional
  • # surveys: Optional. List of surveys id
  • # organizations: Optional
  • blockOverview(
  • fromDate: Long,
  • projects: [Long],
  • hub: Long,
  • snapshotNumber: Long,
  • toDate: Long,
  • surveys: [Long],
  • organizations: [Long]
  • ): BlockOverviewModel
  • # Return full list of existing articles
  • #
  • # Arguments
  • # filter: Filter for titles
  • # collection: Collection
  • # lang: Language
  • # tags: Articles tags
  • listArticles(
  • filter: String,
  • collection: String,
  • lang: String,
  • tags: [String]
  • ): [HelpArticleModel]
  • # Arguments
  • # intervention:
  • retrieveInterventionData(intervention: Long!): InterventionDataModel
  • # Get the list of families filtered by organization, name or document number
  • #
  • # Arguments
  • # country: Country of origin
  • # stoplightType: Stoplight type
  • # indicators: Indicators code names
  • # sortDirection:
  • # hub: Optional. Id of one hub
  • # organizations: Optional. List of organization ids
  • # name: Name of solution
  • # sortBy:
  • # page:
  • # solutionType: Type of solution
  • # lang: Lang of solution
  • # user: Username of solution creator
  • # dimension: Dimension
  • solutions(
  • country: String,
  • stoplightType: String,
  • indicators: [String],
  • sortDirection: String,
  • hub: Long,
  • organizations: [Long],
  • name: String,
  • sortBy: String,
  • page: Int,
  • solutionType: String,
  • lang: String,
  • user: String,
  • dimension: String
  • ): Page_StoplightSolutionModel
  • # Returns a list of projects by user
  • projectsByUser: [ProjectModel]
  • # Return the list of icons available for stoplight dimensions
  • dimensionsIcons: [ParameterModel]
  • # Retrieve the list of hubs filtered by the user
  • hubsByUser: [ApplicationDTO]
  • # Return activities feed to show in the dashboard
  • feed: [ActivityFeedDTO]
  • # Get a family by its unique identifier.
  • #
  • # Arguments
  • # familyIdentifier:
  • familyByIdentifier(familyIdentifier: String): FamilyDTO
  • # List stakeholders by user
  • listStakeholdersByUser: [StakeholderModel]
  • # List avaliable options for filters and dropdowns
  • listLibraryOptions: HashMap_String_ListScalar
  • # Retrieve the list of organizations expertise area types
  • organizationAreasTypes: [PropertyModel]
  • # Arguments
  • # organization:
  • interventionDefinitionByOrg(organization: Long!): InterventionDefinitionModel
  • # Get the list of families with only the id and the code
  • familiesBasicData: [FamilyModel]
  • # Returns the data for people information in Dashboard: The total number of
  • # families.
  • # The total number of people.
  • #
  • # Arguments
  • # fromDate: Optional
  • # projects: Optional. List of projects id
  • # hub: Optional.HUB id
  • # snapshotNumber: Optional. Snapshot number
  • # toDate: Optional
  • # surveys: Optional. List of surveys id
  • # organizations: Optional
  • economicOverview(
  • fromDate: Long,
  • projects: [Long],
  • hub: Long,
  • snapshotNumber: Long,
  • toDate: Long,
  • surveys: [Long],
  • organizations: [Long]
  • ): EconomicOverviewModel
  • # Service that returns a list of stoplights indicators filtered by parameters
  • #
  • # Arguments
  • # filter: Required
  • # lang: Required
  • listAllStoplightIndicator(filter: String, lang: String): [StoplightIndicatorModel]
  • # Return full list of existing rated articles by user
  • retrieveRatedArticlesByUser: [HelpArticlesRatedModel]
  • # Get the paginated list of surveys by user, filtered by hub,= and organizations
  • #
  • # Arguments
  • # filter:
  • # country:
  • # sortDirection:
  • # sortBy:
  • # page:
  • # lang:
  • surveysByUserPaginated(
  • filter: String,
  • country: String,
  • sortDirection: String,
  • sortBy: String,
  • page: Int,
  • lang: String
  • ): Page_SurveyDefinitionDto
  • # List users assigned to a survey definition
  • #
  • # Arguments
  • # surveyDefinition:
  • listUsersAssignedToSurveyDefinition(
  • surveyDefinition: Long
  • ): [UserDTO]
  • # Get a family by its unique id. Used by Family Profile
  • #
  • # Arguments
  • # id:
  • familyById(id: Long): FamilyMapDTO
  • # List invited users
  • #
  • # Arguments
  • # userActivationFilter:
  • listInvitedUsers(
  • userActivationFilter: UserActivationFilterInput
  • ): PaginationModel_UserActivationModel
  • # Return draft by user
  • getSnapshotDraft: [NewSnapshotDTO]
  • # List stakeholders
  • #
  • # Arguments
  • # page:
  • listStakeholder(page: Int): PaginationModel_StakeholderModel
  • # Retrieve the list of supported languages for moment.js
  • supportedLanguages: [PropertyModel]
  • # Return the list of verified economic code names
  • listVerifiedEconomicCodenames: [String]
  • # Add a survey offline map
  • #
  • # Arguments
  • # organization: Required
  • searchOfflineMaps(organization: Long): [SurveyOfflineMap]
  • # List all notifications by user
  • #
  • # Arguments
  • # showAll:
  • # size:
  • # page:
  • listAllNotificationsByUserPaginated(
  • showAll: Boolean,
  • size: Int,
  • page: Int
  • ): PaginationModel_NotificationModel
  • # Arguments
  • # projects: Optional. List of projects id
  • # hub: Optional.HUB id
  • # surveys: Optional. List of surveys id
  • # fromTime: Optional
  • # organizations: Optional
  • # toTime: Optional
  • totalFamilies(
  • projects: [Long],
  • hub: Long,
  • surveys: [Long],
  • fromTime: Long,
  • organizations: [Long],
  • toTime: Long
  • ): EconomicOverviewModel
  • # Retrieves the last snapshot data by family and survey definition
  • #
  • # Arguments
  • # definition: Required
  • # family: Required
  • lastSnapshotByFamilyAndDefinition(
  • definition: Long,
  • family: Long
  • ): SnapshotDataModel
  • # Get the list of families filtered by organization, name or document number
  • #
  • # Arguments
  • # sortDirection:
  • # projects: Optional. List of projects ids
  • # facilitators: Optional. List of facilitators ids
  • # hub: Optional. Id of one hub
  • # organizations: Optional. List of organization ids
  • # name: Name or document number
  • # sortBy:
  • # page:
  • families(
  • sortDirection: String,
  • projects: [Long],
  • facilitators: [Long],
  • hub: Long,
  • organizations: [Long],
  • name: String,
  • sortBy: String,
  • page: Int
  • ): Page_FamilyBasicInfo
  • # Return list of mentors related to a list of organizations
  • #
  • # Arguments
  • # hub:
  • # organizations:
  • getMentorsByOrganizations(
  • hub: Long,
  • organizations: [Long]
  • ): [UserDTO]
  • # Arguments
  • # familyId: Required
  • notesByFamily(familyId: Long): [FamilyNoteDto]
  • # Get a list of organizations related to the user
  • #
  • # Arguments
  • # hub: Optional.HUB id
  • # org: Optional.ORG id
  • organizations(hub: Long, org: Long): [OrganizationDTO]
  • # Get a list of organizations with sub organizations
  • #
  • # Arguments
  • # hubFilter:
  • allOrgsWithSubOrgs(hubFilter: Long): [OrganizationDTO]
  • # Arguments
  • # surveyIds:
  • verifyUnifiableSurveys(surveyIds: [Long]): Boolean
  • # Return the list of preset questions for interventions
  • interventionPresetQuestions: [InterventionDefinitionPresetQuestionModel]
  • # Arguments
  • # interventionDefinition:
  • retrieveInterventionDefinition(
  • interventionDefinition: Long!
  • ): InterventionDefinitionModel
  • # Arguments
  • # snapshot: Required
  • interventionsBySnapshot(snapshot: Long): [InterventionModel]
  • }

link Require by

This element is not required by anyone