Describes a single graph object type: its enum value, the relationships it participates in, and the properties available for use in search query filters and sorts.
Fields
| Field Name | Description |
|---|---|
objectType - GraphObjectType!
|
The graph object type this entry describes. |
objectTypeLabel - String!
|
A localized label for the object type. |
description - String!
|
A description of the object type. |
canLocationFilter - Boolean!
|
True when a search query node of this object type may carry a location filter — i.e. the object type is itself a 2D geographic position (currently only POSITION_SEEN). A location filter on any other object type is rejected. |
relationships - [RelationshipDirected!]
|
The relationships this object type participates in, each paired with the direction in which the relationship may be traversed from this type. |
searchProperties - [GraphObjectSearchProperty!]
|
The properties of this object type that may be used in search results. |
defaultColumns - [ID!]
|
The default search-result columns for this object type, as an ordered list of search property path identifiers. Each value is the id of one of this type's GraphObjectSearchProperty entries. Clients use these to pre-populate column selection when the user has expressed no preference. |
defaultSort - GraphSearchSortInputColumnPayload
|
The default sort column and direction for this object type, or null when results are unsorted by default. When present its propertyPath is the id of one of this type's GraphObjectSearchProperty entries. Clients use this to pre-populate the sort control when the user has expressed no preference. |
Used by
GraphObjectTypeCategoryInfotype: Describes a single GraphObjectTypeCategory together with the graph object types assigned to it.GraphObjectTypesPayloadtype: Payload describing every graph object type known to the security graph along with its relationships and searchable properties.GraphSearchQueryInputinput: Specifies the search criteria for a single graph query: the object type to return, optional time and location filters, relationship constraints, the…GraphSearchResultsPathSegmenttype: A single segment of a GraphSearchResultsPath.
Example
Example
{
"objectType": "ACCOUNT_POLICY",
"objectTypeLabel": "xyz789",
"description": "abc123",
"canLocationFilter": false,
"relationships": [RelationshipDirected],
"searchProperties": [GraphObjectSearchProperty],
"defaultColumns": [4],
"defaultSort": GraphSearchSortInputColumnPayload
}