processmaker/pmio-sdk-php

dev-master 2018-02-05 09:22 UTC

Requires

• php: >=5.4
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

Apache-2.0

• PMIO PHP SDK

• php
• api
• sdk
• pmio

README

This ProcessMaker I/O API provides access to a BPMN 2.0 compliant workflow engine API that is designed to be used as a microservice to support enterprise cloud applications. The current Alpha 1.0 version supports most of the descriptive classes of the BPMN 2.0 specification.

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

• API version: 1.0.0
• Package version: 1.0.0
• Build date: 2017-10-30T20:11:02.634+02:00
• Build package: class io.swagger.codegen.languages.PhpClientCodegen For more information, please visit https://www.processmaker.io/

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/pmio-sdk-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure OAuth2 access token for authorization: PasswordGrant
ProcessMaker\PMIO\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new ProcessMaker\PMIO\Api\Client();
$process_id = "process_id_example"; // string | ID of the process related to the event
$event_create_item = new \ProcessMaker\PMIO\Model\EventCreateItem(); // \ProcessMaker\PMIO\Model\EventCreateItem | JSON API response with the event object to add

try {
    $result = $api_instance->addEvent($process_id, $event_create_item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Client->addEvent: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://CHANGEME.api.processmaker.io/api/v1

Class	Method	HTTP request	Description
Client	addEvent	POST /processes/{process_id}/events
Client	addEventConnector	POST /processes/{process_id}/events/{event_id}/connectors
Client	addFlow	POST /processes/{process_id}/flows
Client	addGateway	POST /processes/{process_id}/gateways
Client	addGroup	POST /groups
Client	addGroupsToTask	PUT /processes/{process_id}/tasks/{task_id}/groups
Client	addInputOutput	POST /processes/{process_id}/tasks/{task_id}/inputoutput
Client	addInstance	POST /processes/{process_id}/instances
Client	addOauthClient	POST /users/{user_id}/clients
Client	addProcess	POST /processes
Client	addTask	POST /processes/{process_id}/tasks
Client	addTaskConnector	POST /processes/{process_id}/tasks/{task_id}/connectors
Client	addUser	POST /users
Client	addUsersToGroup	PUT /groups/{id}/users
Client	deleteEvent	DELETE /processes/{process_id}/events/{event_id}
Client	deleteEventConnector	DELETE /processes/{process_id}/events/{event_id}/connectors/{connector_id}
Client	deleteFlow	DELETE /processes/{process_id}/flows/{flow_id}
Client	deleteGateway	DELETE /processes/{process_id}/gateways/{gateway_id}
Client	deleteGroup	DELETE /groups/{id}
Client	deleteInputOutput	DELETE /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
Client	deleteInstance	DELETE /processes/{process_id}/instances/{instance_id}
Client	deleteOauthClient	DELETE /users/{user_id}/clients/{client_id}
Client	deleteProcess	DELETE /processes/{id}
Client	deleteTask	DELETE /processes/{process_id}/tasks/{task_id}
Client	deleteTaskConnector	DELETE /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
Client	deleteUser	DELETE /users/{id}
Client	eventTrigger	POST /processes/{process_id}/events/{event_id}/trigger
Client	eventWebhook	POST /processes/{process_id}/events/{event_id}/webhook
Client	findDataModel	GET /processes/{process_id}/instances/{instance_id}/datamodel
Client	findEventById	GET /processes/{process_id}/events/{event_id}
Client	findEventConnectorById	GET /processes/{process_id}/events/{event_id}/connectors/{connector_id}
Client	findFlowById	GET /processes/{process_id}/flows/{flow_id}
Client	findGatewayById	GET /processes/{process_id}/gateways/{gateway_id}
Client	findGroupById	GET /groups/{id}
Client	findInputOutputById	GET /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
Client	findInstanceById	GET /processes/{process_id}/instances/{instance_id}
Client	findOauthClientById	GET /users/{user_id}/clients/{client_id}
Client	findProcessById	GET /processes/{id}
Client	findTaskById	GET /processes/{process_id}/tasks/{task_id}
Client	findTaskConnectorById	GET /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
Client	findTaskInstanceById	GET /task_instances/{task_instance_id}
Client	findUserById	GET /users/{id}
Client	import	POST /processes/import/bpmn
Client	importBpmnFile	POST /processes/import
Client	listByFieldInsideDataModel	GET /processes/{process_id}/datamodels/search/{search_param}
Client	listEventConnectors	GET /processes/{process_id}/events/{event_id}/connectors
Client	listEvents	GET /processes/{process_id}/events
Client	listFlows	GET /processes/{process_id}/flows
Client	listGateways	GET /processes/{process_id}/gateways
Client	listGroups	GET /groups
Client	listInputOutputs	GET /processes/{process_id}/tasks/{task_id}/inputoutput
Client	listInstances	GET /processes/{process_id}/instances
Client	listOauthClients	GET /users/{user_id}/clients
Client	listProcesses	GET /processes
Client	listTaskConnectors	GET /processes/{process_id}/tasks/{task_id}/connectors
Client	listTaskInstances	GET /task_instances
Client	listTaskInstancesByInstanceAndTaskId	GET /instances/{instance_id}/tasks/{task_id}/task_instances
Client	listTaskInstancesByInstanceAndTaskIdDelegated	GET /instances/{instance_id}/tasks/{task_id}/task_instances/delegated
Client	listTaskInstancesByInstanceAndTaskIdStarted	GET /instances/{instance_id}/tasks/{task_id}/task_instances/started
Client	listTasks	GET /processes/{process_id}/tasks
Client	listTokens	GET /processes/{process_id}/instances/{instance_id}/tokens
Client	listUsers	GET /users
Client	myselfUser	GET /users/myself
Client	removeGroupsFromTask	DELETE /processes/{process_id}/tasks/{task_id}/groups
Client	removeUsersFromGroup	DELETE /groups/{id}/users
Client	syncGroupsToTask	POST /processes/{process_id}/tasks/{task_id}/groups
Client	syncUsersToGroup	POST /groups/{id}/users
Client	updateEvent	PUT /processes/{process_id}/events/{event_id}
Client	updateEventConnector	PUT /processes/{process_id}/events/{event_id}/connectors/{connector_id}
Client	updateFlow	PUT /processes/{process_id}/flows/{flow_id}
Client	updateGateway	PUT /processes/{process_id}/gateways/{gateway_id}
Client	updateGroup	PUT /groups/{id}
Client	updateInputOutput	PUT /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
Client	updateInstance	PUT /processes/{process_id}/instances/{instance_id}
Client	updateOauthClient	PUT /users/{user_id}/clients/{client_id}
Client	updateProcess	PUT /processes/{id}
Client	updateTask	PUT /processes/{process_id}/tasks/{task_id}
Client	updateTaskConnector	PUT /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
Client	updateTaskInstance	PATCH /task_instances/{task_instance_id}
Client	updateUser	PUT /users/{id}
Events	addEvent	POST /processes/{process_id}/events
Events	addEventConnector	POST /processes/{process_id}/events/{event_id}/connectors
Events	deleteEvent	DELETE /processes/{process_id}/events/{event_id}
Events	deleteEventConnector	DELETE /processes/{process_id}/events/{event_id}/connectors/{connector_id}
Events	eventTrigger	POST /processes/{process_id}/events/{event_id}/trigger
Events	eventWebhook	POST /processes/{process_id}/events/{event_id}/webhook
Events	findEventById	GET /processes/{process_id}/events/{event_id}
Events	findEventConnectorById	GET /processes/{process_id}/events/{event_id}/connectors/{connector_id}
Events	listEventConnectors	GET /processes/{process_id}/events/{event_id}/connectors
Events	listEvents	GET /processes/{process_id}/events
Events	updateEvent	PUT /processes/{process_id}/events/{event_id}
Events	updateEventConnector	PUT /processes/{process_id}/events/{event_id}/connectors/{connector_id}
Flows	addFlow	POST /processes/{process_id}/flows
Flows	deleteFlow	DELETE /processes/{process_id}/flows/{flow_id}
Flows	findFlowById	GET /processes/{process_id}/flows/{flow_id}
Flows	listFlows	GET /processes/{process_id}/flows
Flows	updateFlow	PUT /processes/{process_id}/flows/{flow_id}
Gateways	addGateway	POST /processes/{process_id}/gateways
Gateways	deleteGateway	DELETE /processes/{process_id}/gateways/{gateway_id}
Gateways	findGatewayById	GET /processes/{process_id}/gateways/{gateway_id}
Gateways	listGateways	GET /processes/{process_id}/gateways
Gateways	updateGateway	PUT /processes/{process_id}/gateways/{gateway_id}
Groups	addGroup	POST /groups
Groups	addUsersToGroup	PUT /groups/{id}/users
Groups	deleteGroup	DELETE /groups/{id}
Groups	findGroupById	GET /groups/{id}
Groups	listGroups	GET /groups
Groups	removeUsersFromGroup	DELETE /groups/{id}/users
Groups	syncUsersToGroup	POST /groups/{id}/users
Groups	updateGroup	PUT /groups/{id}
Inputoutput	addInputOutput	POST /processes/{process_id}/tasks/{task_id}/inputoutput
Inputoutput	deleteInputOutput	DELETE /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
Inputoutput	findInputOutputById	GET /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
Inputoutput	listInputOutputs	GET /processes/{process_id}/tasks/{task_id}/inputoutput
Inputoutput	updateInputOutput	PUT /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
Oauth	addOauthClient	POST /users/{user_id}/clients
Oauth	findOauthClientById	GET /users/{user_id}/clients/{client_id}
Oauth	listOauthClients	GET /users/{user_id}/clients
ProcessInstances	addInstance	POST /processes/{process_id}/instances
ProcessInstances	deleteInstance	DELETE /processes/{process_id}/instances/{instance_id}
ProcessInstances	findDataModel	GET /processes/{process_id}/instances/{instance_id}/datamodel
ProcessInstances	findInstanceById	GET /processes/{process_id}/instances/{instance_id}
ProcessInstances	listByFieldInsideDataModel	GET /processes/{process_id}/datamodels/search/{search_param}
ProcessInstances	listInstances	GET /processes/{process_id}/instances
ProcessInstances	listTaskInstancesByInstanceAndTaskId	GET /instances/{instance_id}/tasks/{task_id}/task_instances
ProcessInstances	listTaskInstancesByInstanceAndTaskIdDelegated	GET /instances/{instance_id}/tasks/{task_id}/task_instances/delegated
ProcessInstances	listTaskInstancesByInstanceAndTaskIdStarted	GET /instances/{instance_id}/tasks/{task_id}/task_instances/started
ProcessInstances	listTokens	GET /processes/{process_id}/instances/{instance_id}/tokens
ProcessInstances	updateInstance	PUT /processes/{process_id}/instances/{instance_id}
Processes	addProcess	POST /processes
Processes	deleteProcess	DELETE /processes/{id}
Processes	findProcessById	GET /processes/{id}
Processes	import	POST /processes/import/bpmn
Processes	importBpmnFile	POST /processes/import
Processes	listProcesses	GET /processes
Processes	updateProcess	PUT /processes/{id}
Tasks	addGroupsToTask	PUT /processes/{process_id}/tasks/{task_id}/groups
Tasks	addTask	POST /processes/{process_id}/tasks
Tasks	addTaskConnector	POST /processes/{process_id}/tasks/{task_id}/connectors
Tasks	deleteTask	DELETE /processes/{process_id}/tasks/{task_id}
Tasks	deleteTaskConnector	DELETE /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
Tasks	findTaskById	GET /processes/{process_id}/tasks/{task_id}
Tasks	findTaskConnectorById	GET /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
Tasks	findTaskInstanceById	GET /task_instances/{task_instance_id}
Tasks	listTaskConnectors	GET /processes/{process_id}/tasks/{task_id}/connectors
Tasks	listTaskInstances	GET /task_instances
Tasks	listTasks	GET /processes/{process_id}/tasks
Tasks	removeGroupsFromTask	DELETE /processes/{process_id}/tasks/{task_id}/groups
Tasks	syncGroupsToTask	POST /processes/{process_id}/tasks/{task_id}/groups
Tasks	updateTask	PUT /processes/{process_id}/tasks/{task_id}
Tasks	updateTaskConnector	PUT /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
Tasks	updateTaskInstance	PATCH /task_instances/{task_instance_id}
Users	addUser	POST /users
Users	deleteUser	DELETE /users/{id}
Users	findUserById	GET /users/{id}
Users	listUsers	GET /users
Users	myselfUser	GET /users/myself
Users	updateUser	PUT /users/{id}

Documentation For Models

• BpmnFile
• BpmnFileAttributes
• BpmnImportItem
• DataModel
• DataModelAttributes
• DataModelCollection
• DataModelItem
• DataModelItem1
• DataModelItemAttributes
• Error
• ErrorArray
• Event
• EventAttributes
• EventCollection
• EventConnector
• EventConnector1
• EventConnectorAttributes
• EventConnectorCreateItem
• EventConnectorUpdateItem
• EventConnectorsCollection
• EventCreateItem
• EventItem
• EventUpdateItem
• Flow
• FlowAttributes
• FlowCollection
• FlowCreateItem
• FlowItem
• FlowUpdateItem
• Gateway
• GatewayAttributes
• GatewayCollection
• GatewayCreateItem
• GatewayItem
• GatewayUpdateItem
• Group
• GroupAddUsersItem
• GroupAttributes
• GroupCollection
• GroupCreateItem
• GroupIds
• GroupItem
• GroupRemoveUsersItem
• GroupSyncUsersItem
• GroupUpdateItem
• ImportFile
• ImportFileAttributes
• ImportItem
• InlineResponse200
• InputOutput
• InputOutputAttributes
• InputOutputCollection
• InputOutputCreateItem
• InputOutputItem
• InputOutputUpdateItem
• Instance
• InstanceAttributes
• InstanceCollection
• InstanceCreateItem
• InstanceItem
• InstanceUpdateItem
• Meta
• MetaLog
• OauthClient
• OauthClientAttributes
• OauthClientCollection
• OauthClientCreateItem
• OauthClientItem
• OauthClientUpdateItem
• Pagination
• PaginationLinks
• Process
• ProcessAttributes
• ProcessCollection
• ProcessCollection1
• ProcessCreateItem
• ProcessItem
• ProcessUpdateItem
• ResultSuccess
• ResultSuccessMeta
• Task
• TaskAddGroupsItem
• TaskAttributes
• TaskCollection
• TaskConnector
• TaskConnector1
• TaskConnectorAttributes
• TaskConnectorCreateItem
• TaskConnectorUpdateItem
• TaskConnectorsCollection
• TaskCreateItem
• TaskInstance
• TaskInstanceAttributes
• TaskInstanceCollection
• TaskInstanceUpdateItem
• TaskItem
• TaskRemoveGroupsItem
• TaskSyncGroupsItem
• TaskUpdateItem
• Token
• TokenAttributes
• TokenCollection
• TriggerEventCreateItem
• User
• UserAttributes
• UserCollection
• UserCreateItem
• UserIds
• UserItem
• UserUpdateItem

Documentation For Authorization

PasswordGrant

• Type: OAuth
• Flow: password
• Authorization URL: /oauth/access_token
• Scopes: N/A

Author

[e-mail]