ClientAPI\Semaphore\ProjectApi

All URIs are relative to http://localhost:3000/api, except if the operation defines another base path.

Method	HTTP request	Description
projectProjectIdBackupGet()	GET /project/{project_id}/backup	Backup A Project
projectProjectIdDelete()	DELETE /project/{project_id}/	Delete project
projectProjectIdEnvironmentEnvironmentIdDelete()	DELETE /project/{project_id}/environment/{environment_id}	Removes environment
projectProjectIdEnvironmentEnvironmentIdGet()	GET /project/{project_id}/environment/{environment_id}	Get environment
projectProjectIdEnvironmentEnvironmentIdPut()	PUT /project/{project_id}/environment/{environment_id}	Update environment
projectProjectIdEnvironmentGet()	GET /project/{project_id}/environment	Get environment
projectProjectIdEnvironmentPost()	POST /project/{project_id}/environment	Add environment
projectProjectIdEventsGet()	GET /project/{project_id}/events	Get Events related to this project
projectProjectIdGet()	GET /project/{project_id}/	Fetch project
projectProjectIdIntegrationsGet()	GET /project/{project_id}/integrations	get all integrations
projectProjectIdIntegrationsIntegrationIdDelete()	DELETE /project/{project_id}/integrations/{integration_id}	Remove integration
projectProjectIdIntegrationsIntegrationIdMatchersPost()	POST /project/{project_id}/integrations/{integration_id}/matchers	Add Integration Matcher
projectProjectIdIntegrationsIntegrationIdPut()	PUT /project/{project_id}/integrations/{integration_id}	Update Integration
projectProjectIdIntegrationsIntegrationIdValuesPost()	POST /project/{project_id}/integrations/{integration_id}/values	Add Integration Extracted Value
projectProjectIdIntegrationsPost()	POST /project/{project_id}/integrations	create a new integration
projectProjectIdInventoryGet()	GET /project/{project_id}/inventory	Get inventory
projectProjectIdInventoryInventoryIdDelete()	DELETE /project/{project_id}/inventory/{inventory_id}	Removes inventory
projectProjectIdInventoryInventoryIdGet()	GET /project/{project_id}/inventory/{inventory_id}	Get inventory
projectProjectIdInventoryInventoryIdPut()	PUT /project/{project_id}/inventory/{inventory_id}	Updates inventory
projectProjectIdInventoryPost()	POST /project/{project_id}/inventory	create inventory
projectProjectIdKeysGet()	GET /project/{project_id}/keys	Get access keys linked to project
projectProjectIdKeysKeyIdDelete()	DELETE /project/{project_id}/keys/{key_id}	Removes access key
projectProjectIdKeysKeyIdPut()	PUT /project/{project_id}/keys/{key_id}	Updates access key
projectProjectIdKeysPost()	POST /project/{project_id}/keys	Add access key
projectProjectIdPut()	PUT /project/{project_id}/	Update project
projectProjectIdRepositoriesGet()	GET /project/{project_id}/repositories	Get repositories
projectProjectIdRepositoriesPost()	POST /project/{project_id}/repositories	Add repository
projectProjectIdRepositoriesRepositoryIdDelete()	DELETE /project/{project_id}/repositories/{repository_id}	Removes repository
projectProjectIdRepositoriesRepositoryIdGet()	GET /project/{project_id}/repositories/{repository_id}	Get repository
projectProjectIdRepositoriesRepositoryIdPut()	PUT /project/{project_id}/repositories/{repository_id}	Updates repository
projectProjectIdRoleGet()	GET /project/{project_id}/role	Fetch permissions of the current user for project
projectProjectIdTasksGet()	GET /project/{project_id}/tasks	Get Tasks related to current project
projectProjectIdTasksLastGet()	GET /project/{project_id}/tasks/last	Get last 200 Tasks related to current project
projectProjectIdTasksPost()	POST /project/{project_id}/tasks	Starts a job
projectProjectIdTasksTaskIdDelete()	DELETE /project/{project_id}/tasks/{task_id}	Deletes task (including output)
projectProjectIdTasksTaskIdGet()	GET /project/{project_id}/tasks/{task_id}	Get a single task
projectProjectIdTasksTaskIdOutputGet()	GET /project/{project_id}/tasks/{task_id}/output	Get task output
projectProjectIdTasksTaskIdStopPost()	POST /project/{project_id}/tasks/{task_id}/stop	Stop a job
projectProjectIdTemplatesGet()	GET /project/{project_id}/templates	Get template
projectProjectIdTemplatesPost()	POST /project/{project_id}/templates	create template
projectProjectIdTemplatesTemplateIdDelete()	DELETE /project/{project_id}/templates/{template_id}	Removes template
projectProjectIdTemplatesTemplateIdGet()	GET /project/{project_id}/templates/{template_id}	Get template
projectProjectIdTemplatesTemplateIdPut()	PUT /project/{project_id}/templates/{template_id}	Updates template
projectProjectIdUsersGet()	GET /project/{project_id}/users	Get users linked to project
projectProjectIdUsersPost()	POST /project/{project_id}/users	Link user to project
projectProjectIdUsersUserIdDelete()	DELETE /project/{project_id}/users/{user_id}	Removes user from project
projectProjectIdUsersUserIdPut()	PUT /project/{project_id}/users/{user_id}	Update user role
projectProjectIdViewsGet()	GET /project/{project_id}/views	Get view
projectProjectIdViewsPost()	POST /project/{project_id}/views	create view
projectProjectIdViewsViewIdDelete()	DELETE /project/{project_id}/views/{view_id}	Removes view
projectProjectIdViewsViewIdGet()	GET /project/{project_id}/views/{view_id}	Get view
projectProjectIdViewsViewIdPut()	PUT /project/{project_id}/views/{view_id}	Updates view

