Skip to content

ProjectsApi.md

Latest commit

 

History

History
313 lines (215 loc) · 8.94 KB

ProjectsApi.md

File metadata and controls

313 lines (215 loc) · 8.94 KB

QuantClient\ProjectsApi

All URIs are relative to https://dashboard.quantcdn.io, except if the operation defines another base path.

Method HTTP request Description
projectsCreate() POST /api/v2/organizations/{organization}/projects Create a new project
projectsDelete() DELETE /api/v2/organizations/{organization}/projects/{project} Delete a project
projectsList() GET /api/v2/organizations/{organization}/projects Retrieve all projects for an organization
projectsRead() GET /api/v2/organizations/{organization}/projects/{project} Get details of a single project
projectsUpdate() PATCH /api/v2/organizations/{organization}/projects/{project} Update a project

projectsCreate()

projectsCreate($organization, $v2_project_request): \QuantClient\Model\V2Project

Create a new project

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\ProjectsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$v2_project_request = new \QuantClient\Model\V2ProjectRequest(); // \QuantClient\Model\V2ProjectRequest

try {
    $result = $apiInstance->projectsCreate($organization, $v2_project_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
v2_project_request \QuantClient\Model\V2ProjectRequest

Return type

\QuantClient\Model\V2Project

Authorization

BearerAuth

HTTP request headers

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

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

projectsDelete()

projectsDelete($organization, $project)

Delete a project

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\ProjectsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier

try {
    $apiInstance->projectsDelete($organization, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

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

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

projectsList()

projectsList($organization): \QuantClient\Model\V2Project[]

Retrieve all projects for an organization

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\ProjectsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier

try {
    $result = $apiInstance->projectsList($organization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier

Return type

\QuantClient\Model\V2Project[]

Authorization

BearerAuth

HTTP request headers

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

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

projectsRead()

projectsRead($organization, $project, $with_token): \QuantClient\Model\V2Project

Get details of a single project

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\ProjectsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$with_token = false; // bool

try {
    $result = $apiInstance->projectsRead($organization, $project, $with_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsRead: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier
with_token bool [default to false]

Return type

\QuantClient\Model\V2Project

Authorization

BearerAuth

HTTP request headers

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

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

projectsUpdate()

projectsUpdate($organization, $project, $v2_project_request): \QuantClient\Model\V2Project

Update a project

Example

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


// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\ProjectsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization = test-org; // string | Organization identifier
$project = test-project; // string | Project identifier
$v2_project_request = new \QuantClient\Model\V2ProjectRequest(); // \QuantClient\Model\V2ProjectRequest

try {
    $result = $apiInstance->projectsUpdate($organization, $project, $v2_project_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->projectsUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organization string Organization identifier
project string Project identifier
v2_project_request \QuantClient\Model\V2ProjectRequest

Return type

\QuantClient\Model\V2Project

Authorization

BearerAuth

HTTP request headers

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

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