GraphQL Schema Reference

Query ¶

GraphQL Schema definition ¶

type Query {
#   Query information about an Assessment
# 
# Arguments
#   db: Database to query against
#   id: ID of the Assessment to query
assessment(db: String, id: String!): Assessment 
#   Query for all Assessments in the given database
# 
# Arguments
#   db: The database to query
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
assessments(
db: String!,
filter: AssessmentFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): AssessmentConnection 
#   Query for Assessments in the given ID list and database
# 
# Arguments
#   db: The database to query
#   ids: The list of Assessment IDs to retrieve
assessmentsByIds(db: String!, ids: [String]!): AssessmentConnection 
#   Query information about an Assessment
# 
# Arguments
#   id: ID of the Assessment to query
libraryAssessment(id: String!): Assessment 
#   Query for all Library Assessments
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
libraryAssessments(
filter: AssessmentFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): AssessmentConnection 
#   Query for Assessments in the given ID list and database
# 
# Arguments
#   ids: The list of Assessment IDs to retrieve
libraryAssessmentsByIds(ids: [String]!): AssessmentConnection 
# Arguments
#   envAssessmentId: 
#   envAssessmentName: 
#   clAssessmentId: 
getMatchingClAssessmentsForEnvAssessment(
envAssessmentId: Int!,
envAssessmentName: String,
clAssessmentId: String
): MatchingAssessmentResult 
#   Query information about a Campaign
# 
# Arguments
#   db: Database to query against
#   id: ID of the Campaign to query
campaign(db: String!, id: String!): Campaign 
#   Query for all Campaigns in the given database
# 
# Arguments
#   db: The database to query
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
campaigns(
db: String!,
filter: CampaignFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): CampaignConnection 
#   Query for Campaigns in the given ID list and database
# 
# Arguments
#   db: The database to query
#   ids: The list of Campaign IDs to retrieve
campaignsByIds(db: String!, ids: [String]!): CampaignConnection 
# Arguments
#   id: 
libraryCampaign(id: String!): Campaign 
# Arguments
#   filter: 
#   first: 
#   after: 
#   orderBy: 
libraryCampaigns(
filter: CampaignFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): CampaignConnection 
# Arguments
#   ids: 
libraryCampaignsByIds(ids: [String]!): CampaignConnection 
# Arguments
#   envCampaignId: 
#   envCampaignName: 
#   clCampaignId: 
getMatchingClCampaignsForEnvCampaign(
envCampaignId: Int!,
envCampaignName: String,
clCampaignId: String
): MatchingCampaignResult 
#   Query for Database list
databases: [Database] 
#   Query information about a Defensive Layer
# 
# Arguments
#   db: Database to query against
#   id: ID of the Defensive Layer to query
defensivelayer(db: String!, id: String!): DefensiveLayer 
#   Query for all Defensive Layers in the given database
# 
# Arguments
#   db: The database to query
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
defensivelayers(
db: String!,
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): DefensiveLayerConnection 
#   Query for Defensive Layers in the given ID list and database
# 
# Arguments
#   db: The database to query
#   ids: The list of Defensive Layer IDs to retrieve
defensivelayersByIds(db: String!, ids: [String]!): DefensiveLayerConnection 
#   Query information about a Defensive Layer
# 
# Arguments
#   id: ID of the Defensive Layer to query
libraryDefensivelayer(id: String!): DefensiveLayer 
#   Query for all Defensive Layers in the given database
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
libraryDefensivelayers(
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): DefensiveLayerConnection 
#   Query for Defensive Layers in the given ID list and database
# 
# Arguments
#   ids: The list of Defensive Layer IDs to retrieve
libraryDefensivelayersByIds(ids: [String]!): DefensiveLayerConnection 
#   Query for all defense tool products
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
defenseToolProducts(
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): DefenseToolProductsConnection 
# Arguments
#   ids: The list of Defense Tool Products IDs to retrieve
defenseToolProductsByIds(ids: [String]!): DefenseToolProductsConnection 
#   Query information about a blue / defense tool
# 
# Arguments
#   db: The database to query
#   id: ID of the blue tool to query
bluetool(db: String!, id: String!): BlueTool 
#   Query for all blue tools in the given database
# 
# Arguments
#   db: The database to query
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
bluetools(
db: String!,
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): BlueToolConnection 
#   Query information about a blue / defense tool
# 
# Arguments
#   id: ID of the blue tool to query
libraryBluetool(id: String!): BlueTool 
#   Query for all blue tools in the Content Library
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
libraryBluetools(
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): BlueToolConnection 
# Arguments
#   ids: The list of Exec Artifact IDs to retrieve
executionArtifactsByIds(ids: [Int!]!): ExecutionArtifactConnection 
# Arguments
#   tagType: 
myFavoriteTagIds(tagType: TagTypeEnum): FavoriteTagIds 
#   Query information about a specific Kill Chain
# 
# Arguments
#   id: ID of the Kill Chain to query
killchain(id: String!): KillChain 
#   Query for all Kill Chains in the given database
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
killchains(
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): KillChainConnection 
#   Query for Kill Chains in the given ID list and database
# 
# Arguments
#   ids: The list of Kill Chain IDs to retrieve
killchainsByIds(ids: [String]!): KillChainConnection 
# Arguments
#   db: 
#   filter: 
metadataSummary(db: String!, filter: MetadataSummaryFilter): MetadataSummary 
#       # Query information about a specific Outcome
# 
# Arguments
#   id: ID of the Outcome to query
outcome(id: String!): Outcome 
#       # Query for a flat collection of all Outcomes
outcomes: [Outcome] 
#       # Query for entire Outcome Tree organized as nodes and children elements
outcomesTree: [OutcomeTreeNode] 
#    Query information about a specific Organizations
# 
# Arguments
#   id: ID of the Organizations to query
organization(id: String!): Organization 
#   Query for all Organizations
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
organizations(
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): OrganizationConnection 
#    Query information about a specific Phase
# 
# Arguments
#   id: ID of the Phase to query
phase(id: String!): Phase 
#   Query for all Phases in the given database
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
phases(filter: NameFilter, first: Int, after: String, orderBy: BaseSortOrder): PhaseConnection 
#   Query for Phases in the given ID list and database
# 
# Arguments
#   ids: The list of Phase IDs to retrieve
phasesByIds(ids: [String]!): PhaseConnection 
#       # Query information about a red tool
# 
# Arguments
#   db: The database to query
#   id: ID of the red tool to query
redtool(db: String!, id: String!): RedTool 
#    Query for all red tools in the given database
# 
# Arguments
#   db: The database to query
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
redtools(db: String!, first: Int, after: String, orderBy: BaseSortOrder): RedToolConnection 
#   Query for entire Outcome Tree organized as nodes and children elements
reportingBucketsTree: [ReportingBucketTreeNode] 
#   Query for information about a red tool in the Content Library
# 
# Arguments
#   id: ID of the red tool to query
libraryRedtool(id: String!): RedTool 
#   Query for all red tools in the Content Library
# 
# Arguments
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
libraryRedtools(first: Int, after: String, orderBy: BaseSortOrder): RedToolConnection 
#   Query for information about a Tag
# 
# Arguments
#   id: ID of the tag to query
tag(id: String!): Tag 
#   Query for all Tags
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
tags(filter: TagFilter, first: Int, after: String, orderBy: BaseSortOrder): TagConnection 
tagTypes: [TagType] 
#   Query information about a specific Test Case
# 
# Arguments
#   db: Database to query against
#   id: ID of the TestCase to query
testcase(db: String!, id: String!): TestCase 
#   Query for all Test Cases in the given database
# 
# Arguments
#   db: The database to query
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
testcases(
db: String!,
filter: TestCaseFilter,
first: Int,
after: String,
orderBy: TestCaseSortOrder
): TestCaseConnection 
#   Query for Test Cases in the given ID list and database
# 
# Arguments
#   db: The database to query
#   ids: The list of Test Cases IDs to retrieve
testcasesByIds(db: String!, ids: [String]!): TestCaseConnection 
#   Query information about a specific Test Case
# 
# Arguments
#   id: ID of the TestCase to query
libraryTestcase(id: String!): TestCase 
#   Query for all Library Test Cases
# 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
libraryTestcases(
filter: TestCaseFilter,
first: Int,
after: String,
orderBy: TestCaseSortOrder
): TestCaseConnection 
# Arguments
#   ids: The list of Test Cases IDs to retrieve
libraryTestcasesByIds(ids: [String]!): TestCaseConnection 
# Arguments
#   envTestCaseId: 
#   envTestCaseName: 
#   clTestCaseId: 
getMatchingClTestCasesForEnvTestCase(
envTestCaseId: Int!,
envTestCaseName: String,
clTestCaseId: String
): MatchingTestCaseResult 
# Arguments
#   db: Database to query against
#   id: ID of the Vendor to query
vendor(db: String!, id: String!): Vendor 
#   Query for all Vendors in the given database
# 
# Arguments
#   db: The database to query
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
vendors(
db: String!,
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): VendorConnection 
#   Query for Vendor information in the given ID list and database
# 
# Arguments
#   db: The database to query
#   ids: The list of Vendor IDs to retrieve
vendorsByIds(db: String!, ids: [String]!): VendorConnection 
# Arguments
#   id: ID of the Vendor to query
libraryVendor(id: String!): Vendor 
# Arguments
#   filter: A filter to return a subset of data
#   first: Returns the first _n_ elements from the list
#   after: Returns the elements in the list that come after the 
#   specified cursor
#   orderBy: Sorting options
libraryVendors(
filter: NameFilter,
first: Int,
after: String,
orderBy: BaseSortOrder
): VendorConnection 
# Arguments
#   ids: The list of Vendor IDs to retrieve
libraryVendorsByIds(ids: [String]!): VendorConnection 
# Arguments
#   ids: List of Unstructured Log IDs to retrieve
unstructuredLogsByIds(ids: [String!]!): UnstructuredLogConnection 
vectrAppConfig: VectrAppConfig 
vectrUploadedSSLConfig: UploadedVectrSSLConfig 
vectrSSLConfig: VectrSSLConfig 
}
Require by ¶

This element is not required by anyone