# OracleLabsParallelGraphAnalyticsPgxRestApi.VerticesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getEdgeCount**](VerticesApi.md#getEdgeCount) | **GET** /core/v1/graphs/x-graph-id/vertices/x-vertex-id/edgeCount | Get the out edge count
[**getEdges**](VerticesApi.md#getEdges) | **GET** /core/v1/graphs/x-graph-id/vertices/x-vertex-id/connectedEdges | List the connected edges to a vertex
[**getNeighbors**](VerticesApi.md#getNeighbors) | **GET** /core/v1/graphs/x-graph-id/vertices/x-vertex-id/neighbors | List vertex neighbors
[**getVertexFromKey**](VerticesApi.md#getVertexFromKey) | **GET** /core/v1/graphs/x-graph-id/vertices/x-vertex-id | Get a specific vertex
[**getVertexLabels**](VerticesApi.md#getVertexLabels) | **GET** /core/v1/graphs/x-graph-id/vertices/x-vertex-id/labelsSet | Get vertex Labels

<a name="getEdgeCount"></a>
# **getEdgeCount**
> getEdgeCount(SID, xGraphId, xVertexId, direction)

Get the out edge count

Gets the out edge count according to the selected direction

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.VerticesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | id of the graph
let xVertexId = "xVertexId_example"; // String | string key of the vertex
let direction = "direction_example"; // String | session ID

apiInstance.getEdgeCount(SID, xGraphId, xVertexId, direction, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| id of the graph | 
 **xVertexId** | **String**| string key of the vertex | 
 **direction** | **String**| session ID | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getEdges"></a>
# **getEdges**
> [Edge] getEdges(SID, xGraphId, xVertexId, direction, opts)

List the connected edges to a vertex

Get all the Edges according to the selected direction

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.VerticesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | id of the graph
let xVertexId = "xVertexId_example"; // String | string key of the vertex
let direction = "direction_example"; // String | Incoming or Outgoing
let opts = { 
  'wrapped': true // Boolean | indicate if the vertex is wrapped in a Vertex
};
apiInstance.getEdges(SID, xGraphId, xVertexId, direction, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| id of the graph | 
 **xVertexId** | **String**| string key of the vertex | 
 **direction** | **String**| Incoming or Outgoing | 
 **wrapped** | **Boolean**| indicate if the vertex is wrapped in a Vertex | [optional] 

### Return type

[**[Edge]**](Edge.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getNeighbors"></a>
# **getNeighbors**
> [Vertex] getNeighbors(SID, xGraphId, xVertexId, direction, idType, opts)

List vertex neighbors

Get all the neighbors nodes according to the selected direction

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.VerticesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | id of the graph
let xVertexId = "xVertexId_example"; // String | string key of the vertex
let direction = "direction_example"; // String | Incoming or Outgoing
let idType = "idType_example"; // String | the Id type for the entity we are looking for (please respect the case)
let opts = { 
  'wrapped': true // Boolean | indicate if the vertex is wrapped in a Vertex
};
apiInstance.getNeighbors(SID, xGraphId, xVertexId, direction, idType, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| id of the graph | 
 **xVertexId** | **String**| string key of the vertex | 
 **direction** | **String**| Incoming or Outgoing | 
 **idType** | **String**| the Id type for the entity we are looking for (please respect the case) | 
 **wrapped** | **Boolean**| indicate if the vertex is wrapped in a Vertex | [optional] 

### Return type

[**[Vertex]**](Vertex.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getVertexFromKey"></a>
# **getVertexFromKey**
> Vertex getVertexFromKey(SID, xGraphId, idType, xVertexId)

Get a specific vertex

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.VerticesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | id of the graph
let idType = "idType_example"; // String | the Id type for the entity we are looking for (please respect the case)
let xVertexId = "xVertexId_example"; // String | string key of the vertex

apiInstance.getVertexFromKey(SID, xGraphId, idType, xVertexId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| id of the graph | 
 **idType** | **String**| the Id type for the entity we are looking for (please respect the case) | 
 **xVertexId** | **String**| string key of the vertex | 

### Return type

[**Vertex**](Vertex.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getVertexLabels"></a>
# **getVertexLabels**
> VertexLabels getVertexLabels(SID, xGraphId, xVertexId, idType, opts)

Get vertex Labels

Get the labels of the given vertex.

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.VerticesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xVertexId = "xVertexId_example"; // String | string key of the vertex
let idType = "idType_example"; // String | the Id type for the entity we are looking for (please respect the case)
let opts = { 
  'keyWrapped': true // Boolean | indicates if the key is wrapped
};
apiInstance.getVertexLabels(SID, xGraphId, xVertexId, idType, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| Id of the graph. | 
 **xVertexId** | **String**| string key of the vertex | 
 **idType** | **String**| the Id type for the entity we are looking for (please respect the case) | 
 **keyWrapped** | **Boolean**| indicates if the key is wrapped | [optional] 

### Return type

[**VertexLabels**](VertexLabels.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json