API Endpoints

Introduction

This page contains all class definitions related to API Endpoint knows as /api/*. All classes under this endpoint are named using class naming convention, it means that the class name must consist of Oc[endpoit name]Api with Api at the end to define its category!

Namespace:

namespace OpencastApi\Rest;

How to access

1. In OpencastApi\OpenCast as its property:

use OpencastApi\OpenCast;
$opencastApi = new OpenCast($config);
$ocEventsApi = $opencastApi->eventsApi;
...

2. Direct instantiation:

use OpencastApi\Rest\OcRestClient;
use OpencastApi\Rest\OcEventsApi;
$ocRestClient = new OcRestClient($config);
$ocEventsApi = new OcEventsApi($ocRestClient);
...

Table of content

• OcEventsApi
• OcSeriesApi
• OcWorkflowsApi
• OcGroupsApi
• OcStatisticsApi
• OcSecurityApi
• OcBaseApi
• OcAgentsApi