Giters

MindfulwareDev / pmio-sdk-javascript

PMIO SDK JavaScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PMIO

PMIO - JavaScript client for PMIO 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 SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2018-02-01T08:44:35.901+02:00
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.processmaker.io/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install PMIO --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var PMIO = require('PMIO');

var defaultClient = PMIO.ApiClient.instance;

// Configure OAuth2 access token for authorization: PasswordGrant
var PasswordGrant = defaultClient.authentications['PasswordGrant'];
PasswordGrant.accessToken = "YOUR ACCESS TOKEN"

var api = new PMIO.Client()

var processId = "processId_example"; // {String} ID of the process related to the event

var eventCreateItem = new PMIO.EventCreateItem(); // {EventCreateItem} JSON API response with the event object to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addEvent(processId, eventCreateItem, callback);

Documentation for API Endpoints

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

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

Documentation for Models

Documentation for Authorization

PasswordGrant

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

About

PMIO SDK JavaScript

License:Apache License 2.0

Languages

Language:JavaScript 99.9%Language:Shell 0.1%