# OracleLabsParallelGraphAnalyticsPgxRestApi.EdgesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getEdge**](EdgesApi.md#getEdge) | **GET** /core/v1/graphs/x-graph-id/edges/x-edge-id | Get a specific edge
[**getEdgeLabel**](EdgesApi.md#getEdgeLabel) | **GET** /core/v1/graphs/x-graph-id/edges/x-edge-id/label | Get the label of a given edge
[**getVertexFromEdge**](EdgesApi.md#getVertexFromEdge) | **GET** /core/v1/graphs/x-graph-id/edges/x-edge-id/vertex | Get a vertex from an edge

<a name="getEdge"></a>
# **getEdge**
> Edge getEdge(SID, xGraphId, idType, xEdgeId)

Get a specific edge

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.EdgesApi();
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 xEdgeId = "xEdgeId_example"; // String | string key of the edge

apiInstance.getEdge(SID, xGraphId, idType, xEdgeId, (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) | 
 **xEdgeId** | **String**| string key of the edge | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="getEdgeLabel"></a>
# **getEdgeLabel**
> EdgeLabel getEdgeLabel(SID, xGraphId, xEdgeId, opts)

Get the label of a given edge

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.EdgesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xEdgeId = "xEdgeId_example"; // String | string key of the edge
let opts = { 
  'idType': "idType_example", // String | 
  'keyWrapped': true // Boolean | indicates if the key is wrapped
};
apiInstance.getEdgeLabel(SID, xGraphId, xEdgeId, 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. | 
 **xEdgeId** | **String**| string key of the edge | 
 **idType** | **String**|  | [optional] 
 **keyWrapped** | **Boolean**| indicates if the key is wrapped | [optional] 

### Return type

[**EdgeLabel**](EdgeLabel.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getVertexFromEdge"></a>
# **getVertexFromEdge**
> Vertex getVertexFromEdge(SID, xGraphId, xEdgeId, direction, opts)

Get a vertex from an edge

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.EdgesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xEdgeId = "xEdgeId_example"; // String | string key of the edge
let direction = "direction_example"; // String | Incoming or Outgoing
let opts = { 
  'wrapped': true // Boolean | is the edge wrapped
};
apiInstance.getVertexFromEdge(SID, xGraphId, xEdgeId, 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. | 
 **xEdgeId** | **String**| string key of the edge | 
 **direction** | **String**| Incoming or Outgoing | 
 **wrapped** | **Boolean**| is the edge wrapped | [optional] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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