`projectProjectIdBackupGet()`

projectProjectIdBackupGet($projectId): \ClientAPI\Semaphore\Model\ProjectBackup

Backup A Project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\ProjectBackup

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdDelete()`

projectProjectIdDelete($projectId)

Delete project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

try {
    $apiInstance->projectProjectIdDelete($projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdEnvironmentEnvironmentIdDelete()`

projectProjectIdEnvironmentEnvironmentIdDelete($projectId, $environmentId)

Removes environment

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$environmentId = 56; // int | environment ID

try {
    $apiInstance->projectProjectIdEnvironmentEnvironmentIdDelete($projectId, $environmentId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdEnvironmentEnvironmentIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
environmentId	int	environment ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdEnvironmentEnvironmentIdGet()`

projectProjectIdEnvironmentEnvironmentIdGet($projectId, $environmentId): \ClientAPI\Semaphore\Model\Environment

Get environment

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$environmentId = 56; // int | environment ID

try {
    $result = $apiInstance->projectProjectIdEnvironmentEnvironmentIdGet($projectId, $environmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdEnvironmentEnvironmentIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
environmentId	int	environment ID

Return type

\ClientAPI\Semaphore\Model\Environment

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdEnvironmentEnvironmentIdPut()`

projectProjectIdEnvironmentEnvironmentIdPut($projectId, $environmentId, $environment)

Update environment

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$environmentId = 56; // int | environment ID
$environment = new \ClientAPI\Semaphore\Model\EnvironmentRequest(); // \ClientAPI\Semaphore\Model\EnvironmentRequest

try {
    $apiInstance->projectProjectIdEnvironmentEnvironmentIdPut($projectId, $environmentId, $environment);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdEnvironmentEnvironmentIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
environmentId	int	environment ID
environment	\ClientAPI\Semaphore\Model\EnvironmentRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdEnvironmentGet()`

projectProjectIdEnvironmentGet($projectId, $sort, $order): \ClientAPI\Semaphore\Model\Environment[]

Get environment

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$sort = name; // string | sorting name
$order = desc; // string | ordering manner

try {
    $result = $apiInstance->projectProjectIdEnvironmentGet($projectId, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdEnvironmentGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
sort	string	sorting name
order	string	ordering manner

Return type

\ClientAPI\Semaphore\Model\Environment[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdEnvironmentPost()`

projectProjectIdEnvironmentPost($projectId, $environment): \ClientAPI\Semaphore\Model\Environment

Add environment

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$environment = new \ClientAPI\Semaphore\Model\EnvironmentRequest(); // \ClientAPI\Semaphore\Model\EnvironmentRequest

try {
    $result = $apiInstance->projectProjectIdEnvironmentPost($projectId, $environment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdEnvironmentPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
environment	\ClientAPI\Semaphore\Model\EnvironmentRequest

Return type

\ClientAPI\Semaphore\Model\Environment

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdEventsGet()`

projectProjectIdEventsGet($projectId): \ClientAPI\Semaphore\Model\Event[]

Get Events related to this project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\Event[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdGet()`

projectProjectIdGet($projectId): \ClientAPI\Semaphore\Model\Project

Fetch project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\Project

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdIntegrationsGet()`

projectProjectIdIntegrationsGet($projectId): \ClientAPI\Semaphore\Model\Integration[]

get all integrations

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\Integration[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdIntegrationsIntegrationIdDelete()`

projectProjectIdIntegrationsIntegrationIdDelete($projectId, $integrationId)

Remove integration

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$integrationId = 56; // int | integration ID

try {
    $apiInstance->projectProjectIdIntegrationsIntegrationIdDelete($projectId, $integrationId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdIntegrationsIntegrationIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
integrationId	int	integration ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdIntegrationsIntegrationIdMatchersPost()`

projectProjectIdIntegrationsIntegrationIdMatchersPost($projectId, $integrationId, $integrationMatcher)

Add Integration Matcher

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$integrationId = 56; // int | integration ID
$integrationMatcher = new \ClientAPI\Semaphore\Model\IntegrationMatcher(); // \ClientAPI\Semaphore\Model\IntegrationMatcher

try {
    $apiInstance->projectProjectIdIntegrationsIntegrationIdMatchersPost($projectId, $integrationId, $integrationMatcher);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdIntegrationsIntegrationIdMatchersPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
integrationId	int	integration ID
integrationMatcher	\ClientAPI\Semaphore\Model\IntegrationMatcher

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdIntegrationsIntegrationIdPut()`

projectProjectIdIntegrationsIntegrationIdPut($projectId, $integrationId, $integration)

Update Integration

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$integrationId = 56; // int | integration ID
$integration = new \ClientAPI\Semaphore\Model\IntegrationRequest(); // \ClientAPI\Semaphore\Model\IntegrationRequest

try {
    $apiInstance->projectProjectIdIntegrationsIntegrationIdPut($projectId, $integrationId, $integration);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdIntegrationsIntegrationIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
integrationId	int	integration ID
integration	\ClientAPI\Semaphore\Model\IntegrationRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdIntegrationsIntegrationIdValuesPost()`

projectProjectIdIntegrationsIntegrationIdValuesPost($projectId, $integrationId, $integrationExtractedValue)

Add Integration Extracted Value

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$integrationId = 56; // int | integration ID
$integrationExtractedValue = new \ClientAPI\Semaphore\Model\IntegrationExtractValue(); // \ClientAPI\Semaphore\Model\IntegrationExtractValue

try {
    $apiInstance->projectProjectIdIntegrationsIntegrationIdValuesPost($projectId, $integrationId, $integrationExtractedValue);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdIntegrationsIntegrationIdValuesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
integrationId	int	integration ID
integrationExtractedValue	\ClientAPI\Semaphore\Model\IntegrationExtractValue

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdIntegrationsPost()`

projectProjectIdIntegrationsPost($projectId, $integration): \ClientAPI\Semaphore\Model\Integration

create a new integration

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$integration = new \ClientAPI\Semaphore\Model\IntegrationRequest(); // \ClientAPI\Semaphore\Model\IntegrationRequest

try {
    $result = $apiInstance->projectProjectIdIntegrationsPost($projectId, $integration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdIntegrationsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
integration	\ClientAPI\Semaphore\Model\IntegrationRequest

Return type

\ClientAPI\Semaphore\Model\Integration

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdInventoryGet()`

projectProjectIdInventoryGet($projectId, $sort, $order): \ClientAPI\Semaphore\Model\Inventory[]

Get inventory

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$sort = 'sort_example'; // string | sorting name
$order = 'order_example'; // string | ordering manner

try {
    $result = $apiInstance->projectProjectIdInventoryGet($projectId, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdInventoryGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
sort	string	sorting name
order	string	ordering manner

Return type

\ClientAPI\Semaphore\Model\Inventory[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdInventoryInventoryIdDelete()`

projectProjectIdInventoryInventoryIdDelete($projectId, $inventoryId)

Removes inventory

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$inventoryId = 56; // int | inventory ID

try {
    $apiInstance->projectProjectIdInventoryInventoryIdDelete($projectId, $inventoryId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdInventoryInventoryIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
inventoryId	int	inventory ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdInventoryInventoryIdGet()`

projectProjectIdInventoryInventoryIdGet($projectId, $inventoryId): \ClientAPI\Semaphore\Model\Inventory

Get inventory

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$inventoryId = 56; // int | inventory ID

try {
    $result = $apiInstance->projectProjectIdInventoryInventoryIdGet($projectId, $inventoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdInventoryInventoryIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
inventoryId	int	inventory ID

Return type

\ClientAPI\Semaphore\Model\Inventory

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdInventoryInventoryIdPut()`

projectProjectIdInventoryInventoryIdPut($projectId, $inventoryId, $inventory)

Updates inventory

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$inventoryId = 56; // int | inventory ID
$inventory = new \ClientAPI\Semaphore\Model\InventoryRequest(); // \ClientAPI\Semaphore\Model\InventoryRequest

try {
    $apiInstance->projectProjectIdInventoryInventoryIdPut($projectId, $inventoryId, $inventory);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdInventoryInventoryIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
inventoryId	int	inventory ID
inventory	\ClientAPI\Semaphore\Model\InventoryRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdInventoryPost()`

projectProjectIdInventoryPost($projectId, $inventory): \ClientAPI\Semaphore\Model\Inventory

create inventory

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$inventory = new \ClientAPI\Semaphore\Model\InventoryRequest(); // \ClientAPI\Semaphore\Model\InventoryRequest

try {
    $result = $apiInstance->projectProjectIdInventoryPost($projectId, $inventory);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdInventoryPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
inventory	\ClientAPI\Semaphore\Model\InventoryRequest

Return type

\ClientAPI\Semaphore\Model\Inventory

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdKeysGet()`

projectProjectIdKeysGet($projectId, $sort, $order, $keyType): \ClientAPI\Semaphore\Model\AccessKey[]

Get access keys linked to project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$sort = type; // string | sorting name
$order = asc; // string | ordering manner
$keyType = none; // string | Filter by key type

try {
    $result = $apiInstance->projectProjectIdKeysGet($projectId, $sort, $order, $keyType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdKeysGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
sort	string	sorting name
order	string	ordering manner
keyType	string	Filter by key type	[optional]

Return type

\ClientAPI\Semaphore\Model\AccessKey[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdKeysKeyIdDelete()`

projectProjectIdKeysKeyIdDelete($projectId, $keyId)

Removes access key

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$keyId = 56; // int | key ID

try {
    $apiInstance->projectProjectIdKeysKeyIdDelete($projectId, $keyId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdKeysKeyIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
keyId	int	key ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdKeysKeyIdPut()`

projectProjectIdKeysKeyIdPut($projectId, $keyId, $accessKey)

Updates access key

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$keyId = 56; // int | key ID
$accessKey = new \ClientAPI\Semaphore\Model\AccessKeyRequest(); // \ClientAPI\Semaphore\Model\AccessKeyRequest

try {
    $apiInstance->projectProjectIdKeysKeyIdPut($projectId, $keyId, $accessKey);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdKeysKeyIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
keyId	int	key ID
accessKey	\ClientAPI\Semaphore\Model\AccessKeyRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdKeysPost()`

projectProjectIdKeysPost($projectId, $accessKey): \ClientAPI\Semaphore\Model\AccessKey

Add access key

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$accessKey = new \ClientAPI\Semaphore\Model\AccessKeyRequest(); // \ClientAPI\Semaphore\Model\AccessKeyRequest

try {
    $result = $apiInstance->projectProjectIdKeysPost($projectId, $accessKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdKeysPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
accessKey	\ClientAPI\Semaphore\Model\AccessKeyRequest

Return type

\ClientAPI\Semaphore\Model\AccessKey

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdPut()`

projectProjectIdPut($projectId, $project)

Update project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$project = new \ClientAPI\Semaphore\Model\ProjectProjectIdPutRequest(); // \ClientAPI\Semaphore\Model\ProjectProjectIdPutRequest

try {
    $apiInstance->projectProjectIdPut($projectId, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
project	\ClientAPI\Semaphore\Model\ProjectProjectIdPutRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdRepositoriesGet()`

projectProjectIdRepositoriesGet($projectId, $sort, $order): \ClientAPI\Semaphore\Model\Repository[]

Get repositories

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$sort = 'sort_example'; // string | sorting name
$order = 'order_example'; // string | ordering manner

try {
    $result = $apiInstance->projectProjectIdRepositoriesGet($projectId, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdRepositoriesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
sort	string	sorting name
order	string	ordering manner

Return type

\ClientAPI\Semaphore\Model\Repository[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdRepositoriesPost()`

projectProjectIdRepositoriesPost($projectId, $repository): \ClientAPI\Semaphore\Model\Repository

Add repository

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$repository = new \ClientAPI\Semaphore\Model\RepositoryRequest(); // \ClientAPI\Semaphore\Model\RepositoryRequest

try {
    $result = $apiInstance->projectProjectIdRepositoriesPost($projectId, $repository);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdRepositoriesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
repository	\ClientAPI\Semaphore\Model\RepositoryRequest

Return type

\ClientAPI\Semaphore\Model\Repository

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdRepositoriesRepositoryIdDelete()`

projectProjectIdRepositoriesRepositoryIdDelete($projectId, $repositoryId)

Removes repository

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$repositoryId = 56; // int | repository ID

try {
    $apiInstance->projectProjectIdRepositoriesRepositoryIdDelete($projectId, $repositoryId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdRepositoriesRepositoryIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
repositoryId	int	repository ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdRepositoriesRepositoryIdGet()`

projectProjectIdRepositoriesRepositoryIdGet($projectId, $repositoryId): \ClientAPI\Semaphore\Model\Repository

Get repository

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$repositoryId = 56; // int | repository ID

try {
    $result = $apiInstance->projectProjectIdRepositoriesRepositoryIdGet($projectId, $repositoryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdRepositoriesRepositoryIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
repositoryId	int	repository ID

Return type

\ClientAPI\Semaphore\Model\Repository

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdRepositoriesRepositoryIdPut()`

projectProjectIdRepositoriesRepositoryIdPut($projectId, $repositoryId, $repository)

Updates repository

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$repositoryId = 56; // int | repository ID
$repository = new \ClientAPI\Semaphore\Model\RepositoryRequest(); // \ClientAPI\Semaphore\Model\RepositoryRequest

try {
    $apiInstance->projectProjectIdRepositoriesRepositoryIdPut($projectId, $repositoryId, $repository);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdRepositoriesRepositoryIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
repositoryId	int	repository ID
repository	\ClientAPI\Semaphore\Model\RepositoryRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdRoleGet()`

projectProjectIdRoleGet($projectId): \ClientAPI\Semaphore\Model\ProjectProjectIdRoleGet200Response

Fetch permissions of the current user for project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\ProjectProjectIdRoleGet200Response

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTasksGet()`

projectProjectIdTasksGet($projectId): \ClientAPI\Semaphore\Model\Task[]

Get Tasks related to current project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\Task[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTasksLastGet()`

projectProjectIdTasksLastGet($projectId): \ClientAPI\Semaphore\Model\Task[]

Get last 200 Tasks related to current project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\Task[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTasksPost()`

projectProjectIdTasksPost($projectId, $task): \ClientAPI\Semaphore\Model\Task

Starts a job

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$task = new \ClientAPI\Semaphore\Model\ProjectProjectIdTasksPostRequest(); // \ClientAPI\Semaphore\Model\ProjectProjectIdTasksPostRequest

try {
    $result = $apiInstance->projectProjectIdTasksPost($projectId, $task);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTasksPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
task	\ClientAPI\Semaphore\Model\ProjectProjectIdTasksPostRequest

Return type

\ClientAPI\Semaphore\Model\Task

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTasksTaskIdDelete()`

projectProjectIdTasksTaskIdDelete($projectId, $taskId)

Deletes task (including output)

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$taskId = 56; // int | task ID

try {
    $apiInstance->projectProjectIdTasksTaskIdDelete($projectId, $taskId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTasksTaskIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
taskId	int	task ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdTasksTaskIdGet()`

projectProjectIdTasksTaskIdGet($projectId, $taskId): \ClientAPI\Semaphore\Model\Task

Get a single task

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$taskId = 56; // int | task ID

try {
    $result = $apiInstance->projectProjectIdTasksTaskIdGet($projectId, $taskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTasksTaskIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
taskId	int	task ID

Return type

\ClientAPI\Semaphore\Model\Task

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTasksTaskIdOutputGet()`

projectProjectIdTasksTaskIdOutputGet($projectId, $taskId): \ClientAPI\Semaphore\Model\TaskOutput[]

Get task output

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$taskId = 56; // int | task ID

try {
    $result = $apiInstance->projectProjectIdTasksTaskIdOutputGet($projectId, $taskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTasksTaskIdOutputGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
taskId	int	task ID

Return type

\ClientAPI\Semaphore\Model\TaskOutput[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTasksTaskIdStopPost()`

projectProjectIdTasksTaskIdStopPost($projectId, $taskId)

Stop a job

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$taskId = 56; // int | task ID

try {
    $apiInstance->projectProjectIdTasksTaskIdStopPost($projectId, $taskId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTasksTaskIdStopPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
taskId	int	task ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdTemplatesGet()`

projectProjectIdTemplatesGet($projectId, $sort, $order): \ClientAPI\Semaphore\Model\Template[]

Get template

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$sort = 'sort_example'; // string | sorting name
$order = 'order_example'; // string | ordering manner

try {
    $result = $apiInstance->projectProjectIdTemplatesGet($projectId, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTemplatesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
sort	string	sorting name
order	string	ordering manner

Return type

\ClientAPI\Semaphore\Model\Template[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTemplatesPost()`

projectProjectIdTemplatesPost($projectId, $template): \ClientAPI\Semaphore\Model\Template

create template

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$template = new \ClientAPI\Semaphore\Model\TemplateRequest(); // \ClientAPI\Semaphore\Model\TemplateRequest

try {
    $result = $apiInstance->projectProjectIdTemplatesPost($projectId, $template);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTemplatesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
template	\ClientAPI\Semaphore\Model\TemplateRequest

Return type

\ClientAPI\Semaphore\Model\Template

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTemplatesTemplateIdDelete()`

projectProjectIdTemplatesTemplateIdDelete($projectId, $templateId)

Removes template

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$templateId = 56; // int | template ID

try {
    $apiInstance->projectProjectIdTemplatesTemplateIdDelete($projectId, $templateId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTemplatesTemplateIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
templateId	int	template ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdTemplatesTemplateIdGet()`

projectProjectIdTemplatesTemplateIdGet($projectId, $templateId): \ClientAPI\Semaphore\Model\Template

Get template

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$templateId = 56; // int | template ID

try {
    $result = $apiInstance->projectProjectIdTemplatesTemplateIdGet($projectId, $templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTemplatesTemplateIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
templateId	int	template ID

Return type

\ClientAPI\Semaphore\Model\Template

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdTemplatesTemplateIdPut()`

projectProjectIdTemplatesTemplateIdPut($projectId, $templateId, $template)

Updates template

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$templateId = 56; // int | template ID
$template = new \ClientAPI\Semaphore\Model\TemplateRequest(); // \ClientAPI\Semaphore\Model\TemplateRequest

try {
    $apiInstance->projectProjectIdTemplatesTemplateIdPut($projectId, $templateId, $template);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdTemplatesTemplateIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
templateId	int	template ID
template	\ClientAPI\Semaphore\Model\TemplateRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdUsersGet()`

projectProjectIdUsersGet($projectId, $sort, $order): \ClientAPI\Semaphore\Model\ProjectUser[]

Get users linked to project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$sort = email; // string | sorting name
$order = desc; // string | ordering manner

try {
    $result = $apiInstance->projectProjectIdUsersGet($projectId, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdUsersGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
sort	string	sorting name
order	string	ordering manner

Return type

\ClientAPI\Semaphore\Model\ProjectUser[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdUsersPost()`

projectProjectIdUsersPost($projectId, $user)

Link user to project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$user = new \ClientAPI\Semaphore\Model\ProjectProjectIdUsersPostRequest(); // \ClientAPI\Semaphore\Model\ProjectProjectIdUsersPostRequest

try {
    $apiInstance->projectProjectIdUsersPost($projectId, $user);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdUsersPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
user	\ClientAPI\Semaphore\Model\ProjectProjectIdUsersPostRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdUsersUserIdDelete()`

projectProjectIdUsersUserIdDelete($projectId, $userId)

Removes user from project

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$userId = 56; // int | User ID

try {
    $apiInstance->projectProjectIdUsersUserIdDelete($projectId, $userId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdUsersUserIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
userId	int	User ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdUsersUserIdPut()`

projectProjectIdUsersUserIdPut($projectId, $userId, $projectUser)

Update user role

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$userId = 56; // int | User ID
$projectUser = new \ClientAPI\Semaphore\Model\ProjectProjectIdUsersUserIdPutRequest(); // \ClientAPI\Semaphore\Model\ProjectProjectIdUsersUserIdPutRequest

try {
    $apiInstance->projectProjectIdUsersUserIdPut($projectId, $userId, $projectUser);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdUsersUserIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
userId	int	User ID
projectUser	\ClientAPI\Semaphore\Model\ProjectProjectIdUsersUserIdPutRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

`projectProjectIdViewsGet()`

projectProjectIdViewsGet($projectId): \ClientAPI\Semaphore\Model\View[]

Get view

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID

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

Parameters

Name	Type	Description	Notes
projectId	int	Project ID

Return type

\ClientAPI\Semaphore\Model\View[]

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdViewsPost()`

projectProjectIdViewsPost($projectId, $view): \ClientAPI\Semaphore\Model\View

create view

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$view = new \ClientAPI\Semaphore\Model\ViewRequest(); // \ClientAPI\Semaphore\Model\ViewRequest

try {
    $result = $apiInstance->projectProjectIdViewsPost($projectId, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdViewsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
view	\ClientAPI\Semaphore\Model\ViewRequest

Return type

\ClientAPI\Semaphore\Model\View

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdViewsViewIdDelete()`

projectProjectIdViewsViewIdDelete($projectId, $viewId)

Removes view

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$viewId = 56; // int | view ID

try {
    $apiInstance->projectProjectIdViewsViewIdDelete($projectId, $viewId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdViewsViewIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
viewId	int	view ID

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`projectProjectIdViewsViewIdGet()`

projectProjectIdViewsViewIdGet($projectId, $viewId): \ClientAPI\Semaphore\Model\View

Get view

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$viewId = 56; // int | view ID

try {
    $result = $apiInstance->projectProjectIdViewsViewIdGet($projectId, $viewId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdViewsViewIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
projectId	int	Project ID
viewId	int	view ID

Return type

\ClientAPI\Semaphore\Model\View

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain; charset=utf-8

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

`projectProjectIdViewsViewIdPut()`

projectProjectIdViewsViewIdPut($projectId, $viewId, $view)

Updates view

Example

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


// Configure API key authorization: cookie
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Cookie', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Cookie', 'Bearer');

// Configure API key authorization: bearer
$config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ClientAPI\Semaphore\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ClientAPI\Semaphore\Api\ProjectApi(
    // 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
);
$projectId = 56; // int | Project ID
$viewId = 56; // int | view ID
$view = new \ClientAPI\Semaphore\Model\ViewRequest(); // \ClientAPI\Semaphore\Model\ViewRequest

try {
    $apiInstance->projectProjectIdViewsViewIdPut($projectId, $viewId, $view);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->projectProjectIdViewsViewIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
projectId	int	Project ID
viewId	int	view ID
view	\ClientAPI\Semaphore\Model\ViewRequest

Return type

void (empty response body)

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

Files

ProjectApi.md

Latest commit

History

ProjectApi.md

File metadata and controls

ClientAPI\Semaphore\ProjectApi

projectProjectIdBackupGet()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdEnvironmentEnvironmentIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdEnvironmentEnvironmentIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdEnvironmentEnvironmentIdPut()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdEnvironmentGet()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdEnvironmentPost()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdEventsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdIntegrationsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdIntegrationsIntegrationIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdIntegrationsIntegrationIdMatchersPost()

Example

Parameters

Return type

Authorization

HTTP request headers

projectProjectIdIntegrationsIntegrationIdPut()

`projectProjectIdBackupGet()`

`projectProjectIdDelete()`

`projectProjectIdEnvironmentEnvironmentIdDelete()`

`projectProjectIdEnvironmentEnvironmentIdGet()`

`projectProjectIdEnvironmentEnvironmentIdPut()`

`projectProjectIdEnvironmentGet()`

`projectProjectIdEnvironmentPost()`

`projectProjectIdEventsGet()`

`projectProjectIdGet()`

`projectProjectIdIntegrationsGet()`

`projectProjectIdIntegrationsIntegrationIdDelete()`

`projectProjectIdIntegrationsIntegrationIdMatchersPost()`

`projectProjectIdIntegrationsIntegrationIdPut()`

`projectProjectIdIntegrationsIntegrationIdValuesPost()`

`projectProjectIdIntegrationsPost()`

`projectProjectIdInventoryGet()`

`projectProjectIdInventoryInventoryIdDelete()`

`projectProjectIdInventoryInventoryIdGet()`

`projectProjectIdInventoryInventoryIdPut()`

`projectProjectIdInventoryPost()`

`projectProjectIdKeysGet()`

`projectProjectIdKeysKeyIdDelete()`

`projectProjectIdKeysKeyIdPut()`