swagger-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/swagger-java-client-1.0.0.jar
• target/lib/*.jar

Getting Started

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

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessmakerApi;

import java.io.File;
import java.util.*;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: internalApiKey
        ApiKeyAuth internalApiKey = (ApiKeyAuth) defaultClient.getAuthentication("internalApiKey");
        internalApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //internalApiKey.setApiKeyPrefix("Token");

        // Configure OAuth2 access token for authorization: PasswordGrant
        OAuth PasswordGrant = (OAuth) defaultClient.getAuthentication("PasswordGrant");
        PasswordGrant.setAccessToken("YOUR ACCESS TOKEN");

        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = "processId_example"; // String | ID of Process relative to task
        EventCreateItem eventCreateItem = new EventCreateItem(); // EventCreateItem | JsonApi with the Event object to add
        try {
            EventItem result = apiInstance.addEvent(processId, eventCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addEvent");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

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

Documentation for Models

• BpmnFile
• BpmnFileAttributes
• BpmnImportItem
• DataModel
• DataModelAttributes
• DataModelItem
• DataModelItem1
• DataModelItemAttributes
• DateTime
• Error
• ErrorArray
• Event
• EventAttributes
• EventCollection
• 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
• InlineResponse200
• InputOutput
• InputOutputAttributes
• InputOutputCollection
• InputOutputCreateItem
• InputOutputItem
• InputOutputUpdateItem
• Instance
• InstanceAttributes
• InstanceCollection
• InstanceCreateItem
• InstanceItem
• InstanceUpdateItem
• Meta
• MetaLog
• Pagination
• PaginationLinks
• Process
• ProcessAttributes
• ProcessCollection
• ProcessCollection1
• ProcessCreateItem
• ProcessItem
• ProcessUpdateItem
• ResultSuccess
• ResultSuccessMeta
• Task
• TaskAddGroupsItem
• TaskAttributes
• TaskCollection
• TaskCreateItem
• TaskInstance
• TaskInstanceAttributes
• TaskInstanceCollection
• TaskInstanceUpdateItem
• TaskItem
• TaskRemoveGroupsItem
• TaskSyncGroupsItem
• TaskUpdateItem
• TriggerEventCreateItem
• User
• UserAttributes
• UserCollection
• UserCreateItem
• UserIds
• UserItem
• UserUpdateItem

Documentation for Authorization

Authentication schemes defined for the API:

internalApiKey

• Type: API key
• API key parameter name: access_token
• Location: URL query string

PasswordGrant

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

alpha-program@processmaker.com