Generate a network

post/graphs
Internal-Use Only

Provides access to the Network visualization. Returns a graph showing the objects that matched the search request as vertices and the relationships between them as edges.

Request Samples

1

Response Samples

1{
2  "counts": {
3    "edges": 2,
4    "vertices": 4
5  },
6  "vertices": [
7    {
8      "id": "10",
9      "type": "claim",
10      "typeLabel": "Claim",
11      "label": "Claim: 0009900136650",
12      "attachmentsCount": 3,
13      "adjacent": 1,
14      "degree": 1
15    },
16    {
17      "id": "73",
18      "type": "address",
19      "typeLabel": "Address",
20      "label": "1203 SAMUEL ADAMS CIR, CONCORD, NC",
21      "attachmentsCount": 1,
22      "adjacent": 3,
23      "degree": 3
24    },
25    {
26      "id": "4",
27      "type": "claim",
28      "typeLabel": "Claim",
29      "label": "Claim: 0009900073608",
30      "attachmentsCount": 2,
31      "adjacent": 1,
32      "degree": 1
33    },
34    {
35      "id": "115",
36      "type": "person",
37      "typeLabel": "Person",
38      "compoundValues": [
39        "Smith 1982-03-14"
40      ],
41      "label": "John Smith",
42      "adjacent": 2001,
43      "degree": 2001
44    }
45  ],
46  "edges": [
47    {
48      "id": "9",
49      "type": "entityRelationship",
50      "label": "regarding",
51      "endpoints": [
52        {
53          "id": "10",
54          "type": "claim"
55        },
56        {
57          "id": "73",
58          "type": "address"
59        }
60      ]
61    },
62    {
63      "id": "5",
64      "type": "resolvedEntityRelationship",
65      "label": "raised by",
66      "compoundValues": [
67        "Smith 1982-03-14"
68      ],
69      "endpoints": [
70        {
71          "id": "4",
72          "type": "claim"
73        },
74        {
75          "id": "115",
76          "type": "person",
77          "compoundValues": [
78            "Smith 1982-03-14"
79          ]
80        }
81      ]
82    }
83  ],
84  "expansionLimit": 2000,
85  "expansionLimitExceeded": [
86    {
87      "type": "person",
88      "id": "115"
89    }
90  ]
91}

Query Parameters

NameTypeRequiredDescription
calculateMetrics
boolean
false

Whether to calculate the degree and adjacent counts for all the vertices. As this calculation is expensive, it can take some time particularly for highly connected vertices. Skipping the calculation is recommended when the counts are not needed or when generating the counts leads to a poor user experience.

Default:
true
expansionLimit
integer
false

The maximum number of adjacent vertices per vertex in the graph. If a value greater than zero is specified and any vertices exceed the limit, then those vertices will be excluded from the edge search and the metrics calculation.

Default:
2000
metricsAggregationLimit
integer
false

The aggregation used to exclude highly connected vertices from the metrics calculation will be skipped when the number of leaf vertices exceeds this limit. The default value of -1 means the aggregation will always run; a value of 0 means the aggregation will never run.

Default:
-1
metricsLimit
integer
false

The maximum number of new vertices to be found by the search when calculating the metrics. If a value greater than zero is specified and the number of new vertices found by the search exceeds the limit, then the search will be canceled and a message will be returned.

Default:
5000

Request Body

The request to /graphs for obtaining the Network visualization. In the network, objects are represented by vertices and the relationships between them are represented by edges.

NameTypeRequiredDescription
version
integer
false

The representation version (2).

vertexTypes
array [string]
false

The optional list of object type names for restricting the search to particular types. If missing, all types will be included in the search.

edgeTypes
array [string]
false

The optional list of relationship type names for restricting the search to particular types. If missing, all types will be included in the search.

query
Query or anyOf
QueryTypeAndQueryTypeCompoundQueryTypeObjectQueryTypeOrQueryTypeText
false

The different query types that can be used to search for objects. See specific query definitions for more details.

filter
Filter or oneOf
FilterTypeAndFilterTypeBoxFilterTypeDateRangeFilterTypeNotFilterTypeOrFilterTypePolygonFilterTypeQueryFilterTypeRadiusFilterTypeRangeFilterTypeTermsFilterTypeTypeFilterTypeShape
false

The different filter types that can be applied to narrow or drill down into the search results. See specific filter definitions for more details.

selection
Selection
false

The criteria by which search results are marked as selected. In order to perform certain tasks within SAS Visual Investigator, such as adding search results to a workspace or expanding nodes in a network, the search results must first be selected. Manually selecting large numbers of results can be tedious and therefore SAND allows manual selection to be combined with query-based selection (all matching objects are marked as selected) and facet-based selection (all objects matching any of the filters will be marked as selected). The filter parameter represents the facet-based selection; the include parameter represents the manual and query based selections; the exclude parameter represents the manual and query based de-selections. All parameters are optional such that selections can be made by filter only, by include query only, or by object references and compound values. Objects matching either the filter or the include parameter will be selected as long as they do not match the exclude parameter.

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
400Bad RequestThe request is malformed or contains invalid parameter values.Schema