# OracleLabsParallelGraphAnalyticsPgxRestApi.PathProxiesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createAllPathsProxy**](PathProxiesApi.md#createAllPathsProxy) | **POST** /core/v1/pathProxies | Get an all-paths proxy
[**getPath**](PathProxiesApi.md#getPath) | **GET** /core/v1/pathProxies/x-proxy-id/paths/x-destination | Get a specific path of an all-paths proxy object

<a name="createAllPathsProxy"></a>
# **createAllPathsProxy**
> AllPathsProxyResponse createAllPathsProxy(body, SID)

Get an all-paths proxy

The all-paths proxy gives you access to a set of path proxies

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PathProxiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.AllPathsProxyRequest(); // AllPathsProxyRequest | the body specifying the all-paths proxy request parameters
let SID = "SID_example"; // String | session ID

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**AllPathsProxyRequest**](AllPathsProxyRequest.md)| the body specifying the all-paths proxy request parameters | 
 **SID** | **String**| session ID | 

### Return type

[**AllPathsProxyResponse**](AllPathsProxyResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getPath"></a>
# **getPath**
> SerializedPathProxy getPath(SID, xProxyId, destValueType, xDestination, opts)

Get a specific path of an all-paths proxy object

Given a all-paths proxy ID and a destination vertex ID, returns the corresponding path

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PathProxiesApi();
let SID = "SID_example"; // String | session ID
let xProxyId = "xProxyId_example"; // String | the all-paths proxy ID
let destValueType = "destValueType_example"; // String | the type of the given destination vertex ID
let xDestination = "xDestination_example"; // String | the destination vertex ID value
let opts = { 
  'destValueWrapped': true // Boolean | is the destination vertex wrapped
};
apiInstance.getPath(SID, xProxyId, destValueType, xDestination, 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 | 
 **xProxyId** | **String**| the all-paths proxy ID | 
 **destValueType** | **String**| the type of the given destination vertex ID | 
 **xDestination** | **String**| the destination vertex ID value | 
 **destValueWrapped** | **Boolean**| is the destination vertex wrapped | [optional] 

### Return type

[**SerializedPathProxy**](SerializedPathProxy.md)

### Authorization

No authorization required

### HTTP request headers

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