# OracleLabsParallelGraphAnalyticsPgxRestApi.CollectionProxiesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createCollectionProxy**](CollectionProxiesApi.md#createCollectionProxy) | **POST** /core/v1/collectionProxies | Create a collection proxy.
[**getElements**](CollectionProxiesApi.md#getElements) | **GET** /core/v1/collectionProxies/x-proxy-id/elements | Get paginated access to all the elements in the collection.

<a name="createCollectionProxy"></a>
# **createCollectionProxy**
> CollectionProxyResponse createCollectionProxy(body)

Create a collection proxy.

The collection proxy allows you to access the members of a collection in a paginated way and also allows point access.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.CollectionProxiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateCollectionProxyRequest(); // CreateCollectionProxyRequest | Object holding request information to create a collection proxy

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

### Parameters

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

### Return type

[**CollectionProxyResponse**](CollectionProxyResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getElements"></a>
# **getElements**
> getElements(xProxyId, start, size)

Get paginated access to all the elements in the collection.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.CollectionProxiesApi();
let xProxyId = "xProxyId_example"; // String | Specifies the proxy. You can get this through the core endpoint.
let start = 56; // Number | Parameter that specifies an offset for the list of items
let size = 56; // Number | Parameter that specifies the size of the list.

apiInstance.getElements(xProxyId, start, size, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xProxyId** | **String**| Specifies the proxy. You can get this through the core endpoint. | 
 **start** | **Number**| Parameter that specifies an offset for the list of items | 
 **size** | **Number**| Parameter that specifies the size of the list. | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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