ProcessMaker API

Processmaker

addClient

This method is intended for creating a new Client for User


/users/{user_id}/clients

Usage and SDK Samples


curl -X post "http://localhost/api/v1/users/{user_id}/clients"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 userId = userId_example; // String | ID of User relative to client
        ClientCreateItem clientCreateItem = ; // ClientCreateItem | JsonApi with the Client object to add
        try {
            ClientItem result = apiInstance.addClient(userId, clientCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addClient");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String userId = userId_example; // String | ID of User relative to client
        ClientCreateItem clientCreateItem = ; // ClientCreateItem | JsonApi with the Client object to add
        try {
            ClientItem result = apiInstance.addClient(userId, clientCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addClient");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *userId = userId_example; // ID of User relative to client
ClientCreateItem *clientCreateItem = ; // JsonApi with the Client object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addClientWith:userId
    clientCreateItem:clientCreateItem
              completionHandler: ^(ClientItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var userId = userId_example; // {String} ID of User relative to client

var clientCreateItem = ; // {ClientCreateItem} JsonApi with the 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);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addClientExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var userId = userId_example;  // String | ID of User relative to client
            var clientCreateItem = new ClientCreateItem(); // ClientCreateItem | JsonApi with the Client object to add

            try
            {
                ClientItem result = apiInstance.addClient(userId, clientCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addClient: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$userId = userId_example; // String | ID of User relative to client
$clientCreateItem = ; // ClientCreateItem | JsonApi with the Client object to add

try {
    $result = $api_instance->addClient($userId, $clientCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addClient: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
userId*
Body parameters
Name Description
clientCreateItem *

Responses

Status: 201 - The request has been fulfilled and Client being created

Status: 400 - Invalid parameters

Status: 0 - unexpected error


addEvent

This method is intended for creating a new event.


/processes/{process_id}/events

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/events"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 = ; // 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();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to task
        EventCreateItem 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();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to task
EventCreateItem *eventCreateItem = ; // JsonApi with the Event object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addEventWith:processId
    eventCreateItem:eventCreateItem
              completionHandler: ^(EventItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to task

var eventCreateItem = ; // {EventCreateItem} JsonApi 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);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addEventExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to task
            var eventCreateItem = new EventCreateItem(); // EventCreateItem | JsonApi with the Event object to add

            try
            {
                EventItem result = apiInstance.addEvent(processId, eventCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addEvent: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to task
$eventCreateItem = ; // EventCreateItem | JsonApi with the Event object to add

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

                                                  

Parameters

Path parameters
Name Description
processId*
Body parameters
Name Description
eventCreateItem *

Responses

Status: 201 - Created Event response

Status: 400 - Invalid parameters

Status: 404 - Not found item

Status: 500 - Internal server error

Status: 0 - unexpected error


addFlow

This method is intended for creating a new Sequence flow


/processes/{process_id}/flows

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/flows"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 flow
        FlowCreateItem flowCreateItem = ; // FlowCreateItem | JsonApi with the Flow object to add
        try {
            FlowItem result = apiInstance.addFlow(processId, flowCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addFlow");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to flow
        FlowCreateItem flowCreateItem = ; // FlowCreateItem | JsonApi with the Flow object to add
        try {
            FlowItem result = apiInstance.addFlow(processId, flowCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addFlow");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to flow
FlowCreateItem *flowCreateItem = ; // JsonApi with the Flow object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addFlowWith:processId
    flowCreateItem:flowCreateItem
              completionHandler: ^(FlowItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to flow

var flowCreateItem = ; // {FlowCreateItem} JsonApi with the Flow object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addFlowExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to flow
            var flowCreateItem = new FlowCreateItem(); // FlowCreateItem | JsonApi with the Flow object to add

            try
            {
                FlowItem result = apiInstance.addFlow(processId, flowCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addFlow: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to flow
$flowCreateItem = ; // FlowCreateItem | JsonApi with the Flow object to add

try {
    $result = $api_instance->addFlow($processId, $flowCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addFlow: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Body parameters
Name Description
flowCreateItem *

Responses

Status: 201 - The request has been fulfilled and Sequence Flow being created

Status: 400 - Invalid parameters

Status: 404 - Not found item

Status: 500 - Internal server error

Status: 0 - unexpected error


addGateway

This method is intended for creating a new gateway.


/processes/{process_id}/gateways

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/gateways"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 gateway
        GatewayCreateItem gatewayCreateItem = ; // GatewayCreateItem | JsonApi with the Gateway object to add
        try {
            GatewayItem result = apiInstance.addGateway(processId, gatewayCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addGateway");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to gateway
        GatewayCreateItem gatewayCreateItem = ; // GatewayCreateItem | JsonApi with the Gateway object to add
        try {
            GatewayItem result = apiInstance.addGateway(processId, gatewayCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addGateway");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to gateway
GatewayCreateItem *gatewayCreateItem = ; // JsonApi with the Gateway object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addGatewayWith:processId
    gatewayCreateItem:gatewayCreateItem
              completionHandler: ^(GatewayItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to gateway

var gatewayCreateItem = ; // {GatewayCreateItem} JsonApi with the Gateway object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addGatewayExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to gateway
            var gatewayCreateItem = new GatewayCreateItem(); // GatewayCreateItem | JsonApi with the Gateway object to add

            try
            {
                GatewayItem result = apiInstance.addGateway(processId, gatewayCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addGateway: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to gateway
$gatewayCreateItem = ; // GatewayCreateItem | JsonApi with the Gateway object to add

try {
    $result = $api_instance->addGateway($processId, $gatewayCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addGateway: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Body parameters
Name Description
gatewayCreateItem *

Responses

Status: 201 - Created Gateway response

Status: 400 - Invalid parameters

Status: 404 - Not found item

Status: 500 - Internal server error

Status: 0 - unexpected error


addGroup

This method is intended for creating a new group.


/groups

Usage and SDK Samples


curl -X post "http://localhost/api/v1/groups"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        GroupCreateItem groupCreateItem = ; // GroupCreateItem | JsonApi with the Group object to add
        try {
            GroupItem result = apiInstance.addGroup(groupCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addGroup");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        GroupCreateItem groupCreateItem = ; // GroupCreateItem | JsonApi with the Group object to add
        try {
            GroupItem result = apiInstance.addGroup(groupCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addGroup");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


GroupCreateItem *groupCreateItem = ; // JsonApi with the Group object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addGroupWith:groupCreateItem
              completionHandler: ^(GroupItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var groupCreateItem = ; // {GroupCreateItem} JsonApi with the Group object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var groupCreateItem = new GroupCreateItem(); // GroupCreateItem | JsonApi with the Group object to add

            try
            {
                GroupItem result = apiInstance.addGroup(groupCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addGroup: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$groupCreateItem = ; // GroupCreateItem | JsonApi with the Group object to add

try {
    $result = $api_instance->addGroup($groupCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addGroup: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
groupCreateItem *

Responses

Status: 200 - Created Group response

Status: 400 - Invalid parameters

Status: 0 - unexpected error


addGroupsToTask

This method is intended for assignment group(s) to the choosen task


/processes/{process_id}/tasks/{task_id}/groups

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/groups"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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
        String taskId = taskId_example; // String | ID of Task to modify
        TaskAddGroupsItem taskAddGroupsItem = ; // TaskAddGroupsItem | JsonApi with Groups ids to add
        try {
            ResultSuccess result = apiInstance.addGroupsToTask(processId, taskId, taskAddGroupsItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addGroupsToTask");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process
        String taskId = taskId_example; // String | ID of Task to modify
        TaskAddGroupsItem taskAddGroupsItem = ; // TaskAddGroupsItem | JsonApi with Groups ids to add
        try {
            ResultSuccess result = apiInstance.addGroupsToTask(processId, taskId, taskAddGroupsItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addGroupsToTask");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process
String *taskId = taskId_example; // ID of Task to modify
TaskAddGroupsItem *taskAddGroupsItem = ; // JsonApi with Groups ids to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addGroupsToTaskWith:processId
    taskId:taskId
    taskAddGroupsItem:taskAddGroupsItem
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process

var taskId = taskId_example; // {String} ID of Task to modify

var taskAddGroupsItem = ; // {TaskAddGroupsItem} JsonApi with Groups ids to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addGroupsToTaskExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process
            var taskId = taskId_example;  // String | ID of Task to modify
            var taskAddGroupsItem = new TaskAddGroupsItem(); // TaskAddGroupsItem | JsonApi with Groups ids to add

            try
            {
                ResultSuccess result = apiInstance.addGroupsToTask(processId, taskId, taskAddGroupsItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addGroupsToTask: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process
$taskId = taskId_example; // String | ID of Task to modify
$taskAddGroupsItem = ; // TaskAddGroupsItem | JsonApi with Groups ids to add

try {
    $result = $api_instance->addGroupsToTask($processId, $taskId, $taskAddGroupsItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addGroupsToTask: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
Body parameters
Name Description
taskAddGroupsItem *

Responses

Status: 200 - Group(s) was assigned to the task

Status: 404 - Group(s) not found

Status: 422 - Un-processable entity

Status: 500 - Unkwown error is appera due adding Group(s) to the task

Status: 0 - unexpected error


addInputOutput

This method is intended for creating a new InputOutput


/processes/{process_id}/tasks/{task_id}/inputoutput

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/inputoutput"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        InputOutputCreateItem inputOutputCreateItem = ; // InputOutputCreateItem | Create and add a new InputOutput object with JSON API
        try {
            InputOutputItem result = apiInstance.addInputOutput(processId, taskId, inputOutputCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addInputOutput");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        InputOutputCreateItem inputOutputCreateItem = ; // InputOutputCreateItem | Create and add a new InputOutput object with JSON API
        try {
            InputOutputItem result = apiInstance.addInputOutput(processId, taskId, inputOutputCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addInputOutput");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID related to InputOutput object
String *taskId = taskId_example; // Task instance ID related to InputOutput object
InputOutputCreateItem *inputOutputCreateItem = ; // Create and add a new InputOutput object with JSON API

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addInputOutputWith:processId
    taskId:taskId
    inputOutputCreateItem:inputOutputCreateItem
              completionHandler: ^(InputOutputItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID related to InputOutput object

var taskId = taskId_example; // {String} Task instance ID related to InputOutput object

var inputOutputCreateItem = ; // {InputOutputCreateItem} Create and add a new InputOutput object with JSON API


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addInputOutputExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID related to InputOutput object
            var taskId = taskId_example;  // String | Task instance ID related to InputOutput object
            var inputOutputCreateItem = new InputOutputCreateItem(); // InputOutputCreateItem | Create and add a new InputOutput object with JSON API

            try
            {
                InputOutputItem result = apiInstance.addInputOutput(processId, taskId, inputOutputCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addInputOutput: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID related to InputOutput object
$taskId = taskId_example; // String | Task instance ID related to InputOutput object
$inputOutputCreateItem = ; // InputOutputCreateItem | Create and add a new InputOutput object with JSON API

try {
    $result = $api_instance->addInputOutput($processId, $taskId, $inputOutputCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addInputOutput: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
Body parameters
Name Description
inputOutputCreateItem *

Responses

Status: 201 - The request has been fulfilled and InputOutput object being created

Status: 400 - Invalid parameters

Status: 500 - Internal server error

Status: 0 - unexpected error


addInstance

This method is intended for creating a new instance.


/processes/{process_id}/instances

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/instances"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID relative to instance
        InstanceCreateItem instanceCreateItem = ; // InstanceCreateItem | JsonApi with the Instance object to add
        try {
            InstanceItem result = apiInstance.addInstance(processId, instanceCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addInstance");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID relative to instance
        InstanceCreateItem instanceCreateItem = ; // InstanceCreateItem | JsonApi with the Instance object to add
        try {
            InstanceItem result = apiInstance.addInstance(processId, instanceCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addInstance");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID relative to instance
InstanceCreateItem *instanceCreateItem = ; // JsonApi with the Instance object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addInstanceWith:processId
    instanceCreateItem:instanceCreateItem
              completionHandler: ^(InstanceItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID relative to instance

var instanceCreateItem = ; // {InstanceCreateItem} JsonApi with the Instance object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addInstanceExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID relative to instance
            var instanceCreateItem = new InstanceCreateItem(); // InstanceCreateItem | JsonApi with the Instance object to add

            try
            {
                InstanceItem result = apiInstance.addInstance(processId, instanceCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addInstance: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID relative to instance
$instanceCreateItem = ; // InstanceCreateItem | JsonApi with the Instance object to add

try {
    $result = $api_instance->addInstance($processId, $instanceCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addInstance: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Body parameters
Name Description
instanceCreateItem *

Responses

Status: 201 - Instance response was created succesfully

Status: 400 - Invalid parameters

Status: 404 - Not found item

Status: 500 - Internal server error

Status: 0 - Unexpected error


addProcess

This method is responsible for creating a new process


/processes

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        ProcessCreateItem processCreateItem = ; // ProcessCreateItem | JsonApi with the Process object to add
        try {
            ProcessItem result = apiInstance.addProcess(processCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addProcess");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        ProcessCreateItem processCreateItem = ; // ProcessCreateItem | JsonApi with the Process object to add
        try {
            ProcessItem result = apiInstance.addProcess(processCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addProcess");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


ProcessCreateItem *processCreateItem = ; // JsonApi with the Process object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addProcessWith:processCreateItem
              completionHandler: ^(ProcessItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processCreateItem = ; // {ProcessCreateItem} JsonApi with the Process object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addProcessExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processCreateItem = new ProcessCreateItem(); // ProcessCreateItem | JsonApi with the Process object to add

            try
            {
                ProcessItem result = apiInstance.addProcess(processCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addProcess: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processCreateItem = ; // ProcessCreateItem | JsonApi with the Process object to add

try {
    $result = $api_instance->addProcess($processCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addProcess: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
processCreateItem *

Responses

Status: 201 - New process was created

Status: 400 - Invalid parameters

Status: 500 - Internal server error

Status: 0 - unexpected error


addTask

This method is intended for creating a new task.


/processes/{process_id}/tasks

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/tasks"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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
        TaskCreateItem taskCreateItem = ; // TaskCreateItem | JsonApi with the Task object to add
        try {
            TaskItem result = apiInstance.addTask(processId, taskCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addTask");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to task
        TaskCreateItem taskCreateItem = ; // TaskCreateItem | JsonApi with the Task object to add
        try {
            TaskItem result = apiInstance.addTask(processId, taskCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addTask");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to task
TaskCreateItem *taskCreateItem = ; // JsonApi with the Task object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addTaskWith:processId
    taskCreateItem:taskCreateItem
              completionHandler: ^(TaskItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to task

var taskCreateItem = ; // {TaskCreateItem} JsonApi with the Task object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addTaskExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to task
            var taskCreateItem = new TaskCreateItem(); // TaskCreateItem | JsonApi with the Task object to add

            try
            {
                TaskItem result = apiInstance.addTask(processId, taskCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addTask: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to task
$taskCreateItem = ; // TaskCreateItem | JsonApi with the Task object to add

try {
    $result = $api_instance->addTask($processId, $taskCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addTask: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Body parameters
Name Description
taskCreateItem *

Responses

Status: 201 - Created Task response

Status: 400 - Invalid parameters

Status: 404 - Not item

Status: 500 - Internal server error

Status: 0 - unexpected error


addUser

This method is intended for creating a new user in the system.


/users

Usage and SDK Samples


curl -X post "http://localhost/api/v1/users"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        UserCreateItem userCreateItem = ; // UserCreateItem | JsonApi with the User object to add
        try {
            UserItem result = apiInstance.addUser(userCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addUser");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        UserCreateItem userCreateItem = ; // UserCreateItem | JsonApi with the User object to add
        try {
            UserItem result = apiInstance.addUser(userCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addUser");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


UserCreateItem *userCreateItem = ; // JsonApi with the User object to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addUserWith:userCreateItem
              completionHandler: ^(UserItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var userCreateItem = ; // {UserCreateItem} JsonApi with the User object to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var userCreateItem = new UserCreateItem(); // UserCreateItem | JsonApi with the User object to add

            try
            {
                UserItem result = apiInstance.addUser(userCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addUser: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$userCreateItem = ; // UserCreateItem | JsonApi with the User object to add

try {
    $result = $api_instance->addUser($userCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addUser: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
userCreateItem *

Responses

Status: 200 - New User was created

Status: 400 - Invalid parameters

Status: 0 - unexpected error


addUsersToGroup

This method is intended for adding one, or more new users to a group.


/groups/{id}/users

Usage and SDK Samples


curl -X put "http://localhost/api/v1/groups/{id}/users"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Group to modify
        GroupAddUsersItem groupAddUsersItem = ; // GroupAddUsersItem | JsonApi with Users ids to add
        try {
            ResultSuccess result = apiInstance.addUsersToGroup(id, groupAddUsersItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addUsersToGroup");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Group to modify
        GroupAddUsersItem groupAddUsersItem = ; // GroupAddUsersItem | JsonApi with Users ids to add
        try {
            ResultSuccess result = apiInstance.addUsersToGroup(id, groupAddUsersItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#addUsersToGroup");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Group to modify
GroupAddUsersItem *groupAddUsersItem = ; // JsonApi with Users ids to add

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance addUsersToGroupWith:id
    groupAddUsersItem:groupAddUsersItem
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Group to modify

var groupAddUsersItem = ; // {GroupAddUsersItem} JsonApi with Users ids to add


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addUsersToGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Group to modify
            var groupAddUsersItem = new GroupAddUsersItem(); // GroupAddUsersItem | JsonApi with Users ids to add

            try
            {
                ResultSuccess result = apiInstance.addUsersToGroup(id, groupAddUsersItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.addUsersToGroup: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Group to modify
$groupAddUsersItem = ; // GroupAddUsersItem | JsonApi with Users ids to add

try {
    $result = $api_instance->addUsersToGroup($id, $groupAddUsersItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->addUsersToGroup: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
groupAddUsersItem *

Responses

Status: 200 - JsonApi response with result details

Status: 422 - Un-processable entity

Status: 500 - Error adding Group(s)

Status: 0 - unexpected error


deleteClient

This method is intended for deleting a single item based on the Client and User IDs.


/users/{user_id}/clients/{client_id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/users/{user_id}/clients/{client_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 userId = userId_example; // String | ID of of User item
        String clientId = clientId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteClient(userId, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteClient");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String userId = userId_example; // String | ID of of User item
        String clientId = clientId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteClient(userId, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteClient");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *userId = userId_example; // ID of of User item
String *clientId = clientId_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteClientWith:userId
    clientId:clientId
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var userId = userId_example; // {String} ID of of User item

var clientId = clientId_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteClientExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var userId = userId_example;  // String | ID of of User item
            var clientId = clientId_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteClient(userId, clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteClient: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$userId = userId_example; // String | ID of of User item
$clientId = clientId_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteClient($userId, $clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteClient: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
userId*
clientId*

Responses

Status: 200 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteEvent

This method is intended for deleting a single item based on event_id and Process ID.


/processes/{process_id}/events/{event_id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/events/{event_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 of Process item
        String eventId = eventId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteEvent(processId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteEvent");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of of Process item
        String eventId = eventId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteEvent(processId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteEvent");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of of Process item
String *eventId = eventId_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteEventWith:processId
    eventId:eventId
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of of Process item

var eventId = eventId_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteEventExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of of Process item
            var eventId = eventId_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteEvent(processId, eventId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteEvent: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of of Process item
$eventId = eventId_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteEvent($processId, $eventId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteEvent: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
eventId*

Responses

Status: 200 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteFlow

This method is intended for deleting a single item based on the flow_id and Process ID.


/processes/{process_id}/flows/{flow_id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/flows/{flow_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 of Process item
        String flowId = flowId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteFlow(processId, flowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteFlow");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of of Process item
        String flowId = flowId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteFlow(processId, flowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteFlow");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of of Process item
String *flowId = flowId_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteFlowWith:processId
    flowId:flowId
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of of Process item

var flowId = flowId_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteFlowExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of of Process item
            var flowId = flowId_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteFlow(processId, flowId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteFlow: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of of Process item
$flowId = flowId_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteFlow($processId, $flowId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteFlow: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
flowId*

Responses

Status: 200 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteGateway

This method is intended for deleting a single item based on the gateway_id and Process ID.


/processes/{process_id}/gateways/{gateway_id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/gateways/{gateway_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 of Process item
        String gatewayId = gatewayId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteGateway(processId, gatewayId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteGateway");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of of Process item
        String gatewayId = gatewayId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteGateway(processId, gatewayId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteGateway");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of of Process item
String *gatewayId = gatewayId_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteGatewayWith:processId
    gatewayId:gatewayId
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of of Process item

var gatewayId = gatewayId_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteGatewayExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of of Process item
            var gatewayId = gatewayId_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteGateway(processId, gatewayId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteGateway: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of of Process item
$gatewayId = gatewayId_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteGateway($processId, $gatewayId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteGateway: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
gatewayId*

Responses

Status: 200 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteGroup

This method is intended for deleting a single item based on the item’s ID.


/groups/{id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/groups/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteGroup");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteGroup");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteGroupWith:id
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteGroup(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteGroup: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteGroup($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*

Responses

Status: 204 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteInputOutput

This method is intended for deleting a single item based on the InputOutput ID, Process ID and Task ID


/processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        String inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
        try {
            ResultSuccess result = apiInstance.deleteInputOutput(processId, taskId, inputoutputUid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteInputOutput");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        String inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
        try {
            ResultSuccess result = apiInstance.deleteInputOutput(processId, taskId, inputoutputUid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteInputOutput");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID related to InputOutput object
String *taskId = taskId_example; // Task instance ID related to InputOutput object
String *inputoutputUid = inputoutputUid_example; // ID of InputOutput to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteInputOutputWith:processId
    taskId:taskId
    inputoutputUid:inputoutputUid
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID related to InputOutput object

var taskId = taskId_example; // {String} Task instance ID related to InputOutput object

var inputoutputUid = inputoutputUid_example; // {String} ID of InputOutput to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteInputOutputExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID related to InputOutput object
            var taskId = taskId_example;  // String | Task instance ID related to InputOutput object
            var inputoutputUid = inputoutputUid_example;  // String | ID of InputOutput to fetch

            try
            {
                ResultSuccess result = apiInstance.deleteInputOutput(processId, taskId, inputoutputUid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteInputOutput: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID related to InputOutput object
$taskId = taskId_example; // String | Task instance ID related to InputOutput object
$inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch

try {
    $result = $api_instance->deleteInputOutput($processId, $taskId, $inputoutputUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteInputOutput: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
inputoutputUid*

Responses

Status: 200 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteInstance

This method is intended for deleting a single item based on the instance ID and Process ID.


/processes/{process_id}/instances/{instance_id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/instances/{instance_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 of Process item
        String instanceId = instanceId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteInstance(processId, instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteInstance");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of of Process item
        String instanceId = instanceId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteInstance(processId, instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteInstance");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of of Process item
String *instanceId = instanceId_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteInstanceWith:processId
    instanceId:instanceId
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of of Process item

var instanceId = instanceId_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteInstanceExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of of Process item
            var instanceId = instanceId_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteInstance(processId, instanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteInstance: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of of Process item
$instanceId = instanceId_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteInstance($processId, $instanceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteInstance: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
instanceId*

Responses

Status: 200 - Instance was successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteProcess

This method is intended for deleting a single item based on the item’s ID.


/processes/{id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteProcess(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteProcess");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteProcess(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteProcess");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteProcessWith:id
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteProcessExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteProcess(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteProcess: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteProcess($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteProcess: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*

Responses

Status: 200 - Item successfully deleted

Status: 401 - Unauthorized access

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteTask

This method is intended for deleting a single item based on task_id and Process ID.


/processes/{process_id}/tasks/{task_id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 of Process item
        String taskId = taskId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteTask(processId, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteTask");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of of Process item
        String taskId = taskId_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteTask(processId, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteTask");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of of Process item
String *taskId = taskId_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteTaskWith:processId
    taskId:taskId
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of of Process item

var taskId = taskId_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteTaskExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of of Process item
            var taskId = taskId_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteTask(processId, taskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteTask: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of of Process item
$taskId = taskId_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteTask($processId, $taskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteTask: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*

Responses

Status: 200 - Item successfully deleted

Status: 404 - Item not found

Status: 500 - Deletion error

Status: 0 - Unexpected error


deleteUser

This method deletes User from the system.


/users/{id}

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/users/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteUser");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of item to delete
        try {
            ResultSuccess result = apiInstance.deleteUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#deleteUser");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of item to delete

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance deleteUserWith:id
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of item to delete


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of item to delete

            try
            {
                ResultSuccess result = apiInstance.deleteUser(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.deleteUser: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of item to delete

try {
    $result = $api_instance->deleteUser($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*

Responses

Status: 204 - User was successfully deleted

Status: 404 - User not found

Status: 500 - The server encountered an unexpected condition due delete response

Status: 0 - Unexpected error


eventTrigger

This method is intended for creating an event.


/processes/{process_id}/events/{event_id}/trigger

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/events/{event_id}/trigger"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 event
        String eventId = eventId_example; // String | ID of Event to trigger
        TriggerEventCreateItem triggerEventCreateItem = ; // TriggerEventCreateItem | Json with some parameters
        try {
            DataModelItem_1 result = apiInstance.eventTrigger(processId, eventId, triggerEventCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#eventTrigger");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to event
        String eventId = eventId_example; // String | ID of Event to trigger
        TriggerEventCreateItem triggerEventCreateItem = ; // TriggerEventCreateItem | Json with some parameters
        try {
            DataModelItem_1 result = apiInstance.eventTrigger(processId, eventId, triggerEventCreateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#eventTrigger");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to event
String *eventId = eventId_example; // ID of Event to trigger
TriggerEventCreateItem *triggerEventCreateItem = ; // Json with some parameters

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance eventTriggerWith:processId
    eventId:eventId
    triggerEventCreateItem:triggerEventCreateItem
              completionHandler: ^(DataModelItem_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to event

var eventId = eventId_example; // {String} ID of Event to trigger

var triggerEventCreateItem = ; // {TriggerEventCreateItem} Json with some parameters


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class eventTriggerExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to event
            var eventId = eventId_example;  // String | ID of Event to trigger
            var triggerEventCreateItem = new TriggerEventCreateItem(); // TriggerEventCreateItem | Json with some parameters

            try
            {
                DataModelItem_1 result = apiInstance.eventTrigger(processId, eventId, triggerEventCreateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.eventTrigger: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to event
$eventId = eventId_example; // String | ID of Event to trigger
$triggerEventCreateItem = ; // TriggerEventCreateItem | Json with some parameters

try {
    $result = $api_instance->eventTrigger($processId, $eventId, $triggerEventCreateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->eventTrigger: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
eventId*
Body parameters
Name Description
triggerEventCreateItem *

Responses

Status: 201 - Trigger Event and response with DataModel item

Status: 404 - Not found item

Status: 500 - Internal server error

Status: 0 - unexpected error


findClientById

This method is intended for retrieving a client based on ID.


/users/{user_id}/clients/{client_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/users/{user_id}/clients/{client_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 userId = userId_example; // String | ID of User to fetch
        String clientId = clientId_example; // String | ID of Client to fetch
        try {
            ClientItem result = apiInstance.findClientById(userId, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findClientById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String userId = userId_example; // String | ID of User to fetch
        String clientId = clientId_example; // String | ID of Client to fetch
        try {
            ClientItem result = apiInstance.findClientById(userId, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findClientById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *userId = userId_example; // ID of User to fetch
String *clientId = clientId_example; // ID of Client to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findClientByIdWith:userId
    clientId:clientId
              completionHandler: ^(ClientItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var userId = userId_example; // {String} ID of User to fetch

var clientId = clientId_example; // {String} ID of Client to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findClientByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var userId = userId_example;  // String | ID of User to fetch
            var clientId = clientId_example;  // String | ID of Client to fetch

            try
            {
                ClientItem result = apiInstance.findClientById(userId, clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findClientById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$userId = userId_example; // String | ID of User to fetch
$clientId = clientId_example; // String | ID of Client to fetch

try {
    $result = $api_instance->findClientById($userId, $clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findClientById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
userId*
clientId*

Responses

Status: 200 - Client Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findClients

This method is intended for retrieving all existing clients of user.


/users/{user_id}/clients

Usage and SDK Samples


curl -X get "http://localhost/api/v1/users/{user_id}/clients?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 userId = userId_example; // String | ID of User relative to clients
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            ClientCollection result = apiInstance.findClients(userId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findClients");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String userId = userId_example; // String | ID of User relative to clients
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            ClientCollection result = apiInstance.findClients(userId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findClients");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *userId = userId_example; // ID of User relative to clients
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findClientsWith:userId
    page:page
    perPage:perPage
              completionHandler: ^(ClientCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var userId = userId_example; // {String} ID of User relative to clients

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findClientsExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var userId = userId_example;  // String | ID of User relative to clients
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                ClientCollection result = apiInstance.findClients(userId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findClients: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$userId = userId_example; // String | ID of User relative to clients
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findClients($userId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findClients: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
userId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - Clients list is ready to use

Status: 0 - Unexpected error


findDataModel

This method returns the instance DataModel and lets work with it directly


/processes/{process_id}/instances/{instance_id}/datamodel

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/instances/{instance_id}/datamodel?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String instanceId = instanceId_example; // String | ID of Instance to fetch
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            DataModelItem_1 result = apiInstance.findDataModel(processId, instanceId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findDataModel");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String instanceId = instanceId_example; // String | ID of Instance to fetch
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            DataModelItem_1 result = apiInstance.findDataModel(processId, instanceId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findDataModel");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *instanceId = instanceId_example; // ID of Instance to fetch
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findDataModelWith:processId
    instanceId:instanceId
    page:page
    perPage:perPage
              completionHandler: ^(DataModelItem_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var instanceId = instanceId_example; // {String} ID of Instance to fetch

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findDataModelExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var instanceId = instanceId_example;  // String | ID of Instance to fetch
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                DataModelItem_1 result = apiInstance.findDataModel(processId, instanceId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findDataModel: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$instanceId = instanceId_example; // String | ID of Instance to fetch
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findDataModel($processId, $instanceId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findDataModel: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
instanceId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - DataModel Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findEventById

This method is intended for retrieving an event based on it’s ID.


/processes/{process_id}/events/{event_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/events/{event_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String eventId = eventId_example; // String | ID of Event to fetch
        try {
            EventItem result = apiInstance.findEventById(processId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findEventById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String eventId = eventId_example; // String | ID of Event to fetch
        try {
            EventItem result = apiInstance.findEventById(processId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findEventById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *eventId = eventId_example; // ID of Event to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findEventByIdWith:processId
    eventId:eventId
              completionHandler: ^(EventItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var eventId = eventId_example; // {String} ID of Event to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findEventByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var eventId = eventId_example;  // String | ID of Event to fetch

            try
            {
                EventItem result = apiInstance.findEventById(processId, eventId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findEventById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$eventId = eventId_example; // String | ID of Event to fetch

try {
    $result = $api_instance->findEventById($processId, $eventId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findEventById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
eventId*

Responses

Status: 200 - Event Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findEvents

This method returns all events related to the runned process


/processes/{process_id}/events

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/events?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 event
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            EventCollection result = apiInstance.findEvents(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findEvents");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to event
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            EventCollection result = apiInstance.findEvents(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findEvents");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to event
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findEventsWith:processId
    page:page
    perPage:perPage
              completionHandler: ^(EventCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to event

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findEventsExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to event
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                EventCollection result = apiInstance.findEvents(processId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findEvents: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to event
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findEvents($processId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findEvents: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - Events list

Status: 0 - Unexpected error


findFlowById

This method is intended for retrieving a flow based on it’s ID.


/processes/{process_id}/flows/{flow_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/flows/{flow_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String flowId = flowId_example; // String | ID of Flow to fetch
        try {
            FlowItem result = apiInstance.findFlowById(processId, flowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findFlowById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String flowId = flowId_example; // String | ID of Flow to fetch
        try {
            FlowItem result = apiInstance.findFlowById(processId, flowId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findFlowById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *flowId = flowId_example; // ID of Flow to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findFlowByIdWith:processId
    flowId:flowId
              completionHandler: ^(FlowItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var flowId = flowId_example; // {String} ID of Flow to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findFlowByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var flowId = flowId_example;  // String | ID of Flow to fetch

            try
            {
                FlowItem result = apiInstance.findFlowById(processId, flowId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findFlowById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$flowId = flowId_example; // String | ID of Flow to fetch

try {
    $result = $api_instance->findFlowById($processId, $flowId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findFlowById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
flowId*

Responses

Status: 200 - Flow Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findFlows

This method is intended for retrieving all existing flows.


/processes/{process_id}/flows

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/flows?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 flow
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            FlowCollection result = apiInstance.findFlows(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findFlows");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to flow
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            FlowCollection result = apiInstance.findFlows(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findFlows");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to flow
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findFlowsWith:processId
    page:page
    perPage:perPage
              completionHandler: ^(FlowCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to flow

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findFlowsExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to flow
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                FlowCollection result = apiInstance.findFlows(processId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findFlows: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to flow
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findFlows($processId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findFlows: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - Flows list is ready to use

Status: 0 - Unexpected error


findGatewayById

This method is intended for retrieving a gateway based on it’s ID.


/processes/{process_id}/gateways/{gateway_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/gateways/{gateway_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String gatewayId = gatewayId_example; // String | ID of Gateway to fetch
        try {
            GatewayItem result = apiInstance.findGatewayById(processId, gatewayId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGatewayById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String gatewayId = gatewayId_example; // String | ID of Gateway to fetch
        try {
            GatewayItem result = apiInstance.findGatewayById(processId, gatewayId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGatewayById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *gatewayId = gatewayId_example; // ID of Gateway to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findGatewayByIdWith:processId
    gatewayId:gatewayId
              completionHandler: ^(GatewayItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var gatewayId = gatewayId_example; // {String} ID of Gateway to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findGatewayByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var gatewayId = gatewayId_example;  // String | ID of Gateway to fetch

            try
            {
                GatewayItem result = apiInstance.findGatewayById(processId, gatewayId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findGatewayById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$gatewayId = gatewayId_example; // String | ID of Gateway to fetch

try {
    $result = $api_instance->findGatewayById($processId, $gatewayId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findGatewayById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
gatewayId*

Responses

Status: 200 - Gateway Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findGateways

This method is intending for retrieving all existing gateways.


/processes/{process_id}/gateways

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/gateways?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 gateway
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            GatewayCollection result = apiInstance.findGateways(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGateways");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to gateway
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            GatewayCollection result = apiInstance.findGateways(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGateways");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to gateway
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findGatewaysWith:processId
    page:page
    perPage:perPage
              completionHandler: ^(GatewayCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to gateway

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findGatewaysExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to gateway
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                GatewayCollection result = apiInstance.findGateways(processId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findGateways: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to gateway
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findGateways($processId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findGateways: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - Gateways list

Status: 0 - Unexpected error


findGroupById

This method is responsible for retrieving a group based on a single ID.


/groups/{id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/groups/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Group to fetch
        try {
            GroupItem result = apiInstance.findGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGroupById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Group to fetch
        try {
            GroupItem result = apiInstance.findGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGroupById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Group to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findGroupByIdWith:id
              completionHandler: ^(GroupItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Group to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findGroupByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Group to fetch

            try
            {
                GroupItem result = apiInstance.findGroupById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findGroupById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Group to fetch

try {
    $result = $api_instance->findGroupById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findGroupById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*

Responses

Status: 200 - Group Item response

Status: 404 - Group not found

Status: 0 - Unexpected error


findGroups

This method is responsible for retrieving all existing groups.


/groups

Usage and SDK Samples


curl -X get "http://localhost/api/v1/groups?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            GroupCollection result = apiInstance.findGroups(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGroups");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            GroupCollection result = apiInstance.findGroups(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findGroups");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findGroupsWith:page
    perPage:perPage
              completionHandler: ^(GroupCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findGroupsExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                GroupCollection result = apiInstance.findGroups(page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findGroups: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findGroups($page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findGroups: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
page
perPage

Responses

Status: 200 - Groups list

Status: 0 - Unexpected error


findInputOutputById

This method is intended for retrieving an InputOutput object based on ID.


/processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        String inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
        try {
            InputOutputItem result = apiInstance.findInputOutputById(processId, taskId, inputoutputUid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInputOutputById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        String inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
        try {
            InputOutputItem result = apiInstance.findInputOutputById(processId, taskId, inputoutputUid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInputOutputById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID related to InputOutput object
String *taskId = taskId_example; // Task instance ID related to InputOutput object
String *inputoutputUid = inputoutputUid_example; // ID of InputOutput to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findInputOutputByIdWith:processId
    taskId:taskId
    inputoutputUid:inputoutputUid
              completionHandler: ^(InputOutputItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID related to InputOutput object

var taskId = taskId_example; // {String} Task instance ID related to InputOutput object

var inputoutputUid = inputoutputUid_example; // {String} ID of InputOutput to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findInputOutputByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID related to InputOutput object
            var taskId = taskId_example;  // String | Task instance ID related to InputOutput object
            var inputoutputUid = inputoutputUid_example;  // String | ID of InputOutput to fetch

            try
            {
                InputOutputItem result = apiInstance.findInputOutputById(processId, taskId, inputoutputUid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findInputOutputById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID related to InputOutput object
$taskId = taskId_example; // String | Task instance ID related to InputOutput object
$inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch

try {
    $result = $api_instance->findInputOutputById($processId, $taskId, $inputoutputUid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findInputOutputById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
inputoutputUid*

Responses

Status: 200 - InputOutput Item response was completed

Status: 404 - Item not found

Status: 0 - Unexpected error


findInputOutputs

This method is intended for retrieving all existing InputOutput objects for the related task instance.


/processes/{process_id}/tasks/{task_id}/inputoutput

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/inputoutput?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            InputOutputCollection result = apiInstance.findInputOutputs(processId, taskId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInputOutputs");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            InputOutputCollection result = apiInstance.findInputOutputs(processId, taskId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInputOutputs");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID related to InputOutput object
String *taskId = taskId_example; // Task instance ID related to InputOutput object
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findInputOutputsWith:processId
    taskId:taskId
    page:page
    perPage:perPage
              completionHandler: ^(InputOutputCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID related to InputOutput object

var taskId = taskId_example; // {String} Task instance ID related to InputOutput object

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findInputOutputsExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID related to InputOutput object
            var taskId = taskId_example;  // String | Task instance ID related to InputOutput object
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                InputOutputCollection result = apiInstance.findInputOutputs(processId, taskId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findInputOutputs: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID related to InputOutput object
$taskId = taskId_example; // String | Task instance ID related to InputOutput object
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findInputOutputs($processId, $taskId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findInputOutputs: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - InputOutputs list is ready to use

Status: 0 - Unexpected error


findInstanceById

This method is responsible for retrieving an instance based on it’s ID.


/processes/{process_id}/instances/{instance_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/instances/{instance_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String instanceId = instanceId_example; // String | ID of Instance to fetch
        try {
            InstanceItem result = apiInstance.findInstanceById(processId, instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInstanceById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String instanceId = instanceId_example; // String | ID of Instance to fetch
        try {
            InstanceItem result = apiInstance.findInstanceById(processId, instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInstanceById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *instanceId = instanceId_example; // ID of Instance to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findInstanceByIdWith:processId
    instanceId:instanceId
              completionHandler: ^(InstanceItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var instanceId = instanceId_example; // {String} ID of Instance to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findInstanceByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var instanceId = instanceId_example;  // String | ID of Instance to fetch

            try
            {
                InstanceItem result = apiInstance.findInstanceById(processId, instanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findInstanceById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$instanceId = instanceId_example; // String | ID of Instance to fetch

try {
    $result = $api_instance->findInstanceById($processId, $instanceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findInstanceById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
instanceId*

Responses

Status: 200 - Instance Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findInstances

This method is responsible for retrieving all Instances related to the Process via Process ID


/processes/{process_id}/instances

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/instances?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID relative to instance
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            InstanceCollection result = apiInstance.findInstances(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInstances");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID relative to instance
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            InstanceCollection result = apiInstance.findInstances(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findInstances");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID relative to instance
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findInstancesWith:processId
    page:page
    perPage:perPage
              completionHandler: ^(InstanceCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID relative to instance

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findInstancesExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID relative to instance
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                InstanceCollection result = apiInstance.findInstances(processId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findInstances: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID relative to instance
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findInstances($processId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findInstances: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - The request has been fulfilled and Instances list is ready to use

Status: 0 - Unexpected error


findProcessById

Returns the process based on a single ID


/processes/{id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Process to fetch
        try {
            ProcessItem result = apiInstance.findProcessById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findProcessById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Process to fetch
        try {
            ProcessItem result = apiInstance.findProcessById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findProcessById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Process to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findProcessByIdWith:id
              completionHandler: ^(ProcessItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Process to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findProcessByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Process to fetch

            try
            {
                ProcessItem result = apiInstance.findProcessById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findProcessById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Process to fetch

try {
    $result = $api_instance->findProcessById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findProcessById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*

Responses

Status: 200 - Process Item response

Status: 404 - Process not found

Status: 0 - Unexpected error


findProcesses

This method is responsible for retrieving all existing processes.


/processes

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            ProcessCollection result = apiInstance.findProcesses(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findProcesses");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            ProcessCollection result = apiInstance.findProcesses(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findProcesses");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findProcessesWith:page
    perPage:perPage
              completionHandler: ^(ProcessCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findProcessesExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                ProcessCollection result = apiInstance.findProcesses(page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findProcesses: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findProcesses($page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findProcesses: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
page
perPage

Responses

Status: 200 - Processes list

Status: 401 - Unauthorized access

Status: 403 - Forbidden access

Status: 0 - Unexpected error


findTaskById

This method is responsible for retrieving a task based on it’s ID.


/processes/{process_id}/tasks/{task_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String taskId = taskId_example; // String | ID of Task to fetch
        try {
            TaskItem result = apiInstance.findTaskById(processId, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTaskById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String taskId = taskId_example; // String | ID of Task to fetch
        try {
            TaskItem result = apiInstance.findTaskById(processId, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTaskById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *taskId = taskId_example; // ID of Task to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findTaskByIdWith:processId
    taskId:taskId
              completionHandler: ^(TaskItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var taskId = taskId_example; // {String} ID of Task to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findTaskByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var taskId = taskId_example;  // String | ID of Task to fetch

            try
            {
                TaskItem result = apiInstance.findTaskById(processId, taskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findTaskById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$taskId = taskId_example; // String | ID of Task to fetch

try {
    $result = $api_instance->findTaskById($processId, $taskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findTaskById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*

Responses

Status: 200 - Task Item response

Status: 404 - Task not found

Status: 0 - Unexpected error


findTaskInstanceById

This method is responsible for retrieving TaskInstance based on it’s ID.


/task_instances/{task_instance_id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/task_instances/{task_instance_id}?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 taskInstanceId = taskInstanceId_example; // String | ID of TaskInstance to fetch
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            inline_response_200 result = apiInstance.findTaskInstanceById(taskInstanceId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTaskInstanceById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String taskInstanceId = taskInstanceId_example; // String | ID of TaskInstance to fetch
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            inline_response_200 result = apiInstance.findTaskInstanceById(taskInstanceId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTaskInstanceById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *taskInstanceId = taskInstanceId_example; // ID of TaskInstance to fetch
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findTaskInstanceByIdWith:taskInstanceId
    page:page
    perPage:perPage
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var taskInstanceId = taskInstanceId_example; // {String} ID of TaskInstance to fetch

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findTaskInstanceByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var taskInstanceId = taskInstanceId_example;  // String | ID of TaskInstance to fetch
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                inline_response_200 result = apiInstance.findTaskInstanceById(taskInstanceId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findTaskInstanceById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$taskInstanceId = taskInstanceId_example; // String | ID of TaskInstance to fetch
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findTaskInstanceById($taskInstanceId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findTaskInstanceById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
taskInstanceId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - TaskInstance Item response

Status: 404 - Item not found

Status: 0 - Unexpected error


findTaskInstances

This method is responsible for retrieving and finding tasks instances related to the task


/task_instances

Usage and SDK Samples


curl -X get "http://localhost/api/v1/task_instances?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            TaskInstanceCollection result = apiInstance.findTaskInstances(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTaskInstances");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            TaskInstanceCollection result = apiInstance.findTaskInstances(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTaskInstances");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findTaskInstancesWith:page
    perPage:perPage
              completionHandler: ^(TaskInstanceCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findTaskInstancesExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                TaskInstanceCollection result = apiInstance.findTaskInstances(page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findTaskInstances: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findTaskInstances($page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findTaskInstances: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
page
perPage

Responses

Status: 200 - TaskInstances list

Status: 0 - Unexpected error


findTasks

This method is intended for returning a list of all Tasks related to the process


/processes/{process_id}/tasks

Usage and SDK Samples


curl -X get "http://localhost/api/v1/processes/{process_id}/tasks?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            TaskCollection result = apiInstance.findTasks(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTasks");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process relative to task
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            TaskCollection result = apiInstance.findTasks(processId, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findTasks");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process relative to task
Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findTasksWith:processId
    page:page
    perPage:perPage
              completionHandler: ^(TaskCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process relative to task

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findTasksExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process relative to task
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                TaskCollection result = apiInstance.findTasks(processId, page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findTasks: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process relative to task
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findTasks($processId, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findTasks: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
Query parameters
Name Description
page
perPage

Responses

Status: 200 - Tasks list

Status: 0 - Unexpected error


findUserById

This method is responsible for returning a user based on their ID.


/users/{id}

Usage and SDK Samples


curl -X get "http://localhost/api/v1/users/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of User to fetch
        try {
            UserItem result = apiInstance.findUserById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findUserById");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of User to fetch
        try {
            UserItem result = apiInstance.findUserById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findUserById");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of User to fetch

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findUserByIdWith:id
              completionHandler: ^(UserItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of User to fetch


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findUserByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of User to fetch

            try
            {
                UserItem result = apiInstance.findUserById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findUserById: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of User to fetch

try {
    $result = $api_instance->findUserById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findUserById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*

Responses

Status: 200 - Successful response

Status: 404 - User not found

Status: 0 - Unexpected error


findUsers

This method is intended for returning all existing users in the system.


/users

Usage and SDK Samples


curl -X get "http://localhost/api/v1/users?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            UserCollection result = apiInstance.findUsers(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findUsers");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            UserCollection result = apiInstance.findUsers(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#findUsers");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance findUsersWith:page
    perPage:perPage
              completionHandler: ^(UserCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findUsersExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                UserCollection result = apiInstance.findUsers(page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.findUsers: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->findUsers($page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->findUsers: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
page
perPage

Responses

Status: 200 - Users list

Status: 0 - Unexpected error


importBpmnFile

This method is intended for importing BPMN files. This import covers next BPMN 2.0 elements for modeling processes: Sequence Flows, Start event, End event, Message Start event, Message Intermediate event, Timer Boundary Interrupting Event, Timer Boundary Non-Interrupting Event, Script task, User task, Service task Exclusive Gateways, Inclusive Gateways, Parallel Gateways. A new process is created when import passed successful.


/processes/import

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/import"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        BpmnImportItem bpmnImportItem = ; // BpmnImportItem | JsonApi with the BPMN file to import
        try {
            ProcessCollection_1 result = apiInstance.importBpmnFile(bpmnImportItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#importBpmnFile");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        BpmnImportItem bpmnImportItem = ; // BpmnImportItem | JsonApi with the BPMN file to import
        try {
            ProcessCollection_1 result = apiInstance.importBpmnFile(bpmnImportItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#importBpmnFile");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


BpmnImportItem *bpmnImportItem = ; // JsonApi with the BPMN file to import

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance importBpmnFileWith:bpmnImportItem
              completionHandler: ^(ProcessCollection_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var bpmnImportItem = ; // {BpmnImportItem} JsonApi with the BPMN file to import


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class importBpmnFileExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var bpmnImportItem = new BpmnImportItem(); // BpmnImportItem | JsonApi with the BPMN file to import

            try
            {
                ProcessCollection_1 result = apiInstance.importBpmnFile(bpmnImportItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.importBpmnFile: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$bpmnImportItem = ; // BpmnImportItem | JsonApi with the BPMN file to import

try {
    $result = $api_instance->importBpmnFile($bpmnImportItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->importBpmnFile: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
bpmnImportItem *

Responses

Status: 201 - Process instance was created successfully

Status: 403 - Forbidden access

Status: 500 - Internal server error

Status: 0 - Unexpected error


myselfUser

This method returns User information based on Token


/users/myself

Usage and SDK Samples


curl -X get "http://localhost/api/v1/users/myself?page=&perPage="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            UserItem result = apiInstance.myselfUser(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#myselfUser");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        Integer page = 56; // Integer | Page Nr to fetch
        Integer perPage = 56; // Integer | Amount of Items per Page
        try {
            UserItem result = apiInstance.myselfUser(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#myselfUser");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Integer *page = 56; // Page Nr to fetch (optional) (default to 1)
Integer *perPage = 56; // Amount of Items per Page (optional) (default to 15)

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance myselfUserWith:page
    perPage:perPage
              completionHandler: ^(UserItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var opts = { 
  'page': 56, // {Integer} Page Nr to fetch
  'perPage': 56 // {Integer} Amount of Items per Page
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class myselfUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var page = 56;  // Integer | Page Nr to fetch (optional)  (default to 1)
            var perPage = 56;  // Integer | Amount of Items per Page (optional)  (default to 15)

            try
            {
                UserItem result = apiInstance.myselfUser(page, perPage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.myselfUser: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$page = 56; // Integer | Page Nr to fetch
$perPage = 56; // Integer | Amount of Items per Page

try {
    $result = $api_instance->myselfUser($page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->myselfUser: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
page
perPage

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized access

Status: 0 - Unexpected error


removeGroupsFromTask

This method is intended for removing groups from a task


/processes/{process_id}/tasks/{task_id}/groups

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/groups"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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
        String taskId = taskId_example; // String | ID of Task
        TaskRemoveGroupsItem taskRemoveGroupsItem = ; // TaskRemoveGroupsItem | JsonApi with Groups ids to remove
        try {
            ResultSuccess result = apiInstance.removeGroupsFromTask(processId, taskId, taskRemoveGroupsItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#removeGroupsFromTask");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process
        String taskId = taskId_example; // String | ID of Task
        TaskRemoveGroupsItem taskRemoveGroupsItem = ; // TaskRemoveGroupsItem | JsonApi with Groups ids to remove
        try {
            ResultSuccess result = apiInstance.removeGroupsFromTask(processId, taskId, taskRemoveGroupsItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#removeGroupsFromTask");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process
String *taskId = taskId_example; // ID of Task
TaskRemoveGroupsItem *taskRemoveGroupsItem = ; // JsonApi with Groups ids to remove

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance removeGroupsFromTaskWith:processId
    taskId:taskId
    taskRemoveGroupsItem:taskRemoveGroupsItem
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process

var taskId = taskId_example; // {String} ID of Task

var taskRemoveGroupsItem = ; // {TaskRemoveGroupsItem} JsonApi with Groups ids to remove


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class removeGroupsFromTaskExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process
            var taskId = taskId_example;  // String | ID of Task
            var taskRemoveGroupsItem = new TaskRemoveGroupsItem(); // TaskRemoveGroupsItem | JsonApi with Groups ids to remove

            try
            {
                ResultSuccess result = apiInstance.removeGroupsFromTask(processId, taskId, taskRemoveGroupsItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.removeGroupsFromTask: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process
$taskId = taskId_example; // String | ID of Task
$taskRemoveGroupsItem = ; // TaskRemoveGroupsItem | JsonApi with Groups ids to remove

try {
    $result = $api_instance->removeGroupsFromTask($processId, $taskId, $taskRemoveGroupsItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->removeGroupsFromTask: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
Body parameters
Name Description
taskRemoveGroupsItem *

Responses

Status: 200 - JsonApi response with result details

Status: 404 - Group(s) not found

Status: 422 - Un-processable entity

Status: 500 - Error removing Group(s)

Status: 0 - unexpected error


removeUsersFromGroup

This method is intended for removing one or more users from a group.


/groups/{id}/users

Usage and SDK Samples


curl -X delete "http://localhost/api/v1/groups/{id}/users"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Group to modify
        GroupRemoveUsersItem groupRemoveUsersItem = ; // GroupRemoveUsersItem | JsonApi with Users ids to remove
        try {
            ResultSuccess result = apiInstance.removeUsersFromGroup(id, groupRemoveUsersItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#removeUsersFromGroup");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Group to modify
        GroupRemoveUsersItem groupRemoveUsersItem = ; // GroupRemoveUsersItem | JsonApi with Users ids to remove
        try {
            ResultSuccess result = apiInstance.removeUsersFromGroup(id, groupRemoveUsersItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#removeUsersFromGroup");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Group to modify
GroupRemoveUsersItem *groupRemoveUsersItem = ; // JsonApi with Users ids to remove

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance removeUsersFromGroupWith:id
    groupRemoveUsersItem:groupRemoveUsersItem
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Group to modify

var groupRemoveUsersItem = ; // {GroupRemoveUsersItem} JsonApi with Users ids to remove


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class removeUsersFromGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Group to modify
            var groupRemoveUsersItem = new GroupRemoveUsersItem(); // GroupRemoveUsersItem | JsonApi with Users ids to remove

            try
            {
                ResultSuccess result = apiInstance.removeUsersFromGroup(id, groupRemoveUsersItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.removeUsersFromGroup: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Group to modify
$groupRemoveUsersItem = ; // GroupRemoveUsersItem | JsonApi with Users ids to remove

try {
    $result = $api_instance->removeUsersFromGroup($id, $groupRemoveUsersItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->removeUsersFromGroup: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
groupRemoveUsersItem *

Responses

Status: 200 - JsonApi response with result details

Status: 422 - Un-processable entity

Status: 500 - Error adding Group(s)

Status: 0 - unexpected error


syncGroupsToTask

This method is intended for synchronizing a one or more groups with a task.


/processes/{process_id}/tasks/{task_id}/groups

Usage and SDK Samples


curl -X post "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/groups"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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
        String taskId = taskId_example; // String | ID of Task to modify
        TaskSyncGroupsItem taskSyncGroupsItem = ; // TaskSyncGroupsItem | JsonApi with Groups ids to sync
        try {
            ResultSuccess result = apiInstance.syncGroupsToTask(processId, taskId, taskSyncGroupsItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#syncGroupsToTask");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process
        String taskId = taskId_example; // String | ID of Task to modify
        TaskSyncGroupsItem taskSyncGroupsItem = ; // TaskSyncGroupsItem | JsonApi with Groups ids to sync
        try {
            ResultSuccess result = apiInstance.syncGroupsToTask(processId, taskId, taskSyncGroupsItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#syncGroupsToTask");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process
String *taskId = taskId_example; // ID of Task to modify
TaskSyncGroupsItem *taskSyncGroupsItem = ; // JsonApi with Groups ids to sync

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance syncGroupsToTaskWith:processId
    taskId:taskId
    taskSyncGroupsItem:taskSyncGroupsItem
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process

var taskId = taskId_example; // {String} ID of Task to modify

var taskSyncGroupsItem = ; // {TaskSyncGroupsItem} JsonApi with Groups ids to sync


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class syncGroupsToTaskExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process
            var taskId = taskId_example;  // String | ID of Task to modify
            var taskSyncGroupsItem = new TaskSyncGroupsItem(); // TaskSyncGroupsItem | JsonApi with Groups ids to sync

            try
            {
                ResultSuccess result = apiInstance.syncGroupsToTask(processId, taskId, taskSyncGroupsItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.syncGroupsToTask: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process
$taskId = taskId_example; // String | ID of Task to modify
$taskSyncGroupsItem = ; // TaskSyncGroupsItem | JsonApi with Groups ids to sync

try {
    $result = $api_instance->syncGroupsToTask($processId, $taskId, $taskSyncGroupsItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->syncGroupsToTask: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
Body parameters
Name Description
taskSyncGroupsItem *

Responses

Status: 200 - JsonApi response with result details

Status: 404 - Group(s) not found

Status: 500 - Error sync Group(s)

Status: 0 - unexpected error


syncUsersToGroup

This method is intended for synchronizing one or more users with a group.


/groups/{id}/users

Usage and SDK Samples


curl -X post "http://localhost/api/v1/groups/{id}/users"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Group to modify
        GroupSyncUsersItem groupSyncUsersItem = ; // GroupSyncUsersItem | JsonApi with Users ids to sync
        try {
            ResultSuccess result = apiInstance.syncUsersToGroup(id, groupSyncUsersItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#syncUsersToGroup");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Group to modify
        GroupSyncUsersItem groupSyncUsersItem = ; // GroupSyncUsersItem | JsonApi with Users ids to sync
        try {
            ResultSuccess result = apiInstance.syncUsersToGroup(id, groupSyncUsersItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#syncUsersToGroup");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Group to modify
GroupSyncUsersItem *groupSyncUsersItem = ; // JsonApi with Users ids to sync

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance syncUsersToGroupWith:id
    groupSyncUsersItem:groupSyncUsersItem
              completionHandler: ^(ResultSuccess output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Group to modify

var groupSyncUsersItem = ; // {GroupSyncUsersItem} JsonApi with Users ids to sync


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class syncUsersToGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Group to modify
            var groupSyncUsersItem = new GroupSyncUsersItem(); // GroupSyncUsersItem | JsonApi with Users ids to sync

            try
            {
                ResultSuccess result = apiInstance.syncUsersToGroup(id, groupSyncUsersItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.syncUsersToGroup: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Group to modify
$groupSyncUsersItem = ; // GroupSyncUsersItem | JsonApi with Users ids to sync

try {
    $result = $api_instance->syncUsersToGroup($id, $groupSyncUsersItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->syncUsersToGroup: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
groupSyncUsersItem *

Responses

Status: 200 - JsonApi response with result details

Status: 500 - Error adding Group(s)

Status: 0 - unexpected error


updateClient

This method is intended for updating an existing client.


/users/{user_id}/clients/{client_id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/users/{user_id}/clients/{client_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 userId = userId_example; // String | ID of User to fetch
        String clientId = clientId_example; // String | ID of Client to fetch
        ClientUpdateItem clientUpdateItem = ; // ClientUpdateItem | Client object to edit
        try {
            ClientItem result = apiInstance.updateClient(userId, clientId, clientUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateClient");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String userId = userId_example; // String | ID of User to fetch
        String clientId = clientId_example; // String | ID of Client to fetch
        ClientUpdateItem clientUpdateItem = ; // ClientUpdateItem | Client object to edit
        try {
            ClientItem result = apiInstance.updateClient(userId, clientId, clientUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateClient");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *userId = userId_example; // ID of User to fetch
String *clientId = clientId_example; // ID of Client to fetch
ClientUpdateItem *clientUpdateItem = ; // Client object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateClientWith:userId
    clientId:clientId
    clientUpdateItem:clientUpdateItem
              completionHandler: ^(ClientItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var userId = userId_example; // {String} ID of User to fetch

var clientId = clientId_example; // {String} ID of Client to fetch

var clientUpdateItem = ; // {ClientUpdateItem} Client object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateClientExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var userId = userId_example;  // String | ID of User to fetch
            var clientId = clientId_example;  // String | ID of Client to fetch
            var clientUpdateItem = new ClientUpdateItem(); // ClientUpdateItem | Client object to edit

            try
            {
                ClientItem result = apiInstance.updateClient(userId, clientId, clientUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateClient: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$userId = userId_example; // String | ID of User to fetch
$clientId = clientId_example; // String | ID of Client to fetch
$clientUpdateItem = ; // ClientUpdateItem | Client object to edit

try {
    $result = $api_instance->updateClient($userId, $clientId, $clientUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateClient: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
userId*
clientId*
Body parameters
Name Description
clientUpdateItem *

Responses

Status: 200 - JsonApi response with updated Client object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateEvent

This method lets update the existing Process Event with new data


/processes/{process_id}/events/{event_id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/events/{event_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String eventId = eventId_example; // String | ID of Event to fetch
        EventUpdateItem eventUpdateItem = ; // EventUpdateItem | Event object to edit
        try {
            EventItem result = apiInstance.updateEvent(processId, eventId, eventUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateEvent");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String eventId = eventId_example; // String | ID of Event to fetch
        EventUpdateItem eventUpdateItem = ; // EventUpdateItem | Event object to edit
        try {
            EventItem result = apiInstance.updateEvent(processId, eventId, eventUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateEvent");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *eventId = eventId_example; // ID of Event to fetch
EventUpdateItem *eventUpdateItem = ; // Event object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateEventWith:processId
    eventId:eventId
    eventUpdateItem:eventUpdateItem
              completionHandler: ^(EventItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var eventId = eventId_example; // {String} ID of Event to fetch

var eventUpdateItem = ; // {EventUpdateItem} Event object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateEventExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var eventId = eventId_example;  // String | ID of Event to fetch
            var eventUpdateItem = new EventUpdateItem(); // EventUpdateItem | Event object to edit

            try
            {
                EventItem result = apiInstance.updateEvent(processId, eventId, eventUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateEvent: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$eventId = eventId_example; // String | ID of Event to fetch
$eventUpdateItem = ; // EventUpdateItem | Event object to edit

try {
    $result = $api_instance->updateEvent($processId, $eventId, $eventUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateEvent: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
eventId*
Body parameters
Name Description
eventUpdateItem *

Responses

Status: 200 - JsonApi response with updated Event object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateFlow

This method is intended for updating an existing flow.


/processes/{process_id}/flows/{flow_id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/flows/{flow_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String flowId = flowId_example; // String | ID of Flow to fetch
        FlowUpdateItem flowUpdateItem = ; // FlowUpdateItem | Flow object to edit
        try {
            FlowItem result = apiInstance.updateFlow(processId, flowId, flowUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateFlow");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String flowId = flowId_example; // String | ID of Flow to fetch
        FlowUpdateItem flowUpdateItem = ; // FlowUpdateItem | Flow object to edit
        try {
            FlowItem result = apiInstance.updateFlow(processId, flowId, flowUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateFlow");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *flowId = flowId_example; // ID of Flow to fetch
FlowUpdateItem *flowUpdateItem = ; // Flow object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateFlowWith:processId
    flowId:flowId
    flowUpdateItem:flowUpdateItem
              completionHandler: ^(FlowItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var flowId = flowId_example; // {String} ID of Flow to fetch

var flowUpdateItem = ; // {FlowUpdateItem} Flow object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateFlowExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var flowId = flowId_example;  // String | ID of Flow to fetch
            var flowUpdateItem = new FlowUpdateItem(); // FlowUpdateItem | Flow object to edit

            try
            {
                FlowItem result = apiInstance.updateFlow(processId, flowId, flowUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateFlow: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$flowId = flowId_example; // String | ID of Flow to fetch
$flowUpdateItem = ; // FlowUpdateItem | Flow object to edit

try {
    $result = $api_instance->updateFlow($processId, $flowId, $flowUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateFlow: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
flowId*
Body parameters
Name Description
flowUpdateItem *

Responses

Status: 200 - JsonApi response with updated Flow object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateGateway

This method is intended for updating an existing gateway.


/processes/{process_id}/gateways/{gateway_id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/gateways/{gateway_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String gatewayId = gatewayId_example; // String | ID of Gateway to fetch
        GatewayUpdateItem gatewayUpdateItem = ; // GatewayUpdateItem | Gateway object to edit
        try {
            GatewayItem result = apiInstance.updateGateway(processId, gatewayId, gatewayUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateGateway");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String gatewayId = gatewayId_example; // String | ID of Gateway to fetch
        GatewayUpdateItem gatewayUpdateItem = ; // GatewayUpdateItem | Gateway object to edit
        try {
            GatewayItem result = apiInstance.updateGateway(processId, gatewayId, gatewayUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateGateway");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *gatewayId = gatewayId_example; // ID of Gateway to fetch
GatewayUpdateItem *gatewayUpdateItem = ; // Gateway object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateGatewayWith:processId
    gatewayId:gatewayId
    gatewayUpdateItem:gatewayUpdateItem
              completionHandler: ^(GatewayItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var gatewayId = gatewayId_example; // {String} ID of Gateway to fetch

var gatewayUpdateItem = ; // {GatewayUpdateItem} Gateway object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateGatewayExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var gatewayId = gatewayId_example;  // String | ID of Gateway to fetch
            var gatewayUpdateItem = new GatewayUpdateItem(); // GatewayUpdateItem | Gateway object to edit

            try
            {
                GatewayItem result = apiInstance.updateGateway(processId, gatewayId, gatewayUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateGateway: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$gatewayId = gatewayId_example; // String | ID of Gateway to fetch
$gatewayUpdateItem = ; // GatewayUpdateItem | Gateway object to edit

try {
    $result = $api_instance->updateGateway($processId, $gatewayId, $gatewayUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateGateway: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
gatewayId*
Body parameters
Name Description
gatewayUpdateItem *

Responses

Status: 200 - JsonApi response with updated Gateway object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateGroup

This method is intended for updating an existing group.


/groups/{id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/groups/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Group to fetch
        GroupUpdateItem groupUpdateItem = ; // GroupUpdateItem | Group object to edit
        try {
            GroupItem result = apiInstance.updateGroup(id, groupUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateGroup");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Group to fetch
        GroupUpdateItem groupUpdateItem = ; // GroupUpdateItem | Group object to edit
        try {
            GroupItem result = apiInstance.updateGroup(id, groupUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateGroup");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Group to fetch
GroupUpdateItem *groupUpdateItem = ; // Group object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateGroupWith:id
    groupUpdateItem:groupUpdateItem
              completionHandler: ^(GroupItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Group to fetch

var groupUpdateItem = ; // {GroupUpdateItem} Group object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateGroupExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Group to fetch
            var groupUpdateItem = new GroupUpdateItem(); // GroupUpdateItem | Group object to edit

            try
            {
                GroupItem result = apiInstance.updateGroup(id, groupUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateGroup: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Group to fetch
$groupUpdateItem = ; // GroupUpdateItem | Group object to edit

try {
    $result = $api_instance->updateGroup($id, $groupUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateGroup: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
groupUpdateItem *

Responses

Status: 200 - JsonApi response with updated Group object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateInputOutput

This method is intended for updating an existing InputOutput.


/processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}/inputoutput/{inputoutput_uid}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        String inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
        InputOutputUpdateItem inputOutputUpdateItem = ; // InputOutputUpdateItem | InputOutput object to edit
        try {
            InputOutputItem result = apiInstance.updateInputOutput(processId, taskId, inputoutputUid, inputOutputUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateInputOutput");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | Process ID related to InputOutput object
        String taskId = taskId_example; // String | Task instance ID related to InputOutput object
        String inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
        InputOutputUpdateItem inputOutputUpdateItem = ; // InputOutputUpdateItem | InputOutput object to edit
        try {
            InputOutputItem result = apiInstance.updateInputOutput(processId, taskId, inputoutputUid, inputOutputUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateInputOutput");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // Process ID related to InputOutput object
String *taskId = taskId_example; // Task instance ID related to InputOutput object
String *inputoutputUid = inputoutputUid_example; // ID of InputOutput to fetch
InputOutputUpdateItem *inputOutputUpdateItem = ; // InputOutput object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateInputOutputWith:processId
    taskId:taskId
    inputoutputUid:inputoutputUid
    inputOutputUpdateItem:inputOutputUpdateItem
              completionHandler: ^(InputOutputItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} Process ID related to InputOutput object

var taskId = taskId_example; // {String} Task instance ID related to InputOutput object

var inputoutputUid = inputoutputUid_example; // {String} ID of InputOutput to fetch

var inputOutputUpdateItem = ; // {InputOutputUpdateItem} InputOutput object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateInputOutputExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | Process ID related to InputOutput object
            var taskId = taskId_example;  // String | Task instance ID related to InputOutput object
            var inputoutputUid = inputoutputUid_example;  // String | ID of InputOutput to fetch
            var inputOutputUpdateItem = new InputOutputUpdateItem(); // InputOutputUpdateItem | InputOutput object to edit

            try
            {
                InputOutputItem result = apiInstance.updateInputOutput(processId, taskId, inputoutputUid, inputOutputUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateInputOutput: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | Process ID related to InputOutput object
$taskId = taskId_example; // String | Task instance ID related to InputOutput object
$inputoutputUid = inputoutputUid_example; // String | ID of InputOutput to fetch
$inputOutputUpdateItem = ; // InputOutputUpdateItem | InputOutput object to edit

try {
    $result = $api_instance->updateInputOutput($processId, $taskId, $inputoutputUid, $inputOutputUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateInputOutput: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
inputoutputUid*
Body parameters
Name Description
inputOutputUpdateItem *

Responses

Status: 200 - The InputOutput object was updated successfully via JSON API response

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateInstance

This method is intended for updating an existing Instance.


/processes/{process_id}/instances/{instance_id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/instances/{instance_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String instanceId = instanceId_example; // String | ID of Instance to fetch
        InstanceUpdateItem instanceUpdateItem = ; // InstanceUpdateItem | Instance object to edit
        try {
            InstanceItem result = apiInstance.updateInstance(processId, instanceId, instanceUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateInstance");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String instanceId = instanceId_example; // String | ID of Instance to fetch
        InstanceUpdateItem instanceUpdateItem = ; // InstanceUpdateItem | Instance object to edit
        try {
            InstanceItem result = apiInstance.updateInstance(processId, instanceId, instanceUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateInstance");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *instanceId = instanceId_example; // ID of Instance to fetch
InstanceUpdateItem *instanceUpdateItem = ; // Instance object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateInstanceWith:processId
    instanceId:instanceId
    instanceUpdateItem:instanceUpdateItem
              completionHandler: ^(InstanceItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var instanceId = instanceId_example; // {String} ID of Instance to fetch

var instanceUpdateItem = ; // {InstanceUpdateItem} Instance object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateInstanceExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var instanceId = instanceId_example;  // String | ID of Instance to fetch
            var instanceUpdateItem = new InstanceUpdateItem(); // InstanceUpdateItem | Instance object to edit

            try
            {
                InstanceItem result = apiInstance.updateInstance(processId, instanceId, instanceUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateInstance: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$instanceId = instanceId_example; // String | ID of Instance to fetch
$instanceUpdateItem = ; // InstanceUpdateItem | Instance object to edit

try {
    $result = $api_instance->updateInstance($processId, $instanceId, $instanceUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateInstance: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
instanceId*
Body parameters
Name Description
instanceUpdateItem *

Responses

Status: 200 - JsonApi response with updated Instance object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateProcess

This method is intended for updating an existing process.


/processes/{id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of Process to fetch
        ProcessUpdateItem processUpdateItem = ; // ProcessUpdateItem | Process object to edit
        try {
            ProcessItem result = apiInstance.updateProcess(id, processUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateProcess");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of Process to fetch
        ProcessUpdateItem processUpdateItem = ; // ProcessUpdateItem | Process object to edit
        try {
            ProcessItem result = apiInstance.updateProcess(id, processUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateProcess");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of Process to fetch
ProcessUpdateItem *processUpdateItem = ; // Process object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateProcessWith:id
    processUpdateItem:processUpdateItem
              completionHandler: ^(ProcessItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of Process to fetch

var processUpdateItem = ; // {ProcessUpdateItem} Process object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateProcessExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of Process to fetch
            var processUpdateItem = new ProcessUpdateItem(); // ProcessUpdateItem | Process object to edit

            try
            {
                ProcessItem result = apiInstance.updateProcess(id, processUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateProcess: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of Process to fetch
$processUpdateItem = ; // ProcessUpdateItem | Process object to edit

try {
    $result = $api_instance->updateProcess($id, $processUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateProcess: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
processUpdateItem *

Responses

Status: 200 - JsonApi response with updated Process object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateTask

This method is intended for updating an existing task.


/processes/{process_id}/tasks/{task_id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/processes/{process_id}/tasks/{task_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 to fetch
        String taskId = taskId_example; // String | ID of Task to fetch
        TaskUpdateItem taskUpdateItem = ; // TaskUpdateItem | Task object to edit
        try {
            TaskItem result = apiInstance.updateTask(processId, taskId, taskUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateTask");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String processId = processId_example; // String | ID of Process to fetch
        String taskId = taskId_example; // String | ID of Task to fetch
        TaskUpdateItem taskUpdateItem = ; // TaskUpdateItem | Task object to edit
        try {
            TaskItem result = apiInstance.updateTask(processId, taskId, taskUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateTask");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *processId = processId_example; // ID of Process to fetch
String *taskId = taskId_example; // ID of Task to fetch
TaskUpdateItem *taskUpdateItem = ; // Task object to edit

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateTaskWith:processId
    taskId:taskId
    taskUpdateItem:taskUpdateItem
              completionHandler: ^(TaskItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var processId = processId_example; // {String} ID of Process to fetch

var taskId = taskId_example; // {String} ID of Task to fetch

var taskUpdateItem = ; // {TaskUpdateItem} Task object to edit


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateTaskExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var processId = processId_example;  // String | ID of Process to fetch
            var taskId = taskId_example;  // String | ID of Task to fetch
            var taskUpdateItem = new TaskUpdateItem(); // TaskUpdateItem | Task object to edit

            try
            {
                TaskItem result = apiInstance.updateTask(processId, taskId, taskUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateTask: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$processId = processId_example; // String | ID of Process to fetch
$taskId = taskId_example; // String | ID of Task to fetch
$taskUpdateItem = ; // TaskUpdateItem | Task object to edit

try {
    $result = $api_instance->updateTask($processId, $taskId, $taskUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateTask: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
processId*
taskId*
Body parameters
Name Description
taskUpdateItem *

Responses

Status: 200 - JsonApi response with updated Task object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateTaskInstance

This method is intended for updating an existing TaskInstance.


/task_instances/{task_instance_id}

Usage and SDK Samples


curl -X patch "http://localhost/api/v1/task_instances/{task_instance_id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 taskInstanceId = taskInstanceId_example; // String | ID of TaskInstance to fetch
        TaskInstanceUpdateItem taskInstanceUpdateItem = ; // TaskInstanceUpdateItem | TaskInstance object to update
        try {
            inline_response_200 result = apiInstance.updateTaskInstance(taskInstanceId, taskInstanceUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateTaskInstance");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String taskInstanceId = taskInstanceId_example; // String | ID of TaskInstance to fetch
        TaskInstanceUpdateItem taskInstanceUpdateItem = ; // TaskInstanceUpdateItem | TaskInstance object to update
        try {
            inline_response_200 result = apiInstance.updateTaskInstance(taskInstanceId, taskInstanceUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateTaskInstance");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *taskInstanceId = taskInstanceId_example; // ID of TaskInstance to fetch
TaskInstanceUpdateItem *taskInstanceUpdateItem = ; // TaskInstance object to update

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateTaskInstanceWith:taskInstanceId
    taskInstanceUpdateItem:taskInstanceUpdateItem
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var taskInstanceId = taskInstanceId_example; // {String} ID of TaskInstance to fetch

var taskInstanceUpdateItem = ; // {TaskInstanceUpdateItem} TaskInstance object to update


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateTaskInstanceExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var taskInstanceId = taskInstanceId_example;  // String | ID of TaskInstance to fetch
            var taskInstanceUpdateItem = new TaskInstanceUpdateItem(); // TaskInstanceUpdateItem | TaskInstance object to update

            try
            {
                inline_response_200 result = apiInstance.updateTaskInstance(taskInstanceId, taskInstanceUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateTaskInstance: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$taskInstanceId = taskInstanceId_example; // String | ID of TaskInstance to fetch
$taskInstanceUpdateItem = ; // TaskInstanceUpdateItem | TaskInstance object to update

try {
    $result = $api_instance->updateTaskInstance($taskInstanceId, $taskInstanceUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateTaskInstance: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
taskInstanceId*
Body parameters
Name Description
taskInstanceUpdateItem *

Responses

Status: 200 - JsonApi response with updated TaskInstance object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


updateUser

This method is intended for updating parameters an existing user.


/users/{id}

Usage and SDK Samples


curl -X put "http://localhost/api/v1/users/{id}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .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 id = id_example; // String | ID of User to fetch
        UserUpdateItem userUpdateItem = ; // UserUpdateItem | User object for update
        try {
            UserItem result = apiInstance.updateUser(id, userUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateUser");
            e.printStackTrace();
        }
    }
}

                                                  

import .ProcessmakerApi;

public class ProcessmakerApiExample {

    public static void main(String[] args) {
        ProcessmakerApi apiInstance = new ProcessmakerApi();
        String id = id_example; // String | ID of User to fetch
        UserUpdateItem userUpdateItem = ; // UserUpdateItem | User object for update
        try {
            UserItem result = apiInstance.updateUser(id, userUpdateItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessmakerApi#updateUser");
            e.printStackTrace();
        }
    }
}

                                                  

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: internalApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"access_token"];

// Configure OAuth2 access token for authorization: (authentication scheme: PasswordGrant)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


String *id = id_example; // ID of User to fetch
UserUpdateItem *userUpdateItem = ; // User object for update

ProcessmakerApi *apiInstance = [[ProcessmakerApi alloc] init];

[apiInstance updateUserWith:id
    userUpdateItem:userUpdateItem
              completionHandler: ^(UserItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: internalApiKey
var internalApiKey = defaultClient.authentications['internalApiKey'];
internalApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//internalApiKey.apiKeyPrefix['access_token'] = "Token"

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

var api = new .ProcessmakerApi()

var id = id_example; // {String} ID of User to fetch

var userUpdateItem = ; // {UserUpdateItem} User object for update


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: internalApiKey
            Configuration.Default.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure OAuth2 access token for authorization: PasswordGrant
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProcessmakerApi();
            var id = id_example;  // String | ID of User to fetch
            var userUpdateItem = new UserUpdateItem(); // UserUpdateItem | User object for update

            try
            {
                UserItem result = apiInstance.updateUser(id, userUpdateItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessmakerApi.updateUser: " + e.Message );
            }
        }
    }
}

                                                    

setApiKey('access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
// Configure OAuth2 access token for authorization: PasswordGrant
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\ProcessmakerApi();
$id = id_example; // String | ID of User to fetch
$userUpdateItem = ; // UserUpdateItem | User object for update

try {
    $result = $api_instance->updateUser($id, $userUpdateItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessmakerApi->updateUser: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
userUpdateItem *

Responses

Status: 200 - JsonApi response with updated User object

Status: 400 - Invalid parameters

Status: 0 - unexpected error


Generated 2017-03-14T14:31:23.811+02:00