getProcesses
A Graze API GET request that returns a list of the processes in the database.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint getProcesses
takes the following request arguments:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String |
Yes |
A valid |
|
Integer |
No |
Maximum number of processes to return. Defaults to 100. |
|
Boolean |
No |
If |
Response
Endpoint getProcesses
returns the following response:
Successful requests return an array of JSON objects containing the following:
Name |
Type |
Description |
---|---|---|
|
Number |
ID of the process. |
|
String |
Name of the process. |
|
String |
Description of the process. |
Examples
The following examples demonstrate typical use of endpoint getProcesses
:
Request example
Example cURL request to return the first 100 processes containing "Network" in the process name:
curl -G -u graze:graze -k -v "https://localhost/graze/v1/getProcesses" --data-urlencode 'query=Network' --data-urlencode 'exact_match=false'
Response example
Example response returning three process names containing "Network":
[ { "process_id": 1, "name": "Network LON", "description": "Network London" }, { "process_id": 2, "name": "NY Network A", "description": "Network New York A" }, { "process_id": 3, "name": "NY Network B", "description": "Network New York B" } ]