OBJECT
Query

GraphQL Schema definition

type Query {
#   Query the KPI values for a specific goal
# 
# Arguments
#   project: [Not documented]
#   campaign: [Not documented]
#   goal: [Not documented]
#   limit: [Not documented]
kpiValues(project: String!, campaign: String!, goal: String!, limit: Int): [KPIValue!]! 
#   Get Campaign by name
# 
# Arguments
#   project: [Not documented]
#   name: [Not documented]
campaignByName(project: String!, name: String!): Campaign! 
#   List Campaigns in a Project
# 
# Arguments
#   project: [Not documented]
#   filter: [Not documented]
#   limit: [Not documented]
#   skip: [Not documented]
#   sort: [Not documented]
campaigns(
project: String!,
filter: String,
limit: String,
skip: String,
sort: String
): [Campaign!]! 
#   Get Connection by name
# 
# Arguments
#   project: [Not documented]
#   name: [Not documented]
connectionByName(project: String!, name: String!): Connection! 
#   List Connections
# 
# Arguments
#   project: [Not documented]
connections(project: String!): [Connection!]! 
#   Get Data Source by name
# 
# Arguments
#   project: [Not documented]
#   name: [Not documented]
dataSourceByName(project: String!, name: String!): DataSource! 
#   List Data Sources
# 
# Arguments
#   project: [Not documented]
dataSources(project: String!): [DataSource!]! 
#   Retrieve a Data Stream Status
# 
# Arguments
#   project: The name of the Cortex project
#   resourceType: The type of resource
#   resourceName: The resource name
dataStreamStatus(
project: String!,
resourceType: ResourceType!,
resourceName: String!
): DataStreamStatus! 
#   List Favorite Queries
# 
# Arguments
#   filter: [Not documented]
favoriteQueries(filter: ListFavoriteQueriesInput!): [FavoriteQuery!]! 
#   Get Mission by name
# 
# Arguments
#   project: [Not documented]
#   campaign: [Not documented]
#   name: [Not documented]
missionByName(project: String!, campaign: String!, name: String!): Mission! 
#   List Missions in a Campaign
# 
# Arguments
#   project: [Not documented]
#   campaign: [Not documented]
#   filter: [Not documented]
#   limit: [Not documented]
#   skip: [Not documented]
#   sort: [Not documented]
missions(
project: String!,
campaign: String!,
filter: String,
limit: String,
skip: String,
sort: String
): [Mission!]! 
#   List Profile Links
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the profile schema
#   profileAttribute: The name of the profile attribute
#   linkedProfileSchema: The name of the linked profile schema
#   linkedProfileAttribute: The name of the linked profile 
#   attribute
profileLinks(
project: String!,
profileSchema: String!,
profileAttribute: String,
linkedProfileSchema: String,
linkedProfileAttribute: String
): [ProfileLink!]! 
#   Get Profile Schema by name
# 
# Arguments
#   project: [Not documented]
#   name: [Not documented]
profileSchemaByName(project: String!, name: String!): ProfileSchema! 
#   List profile schemas
# 
# Arguments
#   project: [Not documented]
profileSchemas(project: String!): [ProfileSchema!]! 
#   Get Profile Source by name
# 
# Arguments
#   project: [Not documented]
#   name: [Not documented]
profileSourceByName(
project: String!,
name: String!
): DataSource! @deprecated( reason: "Will be removed, replace with dataSourceByName(project, name)"  )
#   List Profile Sources
# 
# Arguments
#   project: [Not documented]
profileSources(
project: String!
): [DataSource!]! @deprecated( reason: "Will be removed, replace with dataSources(project)"  )
#   Get Project by name
# 
# Arguments
#   name: [Not documented]
projectByName(name: String!): Project! 
#   List Project Count
# 
# Arguments
#   filter: [Not documented]
projectCount(filter: String): Int! 
#   List Projects
# 
# Arguments
#   filter: [Not documented]
#   limit: [Not documented]
#   skip: [Not documented]
#   sort: [Not documented]
projects(filter: String, limit: String, skip: String, sort: String): [Project!]! 
#   Test a Data Source query syntax and connectivity
# 
# Arguments
#   input: [Not documented]
testDataSource(input: DataSourceInput!): [ValidationResponse!]! 
#   Lookup a job by ID
# 
# Arguments
#   project: [Not documented]
#   jobId: [Not documented]
jobById(project: String!, jobId: String!): JobInfo! 
#   List asynchronous jobs for a project
# 
# Arguments
#   project: [Not documented]
jobs(project: String!): [JobInfo!]! 
#   List asynchronous jobs for a resource by type and name
# 
# Arguments
#   project: [Not documented]
#   resourceType: [Not documented]
#   resourceName: [Not documented]
jobsForResource(
project: String!,
resourceType: String!,
resourceName: String!
): [JobInfo!]! 
#   Count profiles in a Cohort based on specified groupings
# 
# Arguments
#   project: The name of the Cortex project
#   campaign: The name of the AI Campaign
#   cohortName: The name of the Cohort in the campaign to query
#   groupBy: The list of attributes to group profiles by
#   limit: Limit the number of profiles counted
cohortGroupCount(
project: String!,
campaign: String!,
cohortName: String!,
groupBy: [String!]!,
limit: Int
): [GroupCount!]! 
#   Preview the Features associated with a Data Source
# 
# Arguments
#   project: The name of the Cortex project
#   source: The name of the Data Source
featuresForSource(project: String!, source: String!): [Feature!]! 
#   Preview the data for a Data Source
# 
# Arguments
#   project: The name of the Cortex project
#   source: The name of the Data Source to preview
previewSource(project: String!, source: String!): SourcePreview! 
#   Retrieves a Profile by ID
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the Profile schema resource (profile 
#   type)
#   id: The unique ID of the Profile
profileById(project: String!, profileSchema: String!, id: ID!): Profile 
#   Count profiles
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the Profile schema resource (profile 
#   type)
#   filter: A ProfileScript used to filter profiles based on their 
#   attributes
profileCount(project: String!, profileSchema: String!, filter: String): Long! 
#   Get the list of profile features (attributes)
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the Profile schema resource (profile 
#   type)
#   campaign: Include campaign feedback attributes
profileFeatures(
project: String!,
profileSchema: String!,
campaign: String
): [Feature!]! 
#   Count profiles based on specified groupings
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the Profile schema resource (profile 
#   type)
#   filter: A ProfileScript used to filter profiles based on their 
#   attributes
#   groupBy: The list of attributes to group profiles by
#   limit: Limit the number of profiles counted
profileGroupCount(
project: String!,
profileSchema: String!,
filter: String,
groupBy: [String!]!,
limit: Int
): [GroupCount!]! 
#   Get the change history for profile data
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the Profile Schema resource (profile 
#   type)
#   limit: The maximum number of entries to return
profileHistory(project: String!, profileSchema: String!, limit: Int): [ProfileCommit!]! 
#   Query profiles
# 
# Arguments
#   project: The name of the Cortex project
#   profileSchema: The name of the Profile schema resource (profile 
#   type)
#   filter: A ProfileScript used to filter profiles based on their 
#   attributes
#   tags: Restrict the returned attributes to those with any of 
#   these tags
#   attributes: Restrict the returned attributes to these keys
#   limit: The maximum number of profiles to return
profiles(
project: String!,
profileSchema: String!,
filter: String,
tags: [String!],
attributes: [String!],
limit: Int
): [Profile!]! 
#   Preview the data schema for a Data Source
# 
# Arguments
#   project: The name of the Cortex project
#   source: The name of the Data Source to preview
schemaForSource(project: String!, source: String!): [SourceField!]! 
#   Get the change history for profile source data
# 
# Arguments
#   project: The name of the Cortex project
#   source: The name of the Data Source
#   limit: The maximum number of entries to return
sourceHistory(project: String!, source: String!, limit: Int): [SourceCommit!]! 
#   Get the ID of the last simulation run for this Mission
# 
# Arguments
#   project: [Not documented]
#   campaign: [Not documented]
#   mission: [Not documented]
#   completedOnly: [Not documented]
lastSimulationId(
project: String!,
campaign: String!,
mission: String!,
completedOnly: Boolean!
): String 
#   List running simulations in a mission
# 
# Arguments
#   project: [Not documented]
#   campaign: [Not documented]
#   mission: [Not documented]
listRunningSimulations(
project: String!,
campaign: String!,
mission: String!
): [SimulationInfo!]! 
#   List simulations in a mission
# 
# Arguments
#   project: [Not documented]
#   campaign: [Not documented]
#   mission: [Not documented]
#   offset: [Not documented]
#   limit: [Not documented]
listSimulations(
project: String!,
campaign: String!,
mission: String!,
offset: Int,
limit: Int
): [SimulationInfo!]! 
#   Retrieve plans generated by a simulation that match a subject filter
# 
# Arguments
#   project: Project name
#   simulationId: ID of the simulation
#   filter: Only return plans that match this filter
#   limit: Limit the number of plans returned
plansForReview(
project: String!,
simulationId: String!,
filter: String,
limit: Int
): PlansForReview! 
#   List profiles for the supplied mission plan
# 
# Arguments
#   project: Project name
#   simulationId: ID of the simulation
#   profileSchema: The name of the Profile schema resource (profile 
#   type)
#   planId: ID of the mission plan
#   filter: Only return plans that match this filter
#   limit: Limit the number of plans returned
profilesForPlan(
project: String!,
simulationId: String!,
profileSchema: String!,
planId: String!,
filter: String,
limit: Int
): [Profile!]! 
#   Get Attributes Used in the Simulation
# 
# Arguments
#   project: Project name
#   simulationId: ID of the simulation
simulationAttributes(project: String!, simulationId: String!): [String!]! 
#   Count profiles in a simulation based on specified groupings
# 
# Arguments
#   project: Project name
#   simulationId: ID of the simulation
#   filter: A filter for the query
#   groupBy: The list of attributes to group profiles by
simulationGroupCount(
project: String!,
simulationId: String!,
filter: String,
groupBy: [String!]!
): [GroupCount!]! 
#   List reviews for a simulation matching the supplied filter
# 
# Arguments
#   project: Project name
#   simulationId: ID of the simulation
#   filter: Addition review filter on fields like reviewId, 
#   reviewerId, cost, finalRank, etc.
#   groupFilter: Group filter used to create the reviews
#   limit: Limit the number of plans returned
simulationReviews(
project: String!,
simulationId: String!,
filter: String,
groupFilter: String,
limit: Int
): [PlanReview!]! 
#   Gets the status of simulation
# 
# Arguments
#   simulationId: [Not documented]
simulationStatus(simulationId: String!): SimulationSummary! 
#   List subject details for a mission plan
# 
# Arguments
#   project: Project name
#   simulationId: ID of the simulation
#   planId: ID of the mission plan
#   profileId: ID of the profile
#   filter: Only return plans that match this filter
#   limit: Limit the number of plans returned
#   keepNonProfileFields: Remove Non Profile Fields
subjectDetailsForPlan(
project: String!,
simulationId: String!,
planId: String!,
profileId: String,
filter: String,
limit: Int,
keepNonProfileFields: Boolean!
): [PlanSubjectDetails!]! 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
