# OracleLabsParallelGraphAnalyticsPgxRestApi.ScalarsApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createScalar**](ScalarsApi.md#createScalar) | **POST** /core/v1/scalars | Create a scalar
[**destroyScalar**](ScalarsApi.md#destroyScalar) | **DELETE** /core/v1/scalars/x-scalar-name | Delete a scalar
[**getScalarValue**](ScalarsApi.md#getScalarValue) | **GET** /core/v1/scalars/x-scalar-name/value | Get the value of a scalar
[**setScalarValue**](ScalarsApi.md#setScalarValue) | **PUT** /core/v1/scalars/x-scalar-name/value | Set the value of a scalar

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

Create a scalar

Scalar values are required if a algorithm requires out arguments. You can pass the algorithm the name of a scalar and it will set the value of that scalar. You can get the value of the scalar after the algorithm completed.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.ScalarsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateScalarRequest(); // CreateScalarRequest | Holds the properties of a create scalar request.
let SID = "SID_example"; // String | session ID

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateScalarRequest**](CreateScalarRequest.md)| Holds the properties of a create scalar request. | 
 **SID** | **String**| session ID | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="destroyScalar"></a>
# **destroyScalar**
> destroyScalar(SID, xScalarName, opts)

Delete a scalar

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.ScalarsApi();
let SID = "SID_example"; // String | session ID
let xScalarName = "xScalarName_example"; // String | the scalar name.
let opts = { 
  'ignoreNotFound': false, // Boolean | 
  'csrfToken': "csrfToken_example" // String | CSRF token
};
apiInstance.destroyScalar(SID, xScalarName, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xScalarName** | **String**| the scalar name. | 
 **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="getScalarValue"></a>
# **getScalarValue**
> ScalarValue getScalarValue(SID, xScalarName)

Get the value of a scalar

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.ScalarsApi();
let SID = "SID_example"; // String | session ID
let xScalarName = "xScalarName_example"; // String | the scalar name.

apiInstance.getScalarValue(SID, xScalarName, (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 | 
 **xScalarName** | **String**| the scalar name. | 

### Return type

[**ScalarValue**](ScalarValue.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="setScalarValue"></a>
# **setScalarValue**
> setScalarValue(body, SID, xScalarName)

Set the value of a scalar

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.ScalarsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.SetScalarValueRequest(); // SetScalarValueRequest | Holds the parameters needed for a set scalar value request.
let SID = "SID_example"; // String | session ID
let xScalarName = "xScalarName_example"; // String | the scalar name.

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SetScalarValueRequest**](SetScalarValueRequest.md)| Holds the parameters needed for a set scalar value request. | 
 **SID** | **String**| session ID | 
 **xScalarName** | **String**| the scalar name. | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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