Retrieve profiles (ID and name)

Description

Retrieve a list of all the workflow profile names

URL Path

/file/rules

Method

GET

Summary

Retrieves a list of all workflow profile names [i.e. "rule"] and associated IDs.

HTTP header parameters

rule

rule/profile name to search for

OPTIONAL

Request Error

404

Not Found

Could not find the rule specified with the rule header

500

Internal Error

Unexpected error; check logs for details

Response

Example of retrieving all rules:

200
[
{
"name": "Block EXE",
"id": "57c99fc376e0e0f1b9baab54"
},
{
"name": "Client",
"id": "57c99fc376e0e0f1b9baab55"
},
{
"name": "Convert Docs",
"id": "57c99fc376e0e0f1b9baab56"
},
{
"name": "Guest",
"id": "57c99fc376e0e0f1b9baab57"
},
{
"name": "High Security",
"id": "57c99fc376e0e0f1b9baab58"
},
{
"name": "Kiosk",
"id": "57c99fc376e0e0f1b9baab59"
},
{
"name": "Mail Agent",
"id": "57c99fc376e0e0f1b9baab5a"
},
{
"name": "No EXE/Archives",
"id": "57c99fc376e0e0f1b9baab5b"
},
{
"name": "Only Docs",
"id": "57c99fc376e0e0f1b9baab5c"
},
{
"name": "Default",
"id": "57c99fc376e0e0f1b9baab5d"
},
{
"name": "Proxy",
"id": "57c99fc376e0e0f1b9baab5e"
},
{
"name": "Web Scan",
"id": "57c99fc376e0e0f1b9baab5f"
}
]

Example of searching for specific workflow with the rule header:

200
[
{
"name": "Client",
"id": "57f7e5621d9ac33a3788e031"
}
]

Descriptions of response:

name

the name of the workflow profile (i.e. rule)

id

Unique identifier for a workflow. Changing workflow name does not affect id. Use "name" for description and "id" to specify a workflow.