# OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**cloneProperty**](PropertiesApi.md#cloneProperty) | **POST** /core/v1/graphs/x-graph-id/properties/x-property-name/clone | Clone a property
[**createProperty**](PropertiesApi.md#createProperty) | **POST** /core/v1/graphs/x-graph-id/properties | Create a property
[**deleteProperty**](PropertiesApi.md#deleteProperty) | **DELETE** /core/v1/graphs/x-graph-id/properties/x-property-name | Delete a property
[**expandProperty**](PropertiesApi.md#expandProperty) | **POST** /core/v1/graphs/x-graph-id/properties/x-property-name/expand | Expand a vector property
[**fillProperty**](PropertiesApi.md#fillProperty) | **PUT** /core/v1/graphs/x-graph-id/properties/x-property-name/fillValue | Fill a property with values
[**getPropertyValue**](PropertiesApi.md#getPropertyValue) | **GET** /core/v1/graphs/x-graph-id/properties/x-property-name/values/x-property-key | Get the value of a property
[**propertyIsPublished**](PropertiesApi.md#propertyIsPublished) | **GET** /core/v1/graphs/x-graph-id/properties/x-property-name/isPublished | Check if property is published
[**publishProperty**](PropertiesApi.md#publishProperty) | **POST** /core/v1/graphs/x-graph-id/properties/x-property-name/publish | Publish a property
[**renameProperty**](PropertiesApi.md#renameProperty) | **PUT** /core/v1/graphs/x-graph-id/properties/x-property-name/name | Rename a property

<a name="cloneProperty"></a>
# **cloneProperty**
> Property cloneProperty(body, SID, xGraphId, xPropertyName)

Clone a property

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.MovePropertyRequest(); // MovePropertyRequest | Holds the parameters for a clone property request.
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**MovePropertyRequest**](MovePropertyRequest.md)| Holds the parameters for a clone property request. | 
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| Id of the graph. | 
 **xPropertyName** | **String**| ID of the property. | 

### Return type

[**Property**](Property.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="createProperty"></a>
# **createProperty**
> Property createProperty(body, SID, xGraphId)

Create a property

Create either a node property or edge property on the graph you specify.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreatePropertyRequest(); // CreatePropertyRequest | Object which holds the information what kind of property should be created.
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreatePropertyRequest**](CreatePropertyRequest.md)| Object which holds the information what kind of property should be created. | 
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| Id of the graph. | 

### Return type

[**Property**](Property.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deleteProperty"></a>
# **deleteProperty**
> deleteProperty(SID, xGraphId, xPropertyName, entityType, opts)

Delete a property

After this call the property will not be accessible any more and the memory will be garbage collected eventually.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.
let entityType = "entityType_example"; // String | Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose
let opts = { 
  'ignoreNotFound': false, // Boolean | 
  'csrfToken': "csrfToken_example" // String | CSRF token
};
apiInstance.deleteProperty(SID, xGraphId, xPropertyName, entityType, opts, (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. | 
 **xPropertyName** | **String**| ID of the property. | 
 **entityType** | **String**| Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose | 
 **ignoreNotFound** | **Boolean**|  | [optional] [default to false]
 **csrfToken** | **String**| CSRF token | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="expandProperty"></a>
# **expandProperty**
> [Property] expandProperty(body, SID, xGraphId, xPropertyName)

Expand a vector property

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ExpandPropertyRequest(); // ExpandPropertyRequest | Holds the parameters for a expand property request.
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ExpandPropertyRequest**](ExpandPropertyRequest.md)| Holds the parameters for a expand property request. | 
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| Id of the graph. | 
 **xPropertyName** | **String**| ID of the property. | 

### Return type

[**[Property]**](Property.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="fillProperty"></a>
# **fillProperty**
> fillProperty(SID, xGraphId, xPropertyName)

Fill a property with values

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.

apiInstance.fillProperty(SID, xGraphId, xPropertyName, (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. | 
 **xPropertyName** | **String**| ID of the property. | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getPropertyValue"></a>
# **getPropertyValue**
> PropertyValue getPropertyValue(SID, xGraphId, xPropertyName, entityType, xPropertyKey, idType, opts)

Get the value of a property

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.
let entityType = "entityType_example"; // String | Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose
let xPropertyKey = "xPropertyKey_example"; // String | key of the node/edge we want to get the property value for
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.getPropertyValue(SID, xGraphId, xPropertyName, entityType, xPropertyKey, 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. | 
 **xPropertyName** | **String**| ID of the property. | 
 **entityType** | **String**| Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose | 
 **xPropertyKey** | **String**| key of the node/edge we want to get the property value for | 
 **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

[**PropertyValue**](PropertyValue.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="propertyIsPublished"></a>
# **propertyIsPublished**
> propertyIsPublished(SID, xGraphId, xPropertyName, entityType)

Check if property is published

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.
let entityType = "entityType_example"; // String | Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose

apiInstance.propertyIsPublished(SID, xGraphId, xPropertyName, entityType, (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. | 
 **xPropertyName** | **String**| ID of the property. | 
 **entityType** | **String**| Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="publishProperty"></a>
# **publishProperty**
> publishProperty(SID, xGraphId, xPropertyName, entityType, opts)

Publish a property

Publish a property so It can be shared between sessions.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.
let entityType = "entityType_example"; // String | Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose
let opts = { 
  'body': new OracleLabsParallelGraphAnalyticsPgxRestApi.UnsafeHttpMethodRequest() // UnsafeHttpMethodRequest | Holds the CSRF parameter for a request.
};
apiInstance.publishProperty(SID, xGraphId, xPropertyName, entityType, opts, (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. | 
 **xPropertyName** | **String**| ID of the property. | 
 **entityType** | **String**| Specify whether the property name is of a node or edge property. If your graph has an edge property and a node property with the same name, you need this to distinguish which one to to choose | 
 **body** | [**UnsafeHttpMethodRequest**](UnsafeHttpMethodRequest.md)| Holds the CSRF parameter for a request. | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="renameProperty"></a>
# **renameProperty**
> renameProperty(body, SID, xGraphId, xPropertyName)

Rename a property

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PropertiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.MovePropertyRequest(); // MovePropertyRequest | Object which specifies details on how the property should be renamed.
let SID = "SID_example"; // String | session ID
let xGraphId = "xGraphId_example"; // String | Id of the graph.
let xPropertyName = "xPropertyName_example"; // String | ID of the property.

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**MovePropertyRequest**](MovePropertyRequest.md)| Object which specifies details on how the property should be renamed. | 
 **SID** | **String**| session ID | 
 **xGraphId** | **String**| Id of the graph. | 
 **xPropertyName** | **String**| ID of the property. | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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