README

此处有龙

此 PHP 包由 Swagger Codegen 项目自动生成

API 版本：v0.2.0
构建包：io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.5 及以上

安装与使用

Composer

要使用 Composer 安装绑定，请将以下内容添加到 composer.json

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

然后运行 composer install

手动安装

下载文件并包含 autoload.php

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

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装过程进行操作，然后运行以下命令

<?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;
}

?>

API 端点文档

所有 URI 都相对于 https://activiti.ganymed.me/activiti-rest/service

类	方法	HTTP 请求	描述
DatabaseTablesApi	getTable	GET /management/tables/{tableName}	获取单个表
DatabaseTablesApi	getTableData	GET /management/tables/{tableName}/data	获取单个表的行数据
DatabaseTablesApi	getTableMetaData	GET /management/tables/{tableName}/columns	获取单个表的列信息
DatabaseTablesApi	getTables	GET /management/tables	表列表
DeploymentApi	deleteDeployment	DELETE /repository/deployments/{deploymentId}	删除部署
DeploymentApi	getDeployment	GET /repository/deployments/{deploymentId}	获取部署
DeploymentApi	getDeploymentResource	GET /repository/deployments/{deploymentId}/resources/**	获取部署资源
DeploymentApi	getDeploymentResourceData	GET /repository/deployments/{deploymentId}/resourcedata/{resourceId}	获取部署资源内容
DeploymentApi	getDeploymentResources	GET /repository/deployments/{deploymentId}/resources	获取部署中的资源列表
DeploymentApi	getDeployments	GET /repository/deployments	部署列表
DeploymentApi	uploadDeployment	POST /repository/deployments	创建新的部署
EngineApi	getEngineInfo	GET /management/engine	获取引擎信息
EngineApi	getProperties	GET /management/properties	获取引擎属性
ExecutionsApi	createExecutionVariable	POST /runtime/executions/{executionId}/variables	在执行过程中创建变量
ExecutionsApi	createOrUpdateExecutionVariable	PUT /runtime/executions/{executionId}/variables	更新执行过程中的变量
ExecutionsApi	deleteLocalVariables	DELETE /runtime/executions/{executionId}/variables	删除执行的所有变量
ExecutionsApi	deletedExecutionVariable	DELETE /runtime/executions/{executionId}/variables/{variableName}	删除执行中的变量
ExecutionsApi	executeExecutionAction	PUT /runtime/executions	收到信号事件
ExecutionsApi	getActiveActivities	GET /runtime/executions/{executionId}/activities	获取执行中的活动
ExecutionsApi	getExecution	GET /runtime/executions/{executionId}	获取执行
ExecutionsApi	getExecutionVariable	GET /runtime/executions/{executionId}/variables/{variableName}	获取执行中的变量
ExecutionsApi	getExecutionVariableData	GET /runtime/executions/{executionId}/variables/{variableName}/data	获取执行的二进制数据
ExecutionsApi	getExecutions	GET /runtime/executions	执行列表
ExecutionsApi	listExecutionVariables	GET /runtime/executions/{executionId}/variables	执行变量的列表
ExecutionsApi	performExecutionAction	PUT /runtime/executions/{executionId}	在执行上执行操作
ExecutionsApi	queryExecutions	POST /query/executions	查询执行
ExecutionsApi	updateExecutionVariable	PUT /runtime/executions/{executionId}/variables/{variableName}	更新执行上的变量
FormsApi	getFormData	GET /form/form-data	获取表单数据
FormsApi	submitForm	POST /form/form-data	提交任务表单数据
GroupsApi	createGroup	POST /identity/groups	创建组
GroupsApi	createMembership	POST /identity/groups/{groupId}/members	向组中添加成员
GroupsApi	deleteGroup	DELETE /identity/groups/{groupId}	删除组
GroupsApi	deleteMembership	DELETE /identity/groups/{groupId}/members/{userId}	从组中删除成员
GroupsApi	getGroup	GET /identity/groups/{groupId}	获取单个组
GroupsApi	getGroups	GET /identity/groups	获取组列表
GroupsApi	updateGroup	PUT /identity/groups/{groupId}	更新组
HistoryApi	createComment	POST /history/historic-process-instances/{processInstanceId}/comments	在历史流程实例上创建新评论
HistoryApi	deleteComment	DELETE /history/historic-process-instances/{processInstanceId}/comments/{commentId}	删除历史流程实例上的评论
HistoryApi	deleteHitoricProcessInstance	DELETE /history/historic-process-instances/{processInstanceId}	删除历史流程实例
HistoryApi	deleteTaskInstance	DELETE /history/historic-task-instances/{taskId}	删除历史任务实例
HistoryApi	getComment	GET /history/historic-process-instances/{processInstanceId}/comments/{commentId}	获取历史流程实例上的评论
HistoryApi	getComments	GET /history/historic-process-instances/{processInstanceId}/comments	获取历史流程实例上的所有评论
HistoryApi	getHistoricActivityInstances	GET /history/historic-activity-instances	获取历史活动实例
HistoryApi	getHistoricDetailInfo	GET /history/historic-detail	获取历史详情
HistoryApi	getHistoricDetailVariableData	GET /history/historic-detail/{detailId}/data	获取历史详情变量的二进制数据
HistoryApi	getHistoricInstanceVariableData	GET /history/historic-variable-instances/{varInstanceId}/data	获取历史任务实例变量的二进制数据
HistoryApi	getHistoricProcessInstance	GET /history/historic-process-instances/{processInstanceId}	获取历史流程实例
HistoryApi	getHistoricProcessInstanceVariableData	GET /history/historic-process-instances/{processInstanceId}/variables/{variableName}/data	获取历史流程实例变量的二进制数据
HistoryApi	getHistoricTaskInstanceVariableData	GET /history/historic-task-instances/{taskId}/variables/{variableName}/data	获取历史任务实例变量的二进制数据
HistoryApi	getHistoricVariableInstances	GET /history/historic-variable-instances	历史变量实例列表
HistoryApi	getProcessIdentityLinks	GET /history/historic-process-instances/{processInstanceId}/identitylinks	获取历史流程实例的身份链接
HistoryApi	getTaskIdentityLinks	GET /history/historic-task-instances/{taskId}/identitylinks	获取历史任务实例的身份链接
HistoryApi	getTaskInstance	GET /history/historic-task-instances/{taskId}	获取单个历史任务实例
HistoryApi	listHistoricProcessInstances	GET /history/historic-process-instances	历史流程实例列表
HistoryApi	listHistoricTaskInstances	GET /history/historic-task-instances	获取历史任务实例
HistoryApi	queryActivityInstances	POST /query/historic-activity-instances	查询历史活动实例
HistoryApi	queryHistoricDetail	POST /query/historic-detail	查询历史详情
HistoryApi	queryHistoricProcessInstance	POST /query/historic-process-instances	查询历史流程实例
HistoryApi	queryHistoricTaskInstance	POST /query/historic-task-instances	查询历史任务实例
HistoryApi	queryVariableInstances	POST /query/historic-variable-instances	查询历史变量实例
JobsApi	deleteDeadLetterJob	DELETE /management/deadletter-jobs/{jobId}	删除死信作业
JobsApi	deleteJob	DELETE /management/jobs/{jobId}	删除作业
JobsApi	deleteTimerJob	DELETE /management/timer-jobs/{jobId}	删除定时作业
JobsApi	executeJobAction	POST /management/jobs/{jobId}	执行单个作业
JobsApi	getDeadLetterJobStacktrace	GET /management/deadletter-jobs/{jobId}/exception-stacktrace	获取死信作业的异常堆栈跟踪
JobsApi	getDeadletterJob	GET /management/deadletter-jobs/{jobId}	获取单个死信作业
JobsApi	getJob	GET /management/jobs/{jobId}	获取单个作业
JobsApi	getJobStacktrace	GET /management/jobs/{jobId}/exception-stacktrace	获取作业的异常堆栈跟踪
JobsApi	getSuspendedJob	GET /management/suspended-jobs/{jobId}	获取单个挂起作业
JobsApi	getSuspendedJobStacktrace	GET /management/suspended-jobs/{jobId}/exception-stacktrace	获取挂起作业的异常堆栈跟踪
JobsApi	getTimerJob	GET /management/timer-jobs/{jobId}	获取单个定时作业
JobsApi	getTimerJobStacktrace	GET /management/timer-jobs/{jobId}/exception-stacktrace	获取定时作业的异常堆栈跟踪
JobsApi	listDeadLetterJobs	GET /management/deadletter-jobs	获取死信作业列表
JobsApi	listJobs	GET /management/jobs	获取作业列表
JobsApi	listSuspendedJobs	GET /management/suspended-jobs	获取挂起作业列表
JobsApi	listTimerJobs	GET /management/timer-jobs	获取定时作业列表
ModelsApi	createModel	POST /repository/models	创建模型
ModelsApi	deleteModel	DELETE /repository/models/{modelId}	删除模型
ModelsApi	getModel	GET /repository/models/{modelId}	获取模型
ModelsApi	getModels	GET /repository/models	获取模型列表
ModelsApi	updateModel	PUT /repository/models/{modelId}	更新模型
ProcessDefinitionsApi	createIdentityLink	POST /repository/process-definitions/{processDefinitionId}/identitylinks	将候选启动者添加到流程定义中
ProcessDefinitionsApi	deleteIdentityLink	DELETE /repository/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}	从流程定义中删除候选启动者
ProcessDefinitionsApi	executeProcessDefinitionAction	PUT /repository/process-definitions/{processDefinitionId}	对流程定义执行操作（更新类别、挂起或激活）
ProcessDefinitionsApi	getBpmnModelResource	GET /repository/process-definitions/{processDefinitionId}/model	获取流程定义的BPMN模型
ProcessDefinitionsApi	getIdentityLink	GET /repository/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}	从流程定义中获取候选启动者
ProcessDefinitionsApi	getIdentityLinks	GET /repository/process-definitions/{processDefinitionId}/identitylinks	获取流程定义的所有候选启动者
ProcessDefinitionsApi	getModelResource	GET /repository/process-definitions/{processDefinitionId}/image	获取流程定义图像
ProcessDefinitionsApi	getProcessDefinition	GET /repository/process-definitions/{processDefinitionId}	获取流程定义
ProcessDefinitionsApi	getProcessDefinitionResource	GET /repository/process-definitions/{processDefinitionId}/resourcedata	获取流程定义资源内容
ProcessDefinitionsApi	getProcessDefinitions	GET /repository/process-definitions	流程定义列表
ProcessInstancesApi	createOrUpdateProcessVariable	PUT /runtime/process-instances/{processInstanceId}/variables	更新流程实例的单个或二进制变量或多个变量
ProcessInstancesApi	createProcessInstance	POST /runtime/process-instances	启动流程实例
ProcessInstancesApi	createProcessInstanceIdentityLinks	POST /runtime/process-instances/{processInstanceId}/identitylinks	将涉及的用户添加到流程实例中
ProcessInstancesApi	createProcessInstanceVariable	POST /runtime/process-instances/{processInstanceId}/variables	在流程实例上创建变量或新的二进制变量
ProcessInstancesApi	deleteLocalProcessVariable	DELETE /runtime/process-instances/{processInstanceId}/variables	删除所有变量
ProcessInstancesApi	deleteProcessInstance	DELETE /runtime/process-instances/{processInstanceId}	删除流程实例
ProcessInstancesApi	deleteProcessInstanceIdentityLinks	DELETE /runtime/process-instances/{processInstanceId}/identitylinks/users/{identityId}/{type}	从流程实例中移除涉及的用户
ProcessInstancesApi	deleteProcessInstanceVariable	DELETE /runtime/process-instances/{processInstanceId}/variables/{variableName}	删除变量
ProcessInstancesApi	getProcessInstance	GET /runtime/process-instances/{processInstanceId}	获取流程实例
ProcessInstancesApi	getProcessInstanceDiagram	GET /runtime/process-instances/{processInstanceId}/diagram	获取流程实例的图
ProcessInstancesApi	getProcessInstanceIdentityLinks	GET /runtime/process-instances/{processInstanceId}/identitylinks/users/{identityId}/{type}	从流程实例中获取特定的涉及人员
ProcessInstancesApi	getProcessInstanceVariable	GET /runtime/process-instances/{processInstanceId}/variables/{variableName}	获取流程实例的变量
ProcessInstancesApi	getProcessInstanceVariableData	GET /runtime/process-instances/{processInstanceId}/variables/{variableName}/data	获取变量的二进制数据
ProcessInstancesApi	getProcessInstances	GET /runtime/process-instances	流程实例列表
ProcessInstancesApi	getVariables	GET /runtime/process-instances/{processInstanceId}/variables	流程实例变量列表
ProcessInstancesApi	listProcessInstanceIdentityLinks	GET /runtime/process-instances/{processInstanceId}/identitylinks	获取流程实例的涉及人员
ProcessInstancesApi	performProcessInstanceAction	PUT /runtime/process-instances/{processInstanceId}	激活或挂起流程实例
ProcessInstancesApi	queryProcessInstances	POST /query/process-instances	查询流程实例
ProcessInstancesApi	updateProcessInstanceVariable	PUT /runtime/process-instances/{processInstanceId}/variables/{variableName}	更新流程实例上的单个变量
RuntimeApi	signalEventReceived	POST /runtime/signals	收到信号事件
TasksApi	createAttachment	POST /runtime/tasks/{taskId}/attachments	在任务上创建一个新的附件，包含指向外部资源或附加文件的链接
TasksApi	createTask	POST /runtime/tasks	创建任务
TasksApi	createTaskComments	POST /runtime/tasks/{taskId}/comments	在任务上创建一个新的评论
TasksApi	createTaskInstanceIdentityLinks	POST /runtime/tasks/{taskId}/identitylinks	在任务上创建一个身份链接
TasksApi	createTaskVariable	POST /runtime/tasks/{taskId}/variables	在任务上创建新的变量
TasksApi	deleteAllLocalTaskVariables	DELETE /runtime/tasks/{taskId}/variables	删除任务上的所有本地变量
TasksApi	deleteAttachment	DELETE /runtime/tasks/{taskId}/attachments/{attachmentId}	删除任务上的附件
TasksApi	deleteEvent	DELETE /runtime/tasks/{taskId}/events/{eventId}	删除任务上的事件
TasksApi	deleteTask	DELETE /runtime/tasks/{taskId}	删除任务
TasksApi	deleteTaskComment	DELETE /runtime/tasks/{taskId}/comments/{commentId}	删除任务上的评论
TasksApi	deleteTaskInstanceIdentityLinks	DELETE /runtime/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}	删除任务上的身份链接
TasksApi	deleteTaskInstanceVariable	DELETE /runtime/tasks/{taskId}/variables/{variableName}	删除任务上的变量
TasksApi	executeTaskAction	POST /runtime/tasks/{taskId}	任务操作
TasksApi	geTaskVariableData	GET /runtime/tasks/{taskId}/variables/{variableName}/data	获取变量的二进制数据
TasksApi	getAttachment	GET /runtime/tasks/{taskId}/attachments/{attachmentId}	获取任务上的附件
TasksApi	getAttachmentContent	GET /runtime/tasks/{taskId}/attachments/{attachmentId}/content	获取附件内容
TasksApi	getAttachments	GET /runtime/tasks/{taskId}/attachments	获取任务上的所有附件
TasksApi	getEvent	GET /runtime/tasks/{taskId}/events/{eventId}	获取任务上的事件
TasksApi	getEvents	GET /runtime/tasks/{taskId}/events	获取任务上的所有事件
TasksApi	getIdentityLinksForFamily	GET /runtime/tasks/{taskId}/identitylinks/{family}	获取任务上所有身份链接（针对组或用户）
TasksApi	getQueryResult	POST /query/tasks	查询任务
TasksApi	getSubTasks	GET /runtime/tasks/{taskId}/subtasks	获取任务的子任务列表
TasksApi	getTask	GET /runtime/tasks/{taskId}	获取任务
TasksApi	getTaskComment	GET /runtime/tasks/{taskId}/comments/{commentId}	获取任务上的评论
TasksApi	getTaskInstanceIdentityLinks	GET /runtime/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}	获取任务上的单个身份链接
TasksApi	getTaskInstanceVariable	GET /runtime/tasks/{taskId}/variables/{variableName}	从任务中获取变量
TasksApi	getTasks	GET /runtime/tasks	任务列表
TasksApi	listTaskComments	GET /runtime/tasks/{taskId}/comments	获取任务上的所有评论
TasksApi	listTaskVariables	GET /runtime/tasks/{taskId}/variables	获取任务上的所有变量
TasksApi	listTasksInstanceIdentityLinks	GET /runtime/tasks/{taskId}/identitylinks	获取任务上的所有身份链接
TasksApi	updateTask	PUT /runtime/tasks/{taskId}	更新任务
TasksApi	updateTaskInstanceVariable	PUT /runtime/tasks/{taskId}/variables/{variableName}	更新任务上的现有变量
UsersApi	createUser	POST /identity/users	创建用户
UsersApi	createUserInfo	POST /identity/users/{userId}/info	创建新用户的信息条目
UsersApi	deleteUser	DELETE /identity/users/{userId}	删除用户
UsersApi	deleteUserInfo	DELETE /identity/users/{userId}/info/{key}	删除用户信息
UsersApi	getUser	GET /identity/users/{userId}	获取单个用户
UsersApi	getUserInfo	GET /identity/users/{userId}/info/{key}	获取用户信息
UsersApi	getUserPicture	GET /identity/users/{userId}/picture	获取用户图片
UsersApi	getUsers	GET /identity/users	获取用户列表
UsersApi	listUsersInfo	GET /identity/users/{userId}/info	列出用户信息
UsersApi	updateUser	PUT /identity/users/{userId}	更新用户
UsersApi	updateUserInfo	PUT /identity/users/{userId}/info/{key}	更新用户信息
UsersApi	updateUserPicture	PUT /identity/users/{userId}/picture	更新用户图片

trahloff / activiti

维护者

详细信息

README

要求

安装与使用

Composer

手动安装

测试

入门

API 端点文档

模型文档

授权文档

基本认证

作者