All URIs are relative to https://CHANGEME.api.processmaker.io/api/v1
| Method | HTTP request | Description |
|---|---|---|
| AddGateway | Post /processes/{process_id}/gateways | |
| DeleteGateway | Delete /processes/{process_id}/gateways/{gateway_id} | |
| FindGatewayById | Get /processes/{process_id}/gateways/{gateway_id} | |
| FindGateways | Get /processes/{process_id}/gateways | |
| UpdateGateway | Put /processes/{process_id}/gateways/{gateway_id} |
GatewayItem AddGateway($processId, $gatewayCreateItem)
This method creates a new gateway.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the gateway | |
| gatewayCreateItem | GatewayCreateItem | JSON API response with the gateway object to add |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResultSuccess DeleteGateway($processId, $gatewayId)
This method deletes a single item using the gateway ID and the process ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | Process ID | |
| gatewayId | string | ID of the process to delete |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayItem FindGatewayById($processId, $gatewayId)
This method retrieves a gateway based on its ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to return | |
| gatewayId | string | ID of gateway to return |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayCollection FindGateways($processId, $page, $perPage)
This method retrieves all existing gateways.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process related to the gateway | |
| page | int32 | Page number to fetch | [optional] [default to 1] |
| perPage | int32 | Amount of items per page | [optional] [default to 15] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GatewayItem UpdateGateway($processId, $gatewayId, $gatewayUpdateItem)
This method updates an existing gateway.
| Name | Type | Description | Notes |
|---|---|---|---|
| processId | string | ID of the process to retrieve | |
| gatewayId | string | ID of the gateway to retrieve | |
| gatewayUpdateItem | GatewayUpdateItem | Gateway object to edit |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]