# OracleLabsParallelGraphAnalyticsPgxRestApi.ComponentsProxiesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createComponentsProxy**](ComponentsProxiesApi.md#createComponentsProxy) | **POST** /core/v1/componentsProxies | Create a components proxy
[**getComponentIdForNode**](ComponentsProxiesApi.md#getComponentIdForNode) | **GET** /core/v1/componentsProxies/x-proxy-id/componentIds/x-node | Get one specific component

<a name="createComponentsProxy"></a>
# **createComponentsProxy**
> ComponentsProxyResponse createComponentsProxy(body)

Create a components proxy

It allows you to access the components of a graph. Components are created based on the property you specify and limited by the numComponents parameter.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComponentsProxiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateComponentsProxyRequest(); // CreateComponentsProxyRequest | Object holding request information to create a components proxy

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateComponentsProxyRequest**](CreateComponentsProxyRequest.md)| Object holding request information to create a components proxy | 

### Return type

[**ComponentsProxyResponse**](ComponentsProxyResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getComponentIdForNode"></a>
# **getComponentIdForNode**
> ComponentsProxyResponse getComponentIdForNode(xProxyId, xNode, nodeType, opts)

Get one specific component

Get one specific component, based on its component id

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComponentsProxiesApi();
let xProxyId = "xProxyId_example"; // String | Specifies the proxy. You can get this through the core endpoint.
let xNode = "xNode_example"; // String | The node to request the component from.
let nodeType = "nodeType_example"; // String | the Id type for the entity we are looking for (please respect the case)
let opts = { 
  'nodeWrapped': true // Boolean | is the vertex wrapped
};
apiInstance.getComponentIdForNode(xProxyId, xNode, nodeType, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xProxyId** | **String**| Specifies the proxy. You can get this through the core endpoint. | 
 **xNode** | **String**| The node to request the component from. | 
 **nodeType** | **String**| the Id type for the entity we are looking for (please respect the case) | 
 **nodeWrapped** | **Boolean**| is the vertex wrapped | [optional] 

### Return type

[**ComponentsProxyResponse**](ComponentsProxyResponse.md)

### Authorization

No authorization required

### HTTP request headers

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