Get the details for a vertex

get/vertices/{type}/{identifier}
Internal-Use Only

Returns additional information about a single vertex on the Network visualization. This is intended to be used to enhance the Network visualization after retrieving it from /graphs or /traversals; the response from which includes the values for this resource's parameters. The additional information includes the label, adjacent (number of vertices one edge away from this vertex), degree (number of edges entering and leaving the vertex), the adjacent count broken down by entity type, and the degree broken down by relationship type.

Request Samples

1

Response Samples

1{
2  "id": "337",
3  "type": "report",
4  "typeLabel": "Report",
5  "label": "Theft of red bmw reported by John Smith",
6  "attachmentsCount": 1,
7  "adjacent": 4,
8  "degree": 5,
9  "adjacentByType": {
10    "person": 1,
11    "report": 3
12  },
13  "degreeByType": {
14    "mentions": 2,
15    "related to": 3
16  },
17  "fields": [
18    {
19      "name": "reportedAt",
20      "type": "date",
21      "value": "2012-01-05"
22    }
23  ],
24  "validFrom": "2001-08-16T05:00:00Z",
25  "validTo": "2014-10-25T17:00:00Z",
26  "selected": false,
27  "style": {
28    "iconName": "reportIcon1",
29    "markerColor": "#ffffff",
30    "backgroundColor": "#ffffff",
31    "shape": "square",
32    "scale": 1,
33    "additionalLabel": "Information Report",
34    "indicatorIcons": [
35      {
36        "name": "High Priority",
37        "position": "N"
38      },
39      {
40        "name": "Verified",
41        "position": "S"
42      }
43    ]
44  }
45}

Path Parameters

NameTypeRequiredDescription
identifier
string
true

The unique identifier for the vertex.

type
string
true

The name of the entity type for the vertex.

Query Parameters

NameTypeRequiredDescription
expansionLimit
integer
false

The maximum number of adjacent vertices. If a value greater than zero is specified and the vertex exceeds the limit, the metrics calculation will be skipped and no degree and adjacent information will be returned.

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 no degree and adjacent information will be returned.

Default:
5000

Responses

StatusMeaningDescription
200OKThe request succeeded.Schema
404Not FoundThe type does not exist or the vertex does not exist.Schema