Skip to content

Latest commit

 

History

History
293 lines (173 loc) · 6.58 KB

DataSetApi.md

File metadata and controls

293 lines (173 loc) · 6.58 KB

Swagger\Client\DataSetApi

All URIs are relative to https://localhost/

Method HTTP request Description
createDataSet POST /api/DataSets
createDataSetSchema POST /api/DataSets/Schema
deleteDataSet DELETE /api/DataSets/{name}
getDataSet GET /api/DataSets/{name}
getDataSets GET /api/DataSets
updateDataSet PUT /api/DataSets/{existingName}

createDataSet

createDataSet($data_set)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\Api\DataSetApi();
$data_set = new \Swagger\Client\Model\DataSet(); // \Swagger\Client\Model\DataSet | 


try { 
    $api_instance->createDataSet($data_set);
} catch (Exception $e) {
    echo 'Exception when calling DataSetApi->createDataSet: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
data_set \Swagger\Client\Model\DataSet [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createDataSetSchema

createDataSetSchema($data_set)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\Api\DataSetApi();
$data_set = new \Swagger\Client\Model\DataSet(); // \Swagger\Client\Model\DataSet | 


try { 
    $api_instance->createDataSetSchema($data_set);
} catch (Exception $e) {
    echo 'Exception when calling DataSetApi->createDataSetSchema: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
data_set \Swagger\Client\Model\DataSet [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteDataSet

deleteDataSet($name)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\Api\DataSetApi();
$name = "name_example"; // string | 


try { 
    $api_instance->deleteDataSet($name);
} catch (Exception $e) {
    echo 'Exception when calling DataSetApi->deleteDataSet: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
name string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDataSet

\Swagger\Client\Model\DataSet getDataSet($name)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\Api\DataSetApi();
$name = "name_example"; // string | 


try { 
    $result = $api_instance->getDataSet($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSetApi->getDataSet: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
name string

Return type

\Swagger\Client\Model\DataSet

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDataSets

\Swagger\Client\Model\DataSet[] getDataSets()

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\Api\DataSetApi();


try { 
    $result = $api_instance->getDataSets();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSetApi->getDataSets: ', $e->getMessage(), "\n";
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\DataSet[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateDataSet

updateDataSet($existing_name, $data_set_update)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\Api\DataSetApi();
$existing_name = "existing_name_example"; // string | 
$data_set_update = new \Swagger\Client\Model\DataSetUpdate(); // \Swagger\Client\Model\DataSetUpdate | 


try { 
    $api_instance->updateDataSet($existing_name, $data_set_update);
} catch (Exception $e) {
    echo 'Exception when calling DataSetApi->updateDataSet: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
existing_name string
data_set_update \Swagger\Client\Model\DataSetUpdate [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/json-patch+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]