process_maker_api

ProcessMakerApi - JavaScript client for process_maker_api 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 class 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: 2017-06-01T08:08:35.890+03: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 process_maker_api --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 ProcessMakerApi = require('process_maker_api');

var defaultClient = ProcessMakerApi.ApiClient.instance;

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

var api = new ProcessMakerApi.ProcessmakerApi()

var userId = "userId_example"; // {String} ID of the user related to the Oauth client

var clientCreateItem = new ProcessMakerApi.ClientCreateItem(); // {ClientCreateItem} JSON API with the Oauth Client object to add


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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ProcessMakerApi.ProcessmakerApi	addClient	POST /users/{user_id}/clients
ProcessMakerApi.ProcessmakerApi	addEvent	POST /processes/{process_id}/events
ProcessMakerApi.ProcessmakerApi	addEventConnector	POST /processes/{process_id}/events/{event_id}/connectors
ProcessMakerApi.ProcessmakerApi	addFlow	POST /processes/{process_id}/flows
ProcessMakerApi.ProcessmakerApi	addGateway	POST /processes/{process_id}/gateways
ProcessMakerApi.ProcessmakerApi	addGroup	POST /groups
ProcessMakerApi.ProcessmakerApi	addGroupsToTask	PUT /processes/{process_id}/tasks/{task_id}/groups
ProcessMakerApi.ProcessmakerApi	addInputOutput	POST /processes/{process_id}/tasks/{task_id}/inputoutput
ProcessMakerApi.ProcessmakerApi	addInstance	POST /processes/{process_id}/instances
ProcessMakerApi.ProcessmakerApi	addProcess	POST /processes
ProcessMakerApi.ProcessmakerApi	addTask	POST /processes/{process_id}/tasks
ProcessMakerApi.ProcessmakerApi	addTaskConnector	POST /processes/{process_id}/tasks/{task_id}/connectors
ProcessMakerApi.ProcessmakerApi	addUser	POST /users
ProcessMakerApi.ProcessmakerApi	addUsersToGroup	PUT /groups/{id}/users
ProcessMakerApi.ProcessmakerApi	deleteClient	DELETE /users/{user_id}/clients/{client_id}
ProcessMakerApi.ProcessmakerApi	deleteEvent	DELETE /processes/{process_id}/events/{event_id}
ProcessMakerApi.ProcessmakerApi	deleteEventConnector	DELETE /processes/{process_id}/events/{event_id}/connectors/{connector_id}
ProcessMakerApi.ProcessmakerApi	deleteFlow	DELETE /processes/{process_id}/flows/{flow_id}
ProcessMakerApi.ProcessmakerApi	deleteGateway	DELETE /processes/{process_id}/gateways/{gateway_id}
ProcessMakerApi.ProcessmakerApi	deleteGroup	DELETE /groups/{id}
ProcessMakerApi.ProcessmakerApi	deleteInputOutput	DELETE /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
ProcessMakerApi.ProcessmakerApi	deleteInstance	DELETE /processes/{process_id}/instances/{instance_id}
ProcessMakerApi.ProcessmakerApi	deleteProcess	DELETE /processes/{id}
ProcessMakerApi.ProcessmakerApi	deleteTask	DELETE /processes/{process_id}/tasks/{task_id}
ProcessMakerApi.ProcessmakerApi	deleteTaskConnector	DELETE /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
ProcessMakerApi.ProcessmakerApi	deleteUser	DELETE /users/{id}
ProcessMakerApi.ProcessmakerApi	eventTrigger	POST /processes/{process_id}/events/{event_id}/trigger
ProcessMakerApi.ProcessmakerApi	findClientById	GET /users/{user_id}/clients/{client_id}
ProcessMakerApi.ProcessmakerApi	findClients	GET /users/{user_id}/clients
ProcessMakerApi.ProcessmakerApi	findDataModel	GET /processes/{process_id}/instances/{instance_id}/datamodel
ProcessMakerApi.ProcessmakerApi	findEventById	GET /processes/{process_id}/events/{event_id}
ProcessMakerApi.ProcessmakerApi	findEventConnectorById	GET /processes/{process_id}/events/{event_id}/connectors/{connector_id}
ProcessMakerApi.ProcessmakerApi	findEventConnectors	GET /processes/{process_id}/events/{event_id}/connectors
ProcessMakerApi.ProcessmakerApi	findEvents	GET /processes/{process_id}/events
ProcessMakerApi.ProcessmakerApi	findFlowById	GET /processes/{process_id}/flows/{flow_id}
ProcessMakerApi.ProcessmakerApi	findFlows	GET /processes/{process_id}/flows
ProcessMakerApi.ProcessmakerApi	findGatewayById	GET /processes/{process_id}/gateways/{gateway_id}
ProcessMakerApi.ProcessmakerApi	findGateways	GET /processes/{process_id}/gateways
ProcessMakerApi.ProcessmakerApi	findGroupById	GET /groups/{id}
ProcessMakerApi.ProcessmakerApi	findGroups	GET /groups
ProcessMakerApi.ProcessmakerApi	findInputOutputById	GET /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
ProcessMakerApi.ProcessmakerApi	findInputOutputs	GET /processes/{process_id}/tasks/{task_id}/inputoutput
ProcessMakerApi.ProcessmakerApi	findInstanceById	GET /processes/{process_id}/instances/{instance_id}
ProcessMakerApi.ProcessmakerApi	findInstances	GET /processes/{process_id}/instances
ProcessMakerApi.ProcessmakerApi	findProcessById	GET /processes/{id}
ProcessMakerApi.ProcessmakerApi	findProcesses	GET /processes
ProcessMakerApi.ProcessmakerApi	findTaskById	GET /processes/{process_id}/tasks/{task_id}
ProcessMakerApi.ProcessmakerApi	findTaskConnectorById	GET /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
ProcessMakerApi.ProcessmakerApi	findTaskConnectors	GET /processes/{process_id}/tasks/{task_id}/connectors
ProcessMakerApi.ProcessmakerApi	findTaskInstanceById	GET /task_instances/{task_instance_id}
ProcessMakerApi.ProcessmakerApi	findTaskInstances	GET /task_instances
ProcessMakerApi.ProcessmakerApi	findTasks	GET /processes/{process_id}/tasks
ProcessMakerApi.ProcessmakerApi	findUserById	GET /users/{id}
ProcessMakerApi.ProcessmakerApi	findUsers	GET /users
ProcessMakerApi.ProcessmakerApi	importBpmnFile	POST /processes/import
ProcessMakerApi.ProcessmakerApi	myselfUser	GET /users/myself
ProcessMakerApi.ProcessmakerApi	removeGroupsFromTask	DELETE /processes/{process_id}/tasks/{task_id}/groups
ProcessMakerApi.ProcessmakerApi	removeUsersFromGroup	DELETE /groups/{id}/users
ProcessMakerApi.ProcessmakerApi	syncGroupsToTask	POST /processes/{process_id}/tasks/{task_id}/groups
ProcessMakerApi.ProcessmakerApi	syncUsersToGroup	POST /groups/{id}/users
ProcessMakerApi.ProcessmakerApi	updateClient	PUT /users/{user_id}/clients/{client_id}
ProcessMakerApi.ProcessmakerApi	updateEvent	PUT /processes/{process_id}/events/{event_id}
ProcessMakerApi.ProcessmakerApi	updateEventConnector	PUT /processes/{process_id}/events/{event_id}/connectors/{connector_id}
ProcessMakerApi.ProcessmakerApi	updateFlow	PUT /processes/{process_id}/flows/{flow_id}
ProcessMakerApi.ProcessmakerApi	updateGateway	PUT /processes/{process_id}/gateways/{gateway_id}
ProcessMakerApi.ProcessmakerApi	updateGroup	PUT /groups/{id}
ProcessMakerApi.ProcessmakerApi	updateInputOutput	PUT /processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}
ProcessMakerApi.ProcessmakerApi	updateInstance	PUT /processes/{process_id}/instances/{instance_id}
ProcessMakerApi.ProcessmakerApi	updateProcess	PUT /processes/{id}
ProcessMakerApi.ProcessmakerApi	updateTask	PUT /processes/{process_id}/tasks/{task_id}
ProcessMakerApi.ProcessmakerApi	updateTaskConnector	PUT /processes/{process_id}/tasks/{task_id}/connectors/{connector_id}
ProcessMakerApi.ProcessmakerApi	updateTaskInstance	PATCH /task_instances/{task_instance_id}
ProcessMakerApi.ProcessmakerApi	updateUser	PUT /users/{id}

Documentation for Models

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

Documentation for Authorization

PasswordGrant

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