README

here be dragons

This PHP package is automatically generated by the Swagger Codegen project:

API version: v0.2.0
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure HTTP basic authorization: basicAuth
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Swagger\Client\Api\DatabaseTablesApi(
    // 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
);
$table_name = "table_name_example"; // string | The name of the table to get.

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

?>

Documentation for API Endpoints

All URIs are relative to https://activiti.ganymed.me/activiti-rest/service

Class	Method	HTTP request	Description
DatabaseTablesApi	getTable	GET /management/tables/{tableName}	Get a single table
DatabaseTablesApi	getTableData	GET /management/tables/{tableName}/data	Get row data for a single table
DatabaseTablesApi	getTableMetaData	GET /management/tables/{tableName}/columns	Get column info for a single table
DatabaseTablesApi	getTables	GET /management/tables	List of tables
DeploymentApi	deleteDeployment	DELETE /repository/deployments/{deploymentId}	Delete a deployment
DeploymentApi	getDeployment	GET /repository/deployments/{deploymentId}	Get a deployment
DeploymentApi	getDeploymentResource	GET /repository/deployments/{deploymentId}/resources/**	Get a deployment resource
DeploymentApi	getDeploymentResourceData	GET /repository/deployments/{deploymentId}/resourcedata/{resourceId}	Get a deployment resource content
DeploymentApi	getDeploymentResources	GET /repository/deployments/{deploymentId}/resources	List resources in a deployment
DeploymentApi	getDeployments	GET /repository/deployments	List of Deployments
DeploymentApi	uploadDeployment	POST /repository/deployments	Create a new deployment
EngineApi	getEngineInfo	GET /management/engine	Get engine info
EngineApi	getProperties	GET /management/properties	Get engine properties
ExecutionsApi	createExecutionVariable	POST /runtime/executions/{executionId}/variables	Create variables on an execution
ExecutionsApi	createOrUpdateExecutionVariable	PUT /runtime/executions/{executionId}/variables	Update variables on an execution
ExecutionsApi	deleteLocalVariables	DELETE /runtime/executions/{executionId}/variables	Delete all variables for an execution
ExecutionsApi	deletedExecutionVariable	DELETE /runtime/executions/{executionId}/variables/{variableName}	Delete a variable for an execution
ExecutionsApi	executeExecutionAction	PUT /runtime/executions	Signal event received
ExecutionsApi	getActiveActivities	GET /runtime/executions/{executionId}/activities	Get active activities in an execution
ExecutionsApi	getExecution	GET /runtime/executions/{executionId}	Get an execution
ExecutionsApi	getExecutionVariable	GET /runtime/executions/{executionId}/variables/{variableName}	Get a variable for an execution
ExecutionsApi	getExecutionVariableData	GET /runtime/executions/{executionId}/variables/{variableName}/data	Get the binary data for an execution
ExecutionsApi	getExecutions	GET /runtime/executions	List of executions
ExecutionsApi	listExecutionVariables	GET /runtime/executions/{executionId}/variables	List of variables for an execution
ExecutionsApi	performExecutionAction	PUT /runtime/executions/{executionId}	Execute an action on an execution
ExecutionsApi	queryExecutions	POST /query/executions	Query executions
ExecutionsApi	updateExecutionVariable	PUT /runtime/executions/{executionId}/variables/{variableName}	Update a variable on an execution
FormsApi	getFormData	GET /form/form-data	Get form data
FormsApi	submitForm	POST /form/form-data	Submit task form data
GroupsApi	createGroup	POST /identity/groups	Create a group
GroupsApi	createMembership	POST /identity/groups/{groupId}/members	Add a member to a group
GroupsApi	deleteGroup	DELETE /identity/groups/{groupId}	Delete a group
GroupsApi	deleteMembership	DELETE /identity/groups/{groupId}/members/{userId}	Delete a member from a group
GroupsApi	getGroup	GET /identity/groups/{groupId}	Get a single group
GroupsApi	getGroups	GET /identity/groups	Get a list of groups
GroupsApi	updateGroup	PUT /identity/groups/{groupId}	Update a group
HistoryApi	createComment	POST /history/historic-process-instances/{processInstanceId}/comments	Create a new comment on a historic process instance
HistoryApi	deleteComment	DELETE /history/historic-process-instances/{processInstanceId}/comments/{commentId}	Delete a comment on a historic process instance
HistoryApi	deleteHitoricProcessInstance	DELETE /history/historic-process-instances/{processInstanceId}	Delete a historic process instance
HistoryApi	deleteTaskInstance	DELETE /history/historic-task-instances/{taskId}	Delete a historic task instance
HistoryApi	getComment	GET /history/historic-process-instances/{processInstanceId}/comments/{commentId}	Get a comment on a historic process instance
HistoryApi	getComments	GET /history/historic-process-instances/{processInstanceId}/comments	Get all comments on a historic process instance
HistoryApi	getHistoricActivityInstances	GET /history/historic-activity-instances	Get historic activity instances
HistoryApi	getHistoricDetailInfo	GET /history/historic-detail	Get historic detail
HistoryApi	getHistoricDetailVariableData	GET /history/historic-detail/{detailId}/data	Get the binary data for a historic detail variable
HistoryApi	getHistoricInstanceVariableData	GET /history/historic-variable-instances/{varInstanceId}/data	Get the binary data for a historic task instance variable
HistoryApi	getHistoricProcessInstance	GET /history/historic-process-instances/{processInstanceId}	Get a historic process instance
HistoryApi	getHistoricProcessInstanceVariableData	GET /history/historic-process-instances/{processInstanceId}/variables/{variableName}/data	Get the binary data for a historic process instance variable
HistoryApi	getHistoricTaskInstanceVariableData	GET /history/historic-task-instances/{taskId}/variables/{variableName}/data	Get the binary data for a historic task instance variable
HistoryApi	getHistoricVariableInstances	GET /history/historic-variable-instances	List of historic variable instances
HistoryApi	getProcessIdentityLinks	GET /history/historic-process-instances/{processInstanceId}/identitylinks	Get the identity links of a historic process instance
HistoryApi	getTaskIdentityLinks	GET /history/historic-task-instances/{taskId}/identitylinks	Get the identity links of a historic task instance
HistoryApi	getTaskInstance	GET /history/historic-task-instances/{taskId}	Get a single historic task instance
HistoryApi	listHistoricProcessInstances	GET /history/historic-process-instances	List of historic process instances
HistoryApi	listHistoricTaskInstances	GET /history/historic-task-instances	Get historic task instances
HistoryApi	queryActivityInstances	POST /query/historic-activity-instances	Query for historic activity instances
HistoryApi	queryHistoricDetail	POST /query/historic-detail	Query for historic details
HistoryApi	queryHistoricProcessInstance	POST /query/historic-process-instances	Query for historic process instances
HistoryApi	queryHistoricTaskInstance	POST /query/historic-task-instances	Query for historic task instances
HistoryApi	queryVariableInstances	POST /query/historic-variable-instances	Query for historic variable instances
JobsApi	deleteDeadLetterJob	DELETE /management/deadletter-jobs/{jobId}	Delete a deadletter job
JobsApi	deleteJob	DELETE /management/jobs/{jobId}	Delete a job
JobsApi	deleteTimerJob	DELETE /management/timer-jobs/{jobId}	Delete a timer job
JobsApi	executeJobAction	POST /management/jobs/{jobId}	Execute a single job
JobsApi	getDeadLetterJobStacktrace	GET /management/deadletter-jobs/{jobId}/exception-stacktrace	Get the exception stacktrace for a deadletter job
JobsApi	getDeadletterJob	GET /management/deadletter-jobs/{jobId}	Get a single deadletter job
JobsApi	getJob	GET /management/jobs/{jobId}	Get a single job
JobsApi	getJobStacktrace	GET /management/jobs/{jobId}/exception-stacktrace	Get the exception stacktrace for a job
JobsApi	getSuspendedJob	GET /management/suspended-jobs/{jobId}	Get a single suspended job
JobsApi	getSuspendedJobStacktrace	GET /management/suspended-jobs/{jobId}/exception-stacktrace	Get the exception stacktrace for a suspended job
JobsApi	getTimerJob	GET /management/timer-jobs/{jobId}	Get a single timer job
JobsApi	getTimerJobStacktrace	GET /management/timer-jobs/{jobId}/exception-stacktrace	Get the exception stacktrace for a timer job
JobsApi	listDeadLetterJobs	GET /management/deadletter-jobs	Get a list of deadletter jobs
JobsApi	listJobs	GET /management/jobs	Get a list of jobs
JobsApi	listSuspendedJobs	GET /management/suspended-jobs	Get a list of suspended jobs
JobsApi	listTimerJobs	GET /management/timer-jobs	Get a list of timer jobs
ModelsApi	createModel	POST /repository/models	Create a model
ModelsApi	deleteModel	DELETE /repository/models/{modelId}	Delete a model
ModelsApi	getModel	GET /repository/models/{modelId}	Get a model
ModelsApi	getModels	GET /repository/models	Get a list of models
ModelsApi	updateModel	PUT /repository/models/{modelId}	Update a model
ProcessDefinitionsApi	createIdentityLink	POST /repository/process-definitions/{processDefinitionId}/identitylinks	Add a candidate starter to a process definition
ProcessDefinitionsApi	deleteIdentityLink	DELETE /repository/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}	Delete a candidate starter from a process definition
ProcessDefinitionsApi	executeProcessDefinitionAction	PUT /repository/process-definitions/{processDefinitionId}	Execute actions for a process definition (Update category, Suspend or Activate)
ProcessDefinitionsApi	getBpmnModelResource	GET /repository/process-definitions/{processDefinitionId}/model	Get a process definition BPMN model
ProcessDefinitionsApi	getIdentityLink	GET /repository/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}	Get a candidate starter from a process definition
ProcessDefinitionsApi	getIdentityLinks	GET /repository/process-definitions/{processDefinitionId}/identitylinks	Get all candidate starters for a process-definition
ProcessDefinitionsApi	getModelResource	GET /repository/process-definitions/{processDefinitionId}/image	Get a process definition image
ProcessDefinitionsApi	getProcessDefinition	GET /repository/process-definitions/{processDefinitionId}	Get a process definition
ProcessDefinitionsApi	getProcessDefinitionResource	GET /repository/process-definitions/{processDefinitionId}/resourcedata	Get a process definition resource content
ProcessDefinitionsApi	getProcessDefinitions	GET /repository/process-definitions	List of process definitions
ProcessInstancesApi	createOrUpdateProcessVariable	PUT /runtime/process-instances/{processInstanceId}/variables	Update a single or binary variable or multiple variables on a process instance
ProcessInstancesApi	createProcessInstance	POST /runtime/process-instances	Start a process instance
ProcessInstancesApi	createProcessInstanceIdentityLinks	POST /runtime/process-instances/{processInstanceId}/identitylinks	Add an involved user to a process instance
ProcessInstancesApi	createProcessInstanceVariable	POST /runtime/process-instances/{processInstanceId}/variables	Create variables or new binary variable on a process instance
ProcessInstancesApi	deleteLocalProcessVariable	DELETE /runtime/process-instances/{processInstanceId}/variables	Delete all variables
ProcessInstancesApi	deleteProcessInstance	DELETE /runtime/process-instances/{processInstanceId}	Delete a process instance
ProcessInstancesApi	deleteProcessInstanceIdentityLinks	DELETE /runtime/process-instances/{processInstanceId}/identitylinks/users/{identityId}/{type}	Remove an involved user to from process instance
ProcessInstancesApi	deleteProcessInstanceVariable	DELETE /runtime/process-instances/{processInstanceId}/variables/{variableName}	Delete a variable
ProcessInstancesApi	getProcessInstance	GET /runtime/process-instances/{processInstanceId}	Get a process instance
ProcessInstancesApi	getProcessInstanceDiagram	GET /runtime/process-instances/{processInstanceId}/diagram	Get diagram for a process instance
ProcessInstancesApi	getProcessInstanceIdentityLinks	GET /runtime/process-instances/{processInstanceId}/identitylinks/users/{identityId}/{type}	Get a specific involved people from process instance
ProcessInstancesApi	getProcessInstanceVariable	GET /runtime/process-instances/{processInstanceId}/variables/{variableName}	Get a variable for a process instance
ProcessInstancesApi	getProcessInstanceVariableData	GET /runtime/process-instances/{processInstanceId}/variables/{variableName}/data	Get the binary data for a variable
ProcessInstancesApi	getProcessInstances	GET /runtime/process-instances	List of process instances
ProcessInstancesApi	getVariables	GET /runtime/process-instances/{processInstanceId}/variables	List of variables for a process instance
ProcessInstancesApi	listProcessInstanceIdentityLinks	GET /runtime/process-instances/{processInstanceId}/identitylinks	Get involved people for process instance
ProcessInstancesApi	performProcessInstanceAction	PUT /runtime/process-instances/{processInstanceId}	Activate or suspend a process instance
ProcessInstancesApi	queryProcessInstances	POST /query/process-instances	Query process instances
ProcessInstancesApi	updateProcessInstanceVariable	PUT /runtime/process-instances/{processInstanceId}/variables/{variableName}	Update a single variable on a process instance
RuntimeApi	signalEventReceived	POST /runtime/signals	Signal event received
TasksApi	createAttachment	POST /runtime/tasks/{taskId}/attachments	Create a new attachment on a task, containing a link to an external resource or an attached file
TasksApi	createTask	POST /runtime/tasks	Create Task
TasksApi	createTaskComments	POST /runtime/tasks/{taskId}/comments	Create a new comment on a task
TasksApi	createTaskInstanceIdentityLinks	POST /runtime/tasks/{taskId}/identitylinks	Create an identity link on a task
TasksApi	createTaskVariable	POST /runtime/tasks/{taskId}/variables	Create new variables on a task
TasksApi	deleteAllLocalTaskVariables	DELETE /runtime/tasks/{taskId}/variables	Delete all local variables on a task
TasksApi	deleteAttachment	DELETE /runtime/tasks/{taskId}/attachments/{attachmentId}	Delete an attachment on a task
TasksApi	deleteEvent	DELETE /runtime/tasks/{taskId}/events/{eventId}	Delete an event on a task
TasksApi	deleteTask	DELETE /runtime/tasks/{taskId}	Delete a task
TasksApi	deleteTaskComment	DELETE /runtime/tasks/{taskId}/comments/{commentId}	Delete a comment on a task
TasksApi	deleteTaskInstanceIdentityLinks	DELETE /runtime/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}	Delete an identity link on a task
TasksApi	deleteTaskInstanceVariable	DELETE /runtime/tasks/{taskId}/variables/{variableName}	Delete a variable on a task
TasksApi	executeTaskAction	POST /runtime/tasks/{taskId}	Tasks actions
TasksApi	geTaskVariableData	GET /runtime/tasks/{taskId}/variables/{variableName}/data	Get the binary data for a variable
TasksApi	getAttachment	GET /runtime/tasks/{taskId}/attachments/{attachmentId}	Get an attachment on a task
TasksApi	getAttachmentContent	GET /runtime/tasks/{taskId}/attachments/{attachmentId}/content	Get the content for an attachment
TasksApi	getAttachments	GET /runtime/tasks/{taskId}/attachments	Get all attachments on a task
TasksApi	getEvent	GET /runtime/tasks/{taskId}/events/{eventId}	Get an event on a task
TasksApi	getEvents	GET /runtime/tasks/{taskId}/events	Get all events for a task
TasksApi	getIdentityLinksForFamily	GET /runtime/tasks/{taskId}/identitylinks/{family}	Get all identitylinks for a task for either groups or users
TasksApi	getQueryResult	POST /query/tasks	Query for tasks
TasksApi	getSubTasks	GET /runtime/tasks/{taskId}/subtasks	Get list of sub tasks for a task
TasksApi	getTask	GET /runtime/tasks/{taskId}	Get a task
TasksApi	getTaskComment	GET /runtime/tasks/{taskId}/comments/{commentId}	Get a comment on a task
TasksApi	getTaskInstanceIdentityLinks	GET /runtime/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}	Get a single identity link on a task
TasksApi	getTaskInstanceVariable	GET /runtime/tasks/{taskId}/variables/{variableName}	Get a variable from a task
TasksApi	getTasks	GET /runtime/tasks	List of tasks
TasksApi	listTaskComments	GET /runtime/tasks/{taskId}/comments	Get all comments on a task
TasksApi	listTaskVariables	GET /runtime/tasks/{taskId}/variables	Get all variables for a task
TasksApi	listTasksInstanceIdentityLinks	GET /runtime/tasks/{taskId}/identitylinks	Get all identity links for a task
TasksApi	updateTask	PUT /runtime/tasks/{taskId}	Update a task
TasksApi	updateTaskInstanceVariable	PUT /runtime/tasks/{taskId}/variables/{variableName}	Update an existing variable on a task
UsersApi	createUser	POST /identity/users	Create a user
UsersApi	createUserInfo	POST /identity/users/{userId}/info	Create a new user�s info entry
UsersApi	deleteUser	DELETE /identity/users/{userId}	Delete a user
UsersApi	deleteUserInfo	DELETE /identity/users/{userId}/info/{key}	Delete a user�s info
UsersApi	getUser	GET /identity/users/{userId}	Get a single user
UsersApi	getUserInfo	GET /identity/users/{userId}/info/{key}	Get a user�s info
UsersApi	getUserPicture	GET /identity/users/{userId}/picture	Get a user�s picture
UsersApi	getUsers	GET /identity/users	Get a list of users
UsersApi	listUsersInfo	GET /identity/users/{userId}/info	List a user�s info
UsersApi	updateUser	PUT /identity/users/{userId}	Update a user
UsersApi	updateUserInfo	PUT /identity/users/{userId}/info/{key}	Update a user�s info
UsersApi	updateUserPicture	PUT /identity/users/{userId}/picture	Updating a user�s picture

trahloff / activiti

Maintainers

Details

README

Requirements

Installation & Usage

Composer

Manual Installation

Tests

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

basicAuth

Author