BPA 10.5 REST API documentation (10.5.0.56)
General Information

AutoMate BPA Server implements a RESTful (REpresentational State Transfer) web service on your BPA Management Server. To access the BPA web service, you need to use a REST client/library that can construct the URI, header, method (GET, PUT, POST, DELETE), and body of the requests. The base URI for the BPA web service is "http://myserver:9608/BPAManagement/". By default the web service is turned off. It can be enabled in the Options->Server Settings->API Security page of the SMC. BPA Server does not need to be restarted to enable/disable this feature.

The web service uses HTTP Basic authentication and therefore does not require cookies, a session identifier, or login pages. For HTTP Basic authentication, the URI is often specified to the client like "http://myuser:mypassword@myserver:9608/BPAManagement/". The client then takes that user:password combination out of the URI, encodes it in Base64, and adds a header line similar to: "Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ=". Note: Some clients will not parse the user:password out of the URI and add the header for you. For those clients, you may have to specify the user and password as separate parameters or provide the header line yourself.

This API is only available for Enterprise version of AutoMate BPA Server.

Index
Info
/info/get

Workflows
/workflows/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/workflows/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/workflows/create
/workflows/{id}/get
/workflows/{id}/update
/workflows/{id}/delete
/workflows/{id}/run
/workflows/{id}/enable
/workflows/{id}/disable
/workflows/{id}/resume
/workflows/{id}/properties/get
/workflows/{id}/properties/update
/workflows/{id}/permissions/index
/workflows/{id}/permissions/create
/workflows/{id}/permissions/{id2}/get
/workflows/{id}/permissions/{id2}/update
/workflows/{id}/permissions/{id2}/delete
/workflows/{id}/audit_events/index
/workflows/{id}/audit_events/{id2}/get
/workflows/{id}/execution_events/index
/workflows/{id}/execution_events/{id2}/get
/workflows/{id}/instances/index
/workflows/{id}/running_instances/index
/workflows/{id}/running_instances/{id2}/stop
/workflows/{id}/running_instances/{id2}/pause
/workflows/{id}/running_instances/{id2}/resume
/workflows/{id}/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID}

tasks
/tasks/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/tasks/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/tasks/create
/tasks/{id}/get
/tasks/{id}/update
/tasks/{id}/delete
/tasks/{id}/run?agent_id={AgentID}&agent_group_id={AgentGroupID}
/tasks/{id}/enable
/tasks/{id}/disable
/tasks/{id}/properties/get
/tasks/{id}/properties/update
/tasks/{id}/permissions/index
/tasks/{id}/permissions/create
/tasks/{id}/permissions/{id2}/get
/tasks/{id}/permissions/{id2}/update
/tasks/{id}/permissions/{id2}/delete
/tasks/{id}/audit_events/index
/tasks/{id}/audit_events/{id2}/get
/tasks/{id}/execution_events/index
/tasks/{id}/execution_events/{id2}/get
/tasks/{id}/instances/index
/tasks/{id}/running_instances/index
/tasks/{id}/running_instances/{id2}/stop
/tasks/{id}/running_instances/{id2}/pause
/tasks/{id}/running_instances/{id2}/resume
/tasks/{id}/workflows/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID}

processes
/processes/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/processes/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/processes/create
/processes/{id}/get
/processes/{id}/update
/processes/{id}/delete
/processes/{id}/enable
/processes/{id}/disable
/processes/{id}/run?process_agent_id={ProcessAgentID}&agent_group_id={AgentGroupID}
/processes/{id}/permissions/index
/processes/{id}/permissions/create
/processes/{id}/permissions/{id2}/get
/processes/{id}/permissions/{id2}/update
/processes/{id}/permissions/{id2}/delete
/processes/{id}/audit_events/index
/processes/{id}/audit_events/{id2}/get
/processes/{id}/execution_events/index
/processes/{id}/execution_events/{id2}/get
/processes/{id}/instances/index
/processes/{id}/running_instances/index
/processes/{id}/workflows/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID}

conditions
/conditions/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/conditions/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/conditions/create
/conditions/{id}/get
/conditions/{id}/update
/conditions/{id}/delete
/conditions/{id}/enable
/conditions/{id}/disable
/conditions/{id}/permissions/index
/conditions/{id}/permissions/create
/conditions/{id}/permissions/{id2}/get
/conditions/{id}/permissions/{id2}/update
/conditions/{id}/permissions/{id2}/delete
/conditions/{id}/audit_events/index
/conditions/{id}/audit_events/{id2}/get
/conditions/{id}/execution_events/index
/conditions/{id}/execution_events/{id2}/get
/conditions/{id}/workflows/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID}

folders
/folders/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/folders/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/folders/create
/folders/{id}/get
/folders/{id}/update
/folders/{id}/delete
/folders/{id}/permissions/index
/folders/{id}/permissions/create
/folders/{id}/permissions/{id2}/get
/folders/{id}/permissions/{id2}/update
/folders/{id}/permissions/{id2}/delete
/folders/{id}/audit_events/index
/folders/{id}/audit_events/{id2}/get

agents
/agents/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/agents/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/agents/create
/agents/{id}/get
/agents/{id}/update
/agents/{id}/delete
/agents/{id}/enable
/agents/{id}/disable
/agents/{id}/properties/get
/agents/{id}/properties/update
/agents/{id}/permissions/index
/agents/{id}/permissions/create
/agents/{id}/permissions/{id2}/get
/agents/{id}/permissions/{id2}/update
/agents/{id}/permissions/{id2}/delete
/agents/{id}/audit_events/index
/agents/{id}/audit_events/{id2}/get
/agents/{id}/execution_events/index
/agents/{id}/execution_events/{id2}/get
/agents/{id}/conditions/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}
/agents/online/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}
/agents/{id}/running_instances/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}

agent groups
/agent_groups/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/agent_groups/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/agent_groups/create
/agent_groups/{id}/get
/agent_groups/{id}/update
/agent_groups/{id}/delete
/agent_groups/{id}/enable
/agent_groups/{id}/disable
/agent_groups/{id}/permissions/index
/agent_groups/{id}/permissions/create
/agent_groups/{id}/permissions/{id2}/get
/agent_groups/{id}/permissions/{id2}/update
/agent_groups/{id}/permissions/{id2}/delete
/agent_groups/{id}/audit_events/index
/agent_groups/{id}/audit_events/{id2}/get

users
/users/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/users/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/users/create
/users/{id}/get
/users/{id}/update
/users/{id}/delete
/users/{id}/enable
/users/{id}/disable
/users/{id}/permissions/index
/users/{id}/permissions/create
/users/{id}/permissions/{id2}/get
/users/{id}/permissions/{id2}/update
/users/{id}/permissions/{id2}/delete
/users/{id}/audit_events/index
/users/{id}/audit_events/{id2}/get
/users/authenticate

user groups
/user_groups/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/user_groups/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/user_groups/create
/user_groups/{id}/get
/user_groups/{id}/update
/user_groups/{id}/delete
/user_groups/{id}/enable
/user_groups/{id}/disable
/user_groups/{id}/permissions/index
/user_groups/{id}/permissions/create
/user_groups/{id}/permissions/{id2}/get
/user_groups/{id}/permissions/{id2}/update
/user_groups/{id}/permissions/{id2}/delete
/user_groups/{id}/audit_events/index
/user_groups/{id}/audit_events/{id2}/get

calendar
/calendar/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&type={ScheduleType}&start_index={PageStartIndex}&page_size={PageSize}

Events
/audit_events/get?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}
/execution_events/get?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}

instances
/instances/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}&include_relatives={IncludeRelatives}
/instances/running/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}&include_relatives={IncludeRelatives}
/instances/completed/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}&include_relatives={IncludeRelatives}

metrics
/metrics/execution/get
/metrics/management/get
/metrics/run/list?range_start={RangeStart}&range_end={RangeEnd}&interval_size={IntervalSize}&filter_sets={FilterSets}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/metrics/completed/list?range_start={RangeStart}&range_end={RangeEnd}&interval_size={IntervalSize}&filter_sets={FilterSets}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/metrics/queued/list?range_start={RangeStart}&range_end={RangeEnd}&interval_size={IntervalSize}&filter_sets={FilterSets}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}
/metrics/deviations/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&folder_id={FolderID}&deviation_percentage={DeviationPercentage}&deviation_direction={DeviationDirection}&start_index={PageStartIndex}&page_size={PageSize}

system permissions
/system_permissions/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}
/system_permissions/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}
/system_permissions/create
/system_permissions/{id}/get
/system_permissions/{id}/update
/system_permissions/{id}/delete

Output
output/list?start_index={PageStartIndex}&page_size={PageSize}


Resources

/info/get [GET]

Description:Gets information about the server.
Results
Description:JSON representation of the system info.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "SystemInfo:#AutoMate.Communications.Server",
"Product": "AutoMate BPA Server",
"Version": "10.5.0.25",
"ServerUTCOffset": "-07:00:00"
},
"Paging": null,
"LookupTable": null
}
/workflows/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all workflows.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all workflows in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{cfd41ae7-978f-4fad-ac04-ed7ca9e3e71a}",
"{ea9ea008-85ae-4f96-a133-86d1ad40d5e2}"
],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/workflows/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all workflows.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all workflows in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "WorkFlowConstructEx:#AutoMate.Communications.Server",
"ID": "{2c5cc423-04fd-4799-bc2a-7d3508cb2168}",
"Name": "test1",
"ParentID": "{589D12C2-1282-4466-B7E3-FE547509AF31}",
"Path": "\\WORKFLOWS",
"Type": 3,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452198069587)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452198065150)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1452198069587)\/",
"Items": [
{
"__type": "WorkFlowItemConstruct:#AutoMate.Constructs.v10",
"ID": "{e98d8d8d-2a7f-43b3-a567-5f6f7d38a32b}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 47,
"AgentID": "{CC3AD52F-C1DC-4d24-B6BE-32467159C86C}",
"ConstructID": "{cfb0110c-37f8-40d4-91f2-75a5632846e3}",
"ConstructType": 2,
"Enabled": true,
"Height": 12,
"Label": "",
"UseLabel": false,
"Width": 12,
"WorkflowID": "{2c5cc423-04fd-4799-bc2a-7d3508cb2168}",
"X": 75,
"Y": 13
}
],
"LinkType": 2,
"Links": [],
"Triggers": [],
"Variables": [],
"ZoomFactor": 100,
"DurationInSeconds": 0,
"Reactive": false,
"Scheduled": false
},
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
},
{
"ID": "{CC3AD52F-C1DC-4d24-B6BE-32467159C86C}",
"Name": "Default Agent"
},
{
"ID": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"Name": "Server"
}
]
}
/workflows/create [POST]

Description:Creates a new workflow.
Body
Description:JSON representation of the workflow.
Example:
{
"ID":"{319fb475-94c9-4902-9eee-d5b349e792a1}",
"Name":"",
"ParentID":"",
"Path": "\\WORKFLOWS",
"Type":3,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437426949846)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437426949846)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437426949846)\/",
"Items":[],
"LinkType":2,
"Links":[],
"Triggers":[],
"Variables":[],
"ZoomFactor":100
}
/workflows/{id}/get [GET]

Description:Gets the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow to fetch.
Results
Description:JSON representation of the workflow.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "WorkFlowConstruct:#AutoMate.Constructs.v10",
"ID": "{2c5cc423-04fd-4799-bc2a-7d3508cb2168}",
"Name": "test1",
"ParentID": "{589D12C2-1282-4466-B7E3-FE547509AF31}",
"Path": "",
"Type": 3,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452198069587)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452198065150)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1452198069587)\/",
"Items": [
{
"__type": "WorkFlowItemConstruct:#AutoMate.Constructs.v10",
"ID": "{e98d8d8d-2a7f-43b3-a567-5f6f7d38a32b}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 47,
"AgentID": "{CC3AD52F-C1DC-4d24-B6BE-32467159C86C}",
"ConstructID": "{cfb0110c-37f8-40d4-91f2-75a5632846e3}",
"ConstructType": 2,
"Enabled": true,
"Height": 12,
"Label": "",
"UseLabel": false,
"Width": 12,
"WorkflowID": "{2c5cc423-04fd-4799-bc2a-7d3508cb2168}",
"X": 75,
"Y": 13
}
],
"LinkType": 2,
"Links": [],
"Triggers": [],
"Variables": [],
"ZoomFactor": 100
},
"Paging": null,
"LookupTable": null
}
/workflows/{id}/update [POST]

Description:Updates the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow to update.
Body
Description:JSON representation of the workflow.
Example:
{"__type":"WorkFlowConstruct:#AutoMate.Constructs.v10",
"ID":"{319fb475-94c9-4902-9eee-d5b349e792a1}",
"Name":"",
"ParentID":"",
"Type":3,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437426949846)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437426949846)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437426949846)\/",
"Items":[],
"LinkType":2,
"Links":[],
"Triggers":[],
"Variables":[],
"ZoomFactor":100}
/workflows/{id}/delete [POST]

Description:Deletes the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow to delete.
/workflows/{id}/run [POST]

Description:Runs the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow to run.
Results
Description:JSON representation of the InstanceIDs.
Example:
{
"Result": "success",
"Info": null,
"Data": "{bc9b1628-dbbf-489a-b4a6-89d97e195b5c}",
"Paging": null,
"LookupTable": null
}
/workflows/{id}/enable [POST]

Description:Enables the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow to enable.
/workflows/{id}/disable [POST]

Description:Disables the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow to disable.
/workflows/{id}/resume [POST]

Description:Resume the specified failed workflow.
ParametervalueDescription
idstringThe ID of the workflow.
/workflows/{id}/properties/get [GET]

Description:Gets the properties of the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow.
Results
Description:JSON representation of the workflow properties.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"WorkflowPropertiesConstruct:#AutoMate.Constructs.v10",
"ID":"{b136c15e-a86e-4cb5-bc09-593d9bc126b6}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":23,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437596168093)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437596168093)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437596168093)\/",
"Constants":[],
"DefaultAgentID":"",
"DefaultAgentPropertiesInheritancePath":"",
"DefaultAgentPropertiesSpecified":false,
"DisableOnFailure":false,
"ErrorNotificationPropertiesInheritancePath":"",
"ErrorNotificationPropertiesSpecified":false,
"ErrorNotifyEmailFromAddress":"",
"ErrorNotifyEmailToAddress":"",
"ErrorRunTaskName":"",
"ResumeFromFailure":false,
"Timeout":0,
"TimeoutEnabled":false,
"TimeoutPropertiesInheritancePath":"",
"TimeoutPropertiesSpecified":false,
"TimeoutUnit":1},
"Paging": null,
"LookupTable": null}
/workflows/{id}/properties/update [POST]

Description:Updates the specified workflow's properties.
ParametervalueDescription
idstringThe ID of the workflow.
Body
Description:JSON representation of the workflow properties.
Example:
{"ID":"{b136c15e-a86e-4cb5-bc09-593d9bc126b6}",
"Name":"",
"ParentID":"",
"Type":23,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437596168093)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437596168093)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437596168093)\/",
"Constants":[],
"DefaultAgentID":"",
"DefaultAgentPropertiesInheritancePath":"",
"DefaultAgentPropertiesSpecified":false,
"DisableOnFailure":false,
"ErrorNotificationPropertiesInheritancePath":"",
"ErrorNotificationPropertiesSpecified":false,
"ErrorNotifyEmailFromAddress":"",
"ErrorNotifyEmailToAddress":"",
"ErrorRunTaskName":"",
"ResumeFromFailure":false,
"Timeout":0,
"TimeoutEnabled":false,
"TimeoutPropertiesInheritancePath":"",
"TimeoutPropertiesSpecified":false,
"TimeoutUnit":1}
/workflows/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow.
Results
Description:A list of IDs for all permissions for the specified workflow.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/workflows/{id}/permissions/create [POST]

Description:Creates a new permission for the specified workflow.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/workflows/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null}
/workflows/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/workflows/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the permission.
/workflows/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow.
Results
Description:A list of IDs for all audit events for the specified workflow.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/workflows/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID": "{0ba85f5a-a44c-478f-a6cc-f22d64a5565f}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 16,
"Data": null,
"EventDateTime": "\/Date(1452548101863)\/",
"EventText": "Workflow 'test' properties modified by user 'administrator'",
"EventType": 1007,
"PrimaryConstructID": "{cfd41ae7-978f-4fad-ac04-ed7ca9e3e71a}",
"RowIndex": 233,
"SessionID": "{22d7348b-5803-4fe4-9d96-62ed7d35408c}",
"StatusType": 0,
"UserID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}"
},
"Paging": null,
"LookupTable": null
}
/workflows/{id}/execution_events/index [GET]

Description:Gets a list of the IDs of all execution events for the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow.
Results
Description:A list of IDs for all execution events for the specified workflow.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/workflows/{id}/execution_events/{id2}/get [GET]

Description:Gets the specified execution event.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the execution event.
Results
Description:JSON representation of the execution event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ExecutionEventConstruct:#AutoMate.Constructs.v10",
"ID": "{00041730-3c61-4b30-b739-037f84652a8d}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 17,
"AgentID": "",
"ConstructID": "{99e6f391-2410-4bc7-95f8-761ce616b5f5}",
"EndDateTime": "\/Date(1452907548267)\/",
"InstanceID": "d77ac125-2ba0-4503-946e-40aa28f2ef3b",
"ResultCode": 12,
"ResultText": "Workflow 'test' running...",
"RowIndex": 8466,
"StartDateTime": "\/Date(1452907548267)\/",
"TransactionID": "1cc64089-f68c-4d53-8f66-3b8a5cfb7ad2",
"UserID": "",
"WorkflowInstanceID": "d77ac125-2ba0-4503-946e-40aa28f2ef3b"
},
"Paging": null,
"LookupTable": null
}
/workflows/{id}/instances/index [GET]

Description:Gets a list of the IDs of all instances of the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow.
Results
Description:A list of IDs for all instances of the specified workflow.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/workflows/{id}/running_instances/index [GET]

Description:Gets a list of the IDs of all running instances of the specified workflow.
ParametervalueDescription
idstringThe ID of the workflow.
Results
Description:A list of IDs for all running instances of the specified workflow.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/workflows/{id}/running_instances/{id2}/stop [POST]

Description:Stops the specified instance.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the running instance.
/workflows/{id}/running_instances/{id2}/pause [POST]

Description:Pauses the specified instance.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the running instance.
/workflows/{id}/running_instances/{id2}/resume [POST]

Description:Resumes the specified instance.
ParametervalueDescription
idstringThe ID of the workflow.
id2stringThe ID of the running instance.
/workflows/{id}/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID} [GET]

Description:Gets a list workflows contain specified workflow in the system.
ParametervalueDescription
idstringThe ID of the workflow.
Optional ParametervalueDescription
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on Name field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
Results
Description:A list of workflows contain specified workflow in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "DependentItem:#AutoMate.Communications.Server",
"Enabled":true,
"ID": "{24de3feb-3c32-4481-a681-be8cfd8363f0}",
"Name": "WorkFlowTest",
"NextRun": "\/Date(-62135568000000-0800)\/",
"Path": "",
"Start": "\/Date(-2208988800000)\/"
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/tasks/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all tasks.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all tasks in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{7be95f7c-06b4-400a-a1b2-a0885254c202}",
"{c07d5c84-6033-4fbf-ae4d-abb61ef6391b}",
"{cfb0110c-37f8-40d4-91f2-75a5632846e3}"
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": null
}
/tasks/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all tasks.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all tasks in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "TaskConstructEx:#AutoMate.Communications.Server",
"ID": "{4f62511d-9d35-4de4-adea-c360dc751302}",
"Name": "rrr",
"ParentID": "{E893A7FD-2758-4315-9181-93F8728332E5}",
"Path": "\\TASKS",
"Type": 2,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452544952183)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(1452618803723)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452552032653)\/",
"Notes": "",
"Removed": false,
"ResultCode": 1,
"ResultText": "Task 'rrr' running on agent 'WIN-4U2FKS6FK25' completed successfully.",
"StartedOn": "\/Date(1452618696140)\/",
"Version": 2,
"VersionDate": "\/Date(1452552032653)\/",
"AML": "XML representation of the Task.",
"TaskProperties": null,
"DurationInSeconds": 108
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
}
]
}
/tasks/create [POST]

Description:Creates a new task.
Body
Description:JSON representation of the task.
Example:
{"ID":"{9070fa93-005c-4d0c-845c-0f5cf656906e}",
"Name":"",
"ParentID":"",
"Type":2,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689729307)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689729307)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689729307)\/",
"AML":"",
"TaskProperties":null}
/tasks/{id}/get [GET]

Description:Gets the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:JSON representation of the task.
Example:
{
"Result":"success",
"Info":null,
"Data":
{"__type":"TaskConstruct:#AutoMate.Constructs.v10",
"ID":"{9070fa93-005c-4d0c-845c-0f5cf656906e}",
"Name":"",
"ParentID":"",
"Type":2,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689729307)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689729307)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689729307)\/",
"AML":"",
"TaskProperties":null
},
"Paging": null,
"LookupTable": null
}
/tasks/{id}/update [POST]

Description:Updates the specified task.
ParametervalueDescription
idstringThe ID of the task.
Body
Description:JSON representation of the task.
Example:
{"ID":"{9070fa93-005c-4d0c-845c-0f5cf656906e}",
"Name":"",
"ParentID":"",
"Type":2,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689729307)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689729307)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689729307)\/",
"AML":"",
"TaskProperties":null}
/tasks/{id}/delete [POST]

Description:Deletes the specified task.
ParametervalueDescription
idstringThe ID of the task.
/tasks/{id}/run?agent_id={AgentID}&agent_group_id={AgentGroupID} [POST]

Description:Runs the specified task.
ParametervalueDescription
idstringThe ID of the task.
Optional ParametervalueDescription
agent_idstringThe ID of the Agent on which specified task will run.
agent_group_idstringThe ID of the Agent Group on which specified task will run. If both Agent and Agent Group are provided, Agent will be used.
Results
Description:JSON representation of the InstanceIDs.
Example:
{
"Result": "success",
"Info": null,
"Data": "{bc9b1628-dbbf-489a-b4a6-89d97e195b5c}",
"Paging": null,
"LookupTable": null
}
/tasks/{id}/enable [POST]

Description:Enables the specified task.
ParametervalueDescription
idstringThe ID of the task to enable.
/tasks/{id}/disable [POST]

Description:Disables the specified task.
ParametervalueDescription
idstringThe ID of the task to disable.
/tasks/{id}/properties/get [GET]

Description:Gets the properties of the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:JSON representation of the task properties.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "TaskPropertiesConstruct:#AutoMate.Constructs.v10",
"ID": "d28ab50c-c5d0-4063-ad9a-e910cfca9fe1",
"Name": "",
"ParentID": "{4f62511d-9d35-4de4-adea-c360dc751302}",
"Path": "",
"Type": 25,
"CompletionState": 0,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452622598233)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1404237501253)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1452622598233)\/",
"CanStopTask": false,
"ConcurrencyType": 1,
"Constants": [],
"ErrorNotificationPropertiesInheritancePath": "",
"ErrorNotificationPropertiesSpecified": false,
"ErrorNotifyEmailFromAddress": "",
"ErrorNotifyEmailToAddress": "",
"ErrorRunTaskName": "",
"ExecutionPropertiesInheritancePath": "",
"ExecutionPropertiesSpecified": false,
"IsolationOverride": 0,
"IsolationPropertiesInheritancePath": "",
"IsolationPropertiesSpecified": false,
"LogonDomain": "",
"LogonPassword": "",
"LogonPropertiesInheritancePath": "",
"LogonPropertiesSpecified": true,
"LogonUsername": "",
"MaxTaskInstances": 1,
"OnLocked": 1,
"OnLogged": 1,
"OnLogoff": 4,
"PriorityAction": 1,
"PriorityPropertiesInheritancePath": "",
"PriorityPropertiesSpecified": false,
"PriorityWaitTimeOut": 0,
"RunAsElevated": false,
"TaskExecutionSpeed": 0,
"TaskFailureAction": 2,
"TaskTimeout": -1,
"UseLogonDefault": true
},
"Paging": null,
"LookupTable": null
}
/tasks/{id}/properties/update [POST]

Description:Updates the specified task's properties.
ParametervalueDescription
idstringThe ID of the task.
Body
Description:JSON representation of the task properties.
Example:
{
"ID": "d28ab50c-c5d0-4063-ad9a-e910cfca9fe1",
"Name": "",
"ParentID": "{4f62511d-9d35-4de4-adea-c360dc751302}",
"Path": "",
"Type": 25,
"CompletionState": 0,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452622598233)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1404237501253)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1452622598233)\/",
"CanStopTask": false,
"ConcurrencyType": 1,
"Constants": [],
"ErrorNotificationPropertiesInheritancePath": "",
"ErrorNotificationPropertiesSpecified": false,
"ErrorNotifyEmailFromAddress": "",
"ErrorNotifyEmailToAddress": "",
"ErrorRunTaskName": "",
"ExecutionPropertiesInheritancePath": "",
"ExecutionPropertiesSpecified": false,
"IsolationOverride": 0,
"IsolationPropertiesInheritancePath": "",
"IsolationPropertiesSpecified": false,
"LogonDomain": "",
"LogonPassword": "",
"LogonPropertiesInheritancePath": "",
"LogonPropertiesSpecified": true,
"LogonUsername": "",
"MaxTaskInstances": 1,
"OnLocked": 1,
"OnLogged": 1,
"OnLogoff": 4,
"PriorityAction": 1,
"PriorityPropertiesInheritancePath": "",
"PriorityPropertiesSpecified": false,
"PriorityWaitTimeOut": 0,
"RunAsElevated": false,
"TaskExecutionSpeed": 0,
"TaskFailureAction": 2,
"TaskTimeout": -1,
"UseLogonDefault": true
}
/tasks/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:A list of IDs for all permissions for the specified task.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/tasks/{id}/permissions/create [POST]

Description:Creates a new permission for the specified task.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/tasks/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{
"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false
},
"Paging": null,
"LookupTable": null
}
/tasks/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/tasks/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the permission.
/tasks/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:A list of IDs for all audit events for the specified task.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/tasks/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
"Paging": null,
"LookupTable": null
}
/tasks/{id}/execution_events/index [GET]

Description:Gets a list of the IDs of all execution events for the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:A list of IDs for all execution events for the specified task.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/tasks/{id}/execution_events/{id2}/get [GET]

Description:Gets the specified execution event.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the execution event.
Results
Description:JSON representation of the execution event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ExecutionEventConstruct:#AutoMate.Constructs.v10",
"ID": "{000f1858-8575-4176-9407-52977c1a9660}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 17,
"AgentID": "732bb3ec-14a4-4d0e-af3b-cbda7a49e5a7",
"ConstructID": "{f490a51d-5e37-4500-b206-fa5131a66700}",
"EndDateTime": "\/Date(1461208583283)\/",
"InstanceID": "98a90bd4-a080-4e37-a6d5-bfe332781691",
"ResultCode": 2,
"ResultText": "Task 'test' running on agent 'VMGAWAKIAN' failed because: the agent is not connected",
"RowIndex": 2378,
"StartDateTime": "\/Date(1461208583283)\/",
"TransactionID": "bc7d2ec3-cb5e-4016-ad6d-3e36f140eecb",
"UserID": "",
"WorkflowInstanceID": "7c62cda2-bd11-4d06-8995-3c96838dba87"
},
"Paging": null,
"LookupTable": null
}
/tasks/{id}/instances/index [GET]

Description:Gets a list of the IDs of all instances of the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:A list of IDs for all instances of the specified task.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/tasks/{id}/running_instances/index [GET]

Description:Gets a list of the IDs of all running instances of the specified task.
ParametervalueDescription
idstringThe ID of the task.
Results
Description:A list of IDs for all running instances of the specified task.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/tasks/{id}/running_instances/{id2}/stop [POST]

Description:Stops the specified instance.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the running instance.
/tasks/{id}/running_instances/{id2}/pause [POST]

Description:Pauses the specified instance.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the running instance.
/tasks/{id}/running_instances/{id2}/resume [POST]

Description:Resumes the specified instance.
ParametervalueDescription
idstringThe ID of the task.
id2stringThe ID of the running instance.
/tasks/{id}/workflows/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID} [GET]

Description:Gets a list workflows contain specified task in the system.
ParametervalueDescription
idstringThe ID of the task.
Optional ParametervalueDescription
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on Name field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
Results
Description:A list of workflows contain specified task in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "DependentItem:#AutoMate.Communications.Server",
"Enabled": true,
"ID": "{c3a07206-3dbf-4ed6-ba7d-eb0dee62f427}",
"Name": "Process",
"NextRun": "\/Date(-62135568000000-0800)\/",
"Path": "\\WORKFLOWS",
"Start": "\/Date(1454603074843)\/"
},
{
"__type": "DependentItem:#AutoMate.Communications.Server",
"Enabled": true,
"ID": "{2c5cc423-04fd-4799-bc2a-7d3508cb2168}",
"Name": "test22",
"NextRun": "\/Date(-62135568000000-0800)\/",
"Path": "\\WORKFLOWS",
"Start": "\/Date(1452810809610)\/"
}
],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/processes/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all processes.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all processes in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{b5d56008-db56-48eb-a7ce-b50d98450b78}"
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/processes/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all processes.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all processes in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "ProcessConstructEx:#AutoMate.Communications.Server",
"ID": "{b5d56008-db56-48eb-a7ce-b50d98450b78}",
"Name": "abcd",
"ParentID": "{8E19BEB0-9625-4810-AF6E-5EAD7069E83C}",
"Path": "\\PROCESSES",
"Type": 40,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1453138207400)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1453138221237)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 2,
"VersionDate": "\/Date(1453138221237)\/",
"CommandLine": "dir",
"EnvironmentVariables": "",
"RunProcessAs": 1,
"WorkingDirectory": "",
"DurationInSeconds": 0
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
}
]
}
/processes/create [POST]

Description:Creates a new process.
Body
Description:JSON representation of the process.
Example:
{"ID":"{1593845b-a4e0-4857-9bea-7e504a65f690}",
"Name":"",
"ParentID":"",
"Type":40,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689667590)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689667590)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689667590)\/",
"CommandLine":"",
"EnvironmentVariables":"",
"RunProcessAs":1,
"WorkingDirectory":""
}
/processes/{id}/get [GET]

Description:Gets the specified process.
ParametervalueDescription
idstringThe ID of the process.
Results
Description:JSON representation of the process.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ProcessConstruct:#AutoMate.Constructs.v10",
"ID": "{b5d56008-db56-48eb-a7ce-b50d98450b78}",
"Name": "abcd",
"ParentID": "{8E19BEB0-9625-4810-AF6E-5EAD7069E83C}",
"Path": "",
"Type": 40,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1453138207400)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1453138221237)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 2,
"VersionDate": "\/Date(1453138221237)\/",
"CommandLine": "dir",
"EnvironmentVariables": "",
"RunProcessAs": 1,
"WorkingDirectory": ""
},
"Paging": null,
"LookupTable": null
}
/processes/{id}/update [POST]

Description:Updates the specified process.
ParametervalueDescription
idstringThe ID of the process.
Body
Description:JSON representation of the process.
Example:
{"ID":"{1593845b-a4e0-4857-9bea-7e504a65f690}",
"Name":"",
"ParentID":"",
"Type":40,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689667590)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689667590)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689667590)\/",
"CommandLine":"",
"EnvironmentVariables":"",
"RunProcessAs":1,
"WorkingDirectory":""}
/processes/{id}/delete [POST]

Description:Deletes the specified process.
ParametervalueDescription
idstringThe ID of the process.
/processes/{id}/enable [POST]

Description:Enables the specified process.
ParametervalueDescription
idstringThe ID of the process to enable.
/processes/{id}/disable [POST]

Description:Disables the specified process.
ParametervalueDescription
idstringThe ID of the process to disable.
/processes/{id}/run?process_agent_id={ProcessAgentID}&agent_group_id={AgentGroupID} [POST]

Description:Runs the specified process.
ParametervalueDescription
idstringThe ID of the process.
Optional ParametervalueDescription
process_agent_idstringThe ID of the Process Agent on which specified task will run.
agent_group_idstringThe ID of the Agent Group on which specified task will run. If both Process Agent and Agent Group are provided, Process Agent will be used.
Results
Description:JSON representation of the InstanceIDs.
Example:
{
"Result": "success",
"Info": null,
"Data": "{bc9b1628-dbbf-489a-b4a6-89d97e195b5c}",
"Paging": null,
"LookupTable": null
}
/processes/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified process.
ParametervalueDescription
idstringThe ID of the process.
Results
Description:A list of IDs for all permissions for the specified process.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{64ff91b1-467c-4b1b-9c23-8b722d119d4a}",
"{a16f9c1a-7448-48e7-9b0d-86786bb5d1e0}"
],
"Paging": null,
"LookupTable": null
}
/processes/{id}/permissions/create [POST]

Description:Creates a new permission for the specified process.
ParametervalueDescription
idstringThe ID of the process.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/processes/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the process.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null
}
/processes/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the process.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/processes/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the process.
id2stringThe ID of the permission.
/processes/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified process.
ParametervalueDescription
idstringThe ID of the process.
Results
Description:A list of IDs for all audit events for the specified process.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{7a0ce546-232e-47ef-bebd-c589d7f69f3a}",
"{a6d757bd-2f19-4127-b754-381be82d4ffd}",
"{cdbeb1be-dc7e-42ea-a03f-7f06801988f7}",
"{d447a65c-ce07-4bec-9c68-8b46bd8612bc}"
],
"Paging": null,
"LookupTable": null
}
/processes/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the process.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID": "{7a0ce546-232e-47ef-bebd-c589d7f69f3a}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 16,
"Data": null,
"EventDateTime": "\/Date(1453138207420)\/",
"EventText": "Process 'New Process' created by user 'administrator'",
"EventType": 1900,
"PrimaryConstructID": "{b5d56008-db56-48eb-a7ce-b50d98450b78}",
"RowIndex": 347,
"SessionID": "{793a8733-44f4-4ad1-b453-652cd71cfdff}",
"StatusType": 0,
"UserID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}"
},
"Paging": null,
"LookupTable": null
}
/processes/{id}/execution_events/index [GET]

Description:Gets a list of the IDs of all execution events for the specified process.
ParametervalueDescription
idstringThe ID of the process.
Results
Description:A list of IDs for all execution events for the specified process.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/processes/{id}/execution_events/{id2}/get [GET]

Description:Gets the specified execution event.
ParametervalueDescription
idstringThe ID of the process.
id2stringThe ID of the execution event.
Results
Description:JSON representation of the execution event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ExecutionEventConstruct:#AutoMate.Constructs.v10",
"ID": "{000f1858-8575-4176-9407-52977c1a9660}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 17,
"AgentID": "732bb3ec-14a4-4d0e-af3b-cbda7a49e5a7",
"ConstructID": "{f490a51d-5e37-4500-b206-fa5131a66700}",
"EndDateTime": "\/Date(1461208583283)\/",
"InstanceID": "98a90bd4-a080-4e37-a6d5-bfe332781691",
"ResultCode": 2,
"ResultText": "Task 'test' running on agent 'VMGAWAKIAN' failed because: the agent is not connected",
"RowIndex": 2378,
"StartDateTime": "\/Date(1461208583283)\/",
"TransactionID": "bc7d2ec3-cb5e-4016-ad6d-3e36f140eecb",
"UserID": "",
"WorkflowInstanceID": "7c62cda2-bd11-4d06-8995-3c96838dba87"
},
"Paging": null,
"LookupTable": null
}
/processes/{id}/instances/index [GET]

Description:Gets a list of the IDs of all instances of the specified process.
ParametervalueDescription
idstringThe ID of the process.
Results
Description:A list of IDs for all instances of the specified process.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/processes/{id}/running_instances/index [GET]

Description:Gets a list of the IDs of all running instances of the specified process.
ParametervalueDescription
idstringThe ID of the process.
Results
Description:A list of IDs for all running instances of the specified process.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/processes/{id}/workflows/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID} [GET]

Description:Gets a list workflows contain specified Process in the system.
ParametervalueDescription
idstringThe ID of the workflow.
Optional ParametervalueDescription
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on Name field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
Results
Description:A list of workflows contain specified process in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "DependentItem:#AutoMate.Communications.Server",
"Enabled": true,
"ID": "{c3a07206-3dbf-4ed6-ba7d-eb0dee62f427}",
"Name": "Process",
"NextRun": "\/Date(-62135568000000-0800)\/",
"Path": "",
"Start": "\/Date(1454603074843)\/"
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/conditions/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all conditions.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all conditions in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{332a989a-e527-43fd-b5a5-086b34058413}"
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/conditions/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all conditions.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all conditions in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "ScheduleTriggerConstruct:#AutoMate.Constructs.v10",
"ID": "{332a989a-e527-43fd-b5a5-086b34058413}",
"Name": "test",
"ParentID": "{5B00CA35-3EFB-41ea-95C0-D8B50B9BFA9F}",
"Path": "\\CONDITIONS",
"Type": 4,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452121707717)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(1452555925220)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452555925183)\/",
"Notes": "",
"Removed": false,
"ResultCode": 1,
"ResultText": "",
"StartedOn": "\/Date(1452555925220)\/",
"Version": 17,
"VersionDate": "\/Date(1452555925193)\/",
"AssociatedTaskID": "",
"IgnoreExistingCondition": false,
"InstanceID": "",
"Timeout": 0,
"TimeoutUnit": 0,
"TriggerAfter": 1,
"TriggerType": 3,
"Wait": true,
"Day": [],
"End": "",
"Frequency": "1",
"HolidayList": [],
"LastLaunchDate": "",
"Measure": 0,
"Month": [],
"MonthInterval": 1,
"NextLaunchDate": "01\/12\/2016 15:45:21",
"OnTaskLate": 0,
"Possible": true,
"Reschedule": 0,
"ScheduleType": 4,
"StartTime": ""
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
}
]
}
/conditions/create [POST]

Description:Creates a new condition.
Body
Description:JSON representation of the condition.
Example:
{
"__type": "ScheduleTriggerConstruct:#AutoMate.Constructs.v10",
"ID":"{9b747387-833c-4ac9-a594-a89dc2dfa71e}",
"Name":"",
"ParentID":"",
"Path": "\\CONDITIONS",
"Type":4,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689835082)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689835082)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689835082)\/",
"AssociatedTaskID":"",
"IgnoreExistingCondition":false,
"InstanceID":"",
"Timeout":0,
"TimeoutUnit":0,
"TriggerAfter":1,
"TriggerType":3,
"Wait":true,
"Day":[],
"End":"",
"Frequency":"1",
"HolidayList":[],
"LastLaunchDate":"",
"Measure":0,
"Month":[],
"MonthInterval":1,
"NextLaunchDate":"",
"OnTaskLate":0,
"Possible":true,
"Reschedule":0,
"ScheduleType":4,
"StartTime":""}
/conditions/{id}/get [GET]

Description:Gets the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
Results
Description:JSON representation of the condition.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ScheduleTriggerConstruct:#AutoMate.Constructs.v10",
"ID": "{332a989a-e527-43fd-b5a5-086b34058413}",
"Name": "test",
"ParentID": "{5B00CA35-3EFB-41ea-95C0-D8B50B9BFA9F}",
"Path": "",
"Type": 4,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452121707717)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(1452555925220)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452555925183)\/",
"Notes": "",
"Removed": false,
"ResultCode": 1,
"ResultText": "",
"StartedOn": "\/Date(1452555925220)\/",
"Version": 17,
"VersionDate": "\/Date(1452555925193)\/",
"AssociatedTaskID": "",
"IgnoreExistingCondition": false,
"InstanceID": "",
"Timeout": 0,
"TimeoutUnit": 0,
"TriggerAfter": 1,
"TriggerType": 3,
"Wait": true,
"Day": [],
"End": "",
"Frequency": "1",
"HolidayList": [],
"LastLaunchDate": "",
"Measure": 0,
"Month": [],
"MonthInterval": 1,
"NextLaunchDate": "01\/12\/2016 15:45:21",
"OnTaskLate": 0,
"Possible": true,
"Reschedule": 0,
"ScheduleType": 4,
"StartTime": ""
},
"Paging": null,
"LookupTable": null
}
/conditions/{id}/update [POST]

Description:Updates the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
Body
Description:JSON representation of the condition.
Example:
{
"__type": "ScheduleTriggerConstruct:#AutoMate.Constructs.v10",
"ID":"{9b747387-833c-4ac9-a594-a89dc2dfa71e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":4,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437689835082)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437689835082)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437689835082)\/",
"AssociatedTaskID":"",
"IgnoreExistingCondition":false,
"InstanceID":"",
"Timeout":0,
"TimeoutUnit":0,
"TriggerAfter":1,
"TriggerType":3,
"Wait":true,
"Day":[],
"End":"",
"Frequency":"1",
"HolidayList":[],
"LastLaunchDate":"",
"Measure":0,
"Month":[],
"MonthInterval":1,
"NextLaunchDate":"",
"OnTaskLate":0,
"Possible":true,
"Reschedule":0,
"ScheduleType":4,
"StartTime":""
}
/conditions/{id}/delete [POST]

Description:Deletes the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
/conditions/{id}/enable [POST]

Description:Enables the specified condition.
ParametervalueDescription
idstringThe ID of the condition to enable.
/conditions/{id}/disable [POST]

Description:Disables the specified condition.
ParametervalueDescription
idstringThe ID of the condition to disable.
/conditions/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
Results
Description:A list of IDs for all permissions for the specified condition.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{d09c74bb-10e3-4f61-89f6-d5e962264d8d}"
],
"Paging": null,
"LookupTable": null
}
/conditions/{id}/permissions/create [POST]

Description:Creates a new permission for the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
Results
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/conditions/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the condition.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",

"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null
}
/conditions/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the condition.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/conditions/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the condition.
id2stringThe ID of the permission.
/conditions/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
Results
Description:A list of IDs for all audit events for the specified condition.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/conditions/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the condition.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{
"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
"Paging": null,
"LookupTable": null
}
/conditions/{id}/execution_events/index [GET]

Description:Gets a list of the IDs of all execution events for the specified condition.
ParametervalueDescription
idstringThe ID of the condition.
Results
Description:A list of IDs for all execution events for the specified condition.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/conditions/{id}/execution_events/{id2}/get [GET]

Description:Gets the specified execution event.
ParametervalueDescription
idstringThe ID of the condition.
id2stringThe ID of the execution event.
Results
Description:JSON representation of the execution event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ExecutionEventConstruct:#AutoMate.Constructs.v10",
"ID": "{000f1858-8575-4176-9407-52977c1a9660}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 17,
"AgentID": "732bb3ec-14a4-4d0e-af3b-cbda7a49e5a7",
"ConstructID": "{f490a51d-5e37-4500-b206-fa5131a66700}",
"EndDateTime": "\/Date(1461208583283)\/",
"InstanceID": "98a90bd4-a080-4e37-a6d5-bfe332781691",
"ResultCode": 2,
"ResultText": "Task 'test' running on agent 'VMGAWAKIAN' failed because: the agent is not connected",
"RowIndex": 2378,
"StartDateTime": "\/Date(1461208583283)\/",
"TransactionID": "bc7d2ec3-cb5e-4016-ad6d-3e36f140eecb",
"UserID": "",
"WorkflowInstanceID": "7c62cda2-bd11-4d06-8995-3c96838dba87"
},
"Paging": null,
"LookupTable": null
}
/conditions/{id}/workflows/list?sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize}&folder_id={FolderID} [GET]

Description:Gets a list workflows contain specified condition in the system.
ParametervalueDescription
idstringThe ID of the condition.
Optional ParametervalueDescription
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on Name field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
Results
Description:A list of workflows contain specified condition in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "DependentItem:#AutoMate.Communications.Server",
"Enabled": true,
"ID": "{e2c6de5e-7403-4ccf-b548-c6fe7a8c0b16}",
"Name": "scheduleworkflow",
"NextRun": "\/Date(1457168218000)\/",
"Path": "\\WORKFLOWS",
"Start": "\/Date(1457110618137)\/"
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/folders/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all folders.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all folders in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{708e85e7-d25a-46b7-944e-3a3f9f9845d6}",
"{b6d762fc-36a5-4702-a2fa-6872af607135}",
"{e94cda96-b6bc-4cd1-9d58-a2b564f1dcd2}"
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": null
}
/folders/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all folders.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all folders in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "FolderConstruct:#AutoMate.Constructs.v10",
"ID": "{708e85e7-d25a-46b7-944e-3a3f9f9845d6}",
"Name": "Samples",
"ParentID": "{E893A7FD-2758-4315-9181-93F8728332E5}",
"Path": "\\TASKS",
"Type": 1,
"CompletionState": 2,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1451932628000)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1451932627977)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1451932628000)\/"
},
{
"__type": "FolderConstruct:#AutoMate.Constructs.v10",
"ID": "{b6d762fc-36a5-4702-a2fa-6872af607135}",
"Name": "Samples",
"ParentID": "{589D12C2-1282-4466-B7E3-FE547509AF31}",
"Path": "\\WORKFLOWS",
"Type": 1,
"CompletionState": 2,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1451932628043)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1451932628043)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1451932628043)\/"
},
{
"__type": "FolderConstruct:#AutoMate.Constructs.v10",
"ID": "{e94cda96-b6bc-4cd1-9d58-a2b564f1dcd2}",
"Name": "New Folder",
"ParentID": "{5B00CA35-3EFB-41ea-95C0-D8B50B9BFA9F}",
"Path": "\\CONDITIONS",
"Type": 1,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452121701043)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452121700987)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1452121701043)\/"
}
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": [
{
"ID": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"Name": "Server"
},
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
}
]
}
/folders/create [POST]

Description:Creates a new folder.
Body
Description:JSON representation of the folder.
Example:
{"ID":"{d9e0d424-6556-448a-987a-e36c1562c618}",
"Name":"",
"ParentID":"",
"Type":1,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758138344)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758138344)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758138344)\/"}}
/folders/{id}/get [GET]

Description:Gets the specified folder.
ParametervalueDescription
idstringThe ID of the folder.
Results
Description:JSON representation of the folder.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "FolderConstruct:#AutoMate.Constructs.v10",
"ID": "{b6d762fc-36a5-4702-a2fa-6872af607135}",
"Name": "Samples",
"ParentID": "{589D12C2-1282-4466-B7E3-FE547509AF31}",
"Path": "\\WORKFLOW_ROOT",
"Type": 1,
"CompletionState": 2,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1451932628043)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1451932628043)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1451932628043)\/"
},
"Paging": null,
"LookupTable": null
}
/folders/{id}/update [POST]

Description:Updates the specified folder.
ParametervalueDescription
idstringThe ID of the folder.
Body
Description:JSON representation of the folder.
Example:
{
"ID":"{d9e0d424-6556-448a-987a-e36c1562c618}",
"Name":"",
"ParentID":"",
"Type":1,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758138344)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758138344)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758138344)\/"
}
/folders/{id}/delete [POST]

Description:Deletes the specified folder.
ParametervalueDescription
idstringThe ID of the folder.
/folders/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified folder.
ParametervalueDescription
idstringThe ID of the folder.
Results
Description:A list of IDs for all permissions for the specified folder.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/folders/{id}/permissions/create [POST]

Description:Creates a new permission for the specified folder.
ParametervalueDescription
idstringThe ID of the folder.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/folders/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the folder.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
Paging": null,
"LookupTable": null
}
/folders/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the folder.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/folders/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the folder.
id2stringThe ID of the permission.
/folders/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified folder.
ParametervalueDescription
idstringThe ID of the folder.
Results
Description:A list of IDs for all audit events for the specified folder.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
Paging": null,
"LookupTable": null
}
/folders/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the folder.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
Paging": null,
"LookupTable": null
}
/agents/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all agents.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all agents in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"6c7f52be-715c-4eb7-ba6a-6873c28c46d1"
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/agents/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all agents.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all agents in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "AgentConstructEx:#AutoMate.Communications.Server",
"ID": "bcda524d-c951-4536-900d-c279d32de191",
"Name": "WIN2012",
"ParentID": "{A5B6AF52-5DAC-45a0-8B26-602E3E3BBC59}",
"Path": "\\TASKAGENTS",
"Type": 8,
"CompletionState": 0,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1464180533457)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1464180533453)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1464180533457)\/",
"AgentType": 1,
"AgentUpgradeStep": 1,
"Blocked": false,
"IDWhenLastConnected": "bcda524d-c951-4536-900d-c279d32de191",
"MachineNameWhenLastConnected": "",
"SubstitutionID": "",
"VersionWhenLastConnected": "",
"ActiveInstances": 41,
"CpuPercentage": 0,
"Handles": 882,
"Online": true,
"PrivateMemory": 31820,
"Threads": 52,
"TriggersMonitored": 35
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
}
]
}
/agents/create [POST]

Description:Creates a new agent.
Body
Description:JSON representation of the agent.
Example:
{
"ID":"{8272270b-b077-411a-baa1-bd440390f6aa}",
"Name":"",
"ParentID":"",
"Type":8,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758171066)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758171066)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758171066)\/",
"AgentType":0,
"AgentUpgradeStep":1,
"Blocked":false,
"IDWhenLastConnected":"",
"MachineNameWhenLastConnected":"",
"SubstitutionID":"",
"VersionWhenLastConnected":""
}
/agents/{id}/get [GET]

Description:Gets the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
Results
Description:JSON representation of the agent.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "AgentConstruct:#AutoMate.Constructs.v10",
"ID": "6c7f52be-715c-4eb7-ba6a-6873c28c46d1",
"Name": "WIN-4U2FKS6FK25",
"ParentID": "{A5B6AF52-5DAC-45a0-8B26-602E3E3BBC59}",
"Path": "",
"Type": 8,
"CompletionState": 0,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1451932642733)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452003803917)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 9,
"VersionDate": "\/Date(1452003803917)\/",
"AgentType": 1,
"AgentUpgradeStep": 1,
"Blocked": false,
"IDWhenLastConnected": "6c7f52be-715c-4eb7-ba6a-6873c28c46d1",
"MachineNameWhenLastConnected": "",
"SubstitutionID": "",
"VersionWhenLastConnected": ""
},
"Paging": null,
"LookupTable": null
}
/agents/{id}/update [POST]

Description:Updates the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
Body
Description:JSON representation of the agent.
Example:
{"ID":"{8272270b-b077-411a-baa1-bd440390f6aa}",
"Name":"",
"ParentID":"",
"Type":8,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758171066)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758171066)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758171066)\/",
"AgentType":0,
"AgentUpgradeStep":1,
"Blocked":false,
"IDWhenLastConnected":"",
"MachineNameWhenLastConnected":"",
"SubstitutionID":"",
"VersionWhenLastConnected":""}}
/agents/{id}/delete [POST]

Description:Deletes the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
/agents/{id}/enable [POST]

Description:Enables the specified agent.
ParametervalueDescription
idstringThe ID of the agent to enable.
/agents/{id}/disable [POST]

Description:Disables the specified agent.
ParametervalueDescription
idstringThe ID of the agent to disable.
/agents/{id}/properties/get [GET]

Description:Gets the properties of the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
Results
Description:JSON representation of the agent properties.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "AgentPropertiesConstruct:#AutoMate.Constructs.v10",
"ID": "346d9b8b-3c90-457b-b990-4c7bb1247b04",
"Name": "",
"ParentID": "6c7f52be-715c-4eb7-ba6a-6873c28c46d1",
"Path": "",
"Type": 24,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501117)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452702904073)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 1,
"VersionDate": "\/Date(1452702904073)\/",
"AgentPort": 9600,
"AgentUpgradeTimeout": 2,
"ConfigurationConstruct": {
"ID": "{2bf78909-26fa-4e91-a2e9-cb1583e6b34e}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 64,
"EmailServer": {
"AuthenticationType": "",
"Certificate": "",
"DisableChunkingandPipelining": false,
"DomainName": "",
"EmailAddress": "",
"EmailProtocol": 0,
"IgnoreServerCertificate": false,
"Impersonate": false,
"Passphrase": "",
"Password": "",
"Port": 0,
"Protocol": 0,
"ProxyPassword": "",
"ProxyPort": 0,
"ProxyServer": "",
"ProxyType": 0,
"ProxyUsername": "",
"Security": 0,
"Server": "",
"Timeout": 0,
"Url": "",
"UseAutoDiscovery": false,
"UserAgent": "",
"UserName": "",
"Version": 0
},
"NotificationType": 0
},
"Constants": [],
"DefaultRunAsDomain": "",
"DefaultRunAsPassword": "",
"DefaultRunAsUserName": "",
"DefaultUserPropertiesInheritancePath": "",
"DefaultUserPropertiesSpecified": true,
"DisableForegroundTimeout": true,
"EnableSAS": false,
"EventMonitorAutoMateStartMode": 0,
"IndicatorsPropertiesInheritancePath": "",
"IndicatorsPropertiesSpecified": false,
"InterruptHotkey": "Ctrl+Alt+PageUp",
"LoadManagementPropertiesInheritancePath": "",
"LoadManagementPropertiesSpecified": true,
"LogonScript": "{ALT}u{USERNAME}{ALT}p{PASSWORD}{ENTER}",
"LogonScriptKeystrokeDelay": 200,
"LowestCompletionState": 0,
"MIBLocation": "C:\\WINDOWS\\system32",
"MaxRunningTasks": 50,
"ProxyHost": "",
"ProxyPassword": "",
"ProxyPort": 1028,
"ProxyPropertiesInheritancePath": "",
"ProxyPropertiesSpecified": false,
"ProxyUserID": "",
"RunningTaskOnTop": true,
"RunningTaskWindowTransparent": true,
"RunningTaskWindowWithTitleBar": false,
"SMTPPassword": "",
"SMTPPort": 25,
"SMTPPropertiesInheritancePath": "",
"SMTPPropertiesSpecified": false,
"SMTPServer": "",
"SMTPUser": "",
"SNMPPropertiesInheritancePath": "",
"SNMPPropertiesSpecified": false,
"SNMPTrapPort": 162,
"ShowRunningTaskWindow": true,
"ShowTrayIcon": 1,
"ShowTrayIconMenu": true,
"SocksType": 1,
"SqlConnectionConstants": [],
"StagingPropertiesInheritancePath": "",
"StagingPropertiesSpecified": false,
"SystemPropertiesInheritancePath": "",
"SystemPropertiesSpecified": true,
"TaskCacheFilePath": "C:\\ProgramData\\AutoMate\\AutoMate BPA Agent 10",
"TaskIsolation": 2,
"TaskIsolationPropertiesInheritancePath": "",
"TaskIsolationPropertiesSpecified": false,
"TaskTimeout": -1,
"TerminalServicesUser": "",
"UnlockScript": "{ALT}u{USERNAME}{ALT}p{PASSWORD}{ENTER}",
"UseInterruptHotkey": false,
"UseLowestCompletionState": false
},
"Paging": null,
"LookupTable": null
}
/agents/{id}/properties/update [POST]

Description:Updates the specified agent's properties.
ParametervalueDescription
idstringThe ID of the agent.
Body
Description:JSON representation of the agent properties.
Example:
{
"ID": "346d9b8b-3c90-457b-b990-4c7bb1247b04",
"Name": "",
"ParentID": "6c7f52be-715c-4eb7-ba6a-6873c28c46d1",
"Path": "",
"Type": 24,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501117)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452702904073)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 1,
"VersionDate": "\/Date(1452702904073)\/",
"AgentPort": 9600,
"AgentUpgradeTimeout": 2,
"ConfigurationConstruct": {
"ID": "{2bf78909-26fa-4e91-a2e9-cb1583e6b34e}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 64,
"EmailServer": {
"AuthenticationType": "",
"Certificate": "",
"DisableChunkingandPipelining": false,
"DomainName": "",
"EmailAddress": "",
"EmailProtocol": 0,
"IgnoreServerCertificate": false,
"Impersonate": false,
"Passphrase": "",
"Password": "",
"Port": 0,
"Protocol": 0,
"ProxyPassword": "",
"ProxyPort": 0,
"ProxyServer": "",
"ProxyType": 0,
"ProxyUsername": "",
"Security": 0,
"Server": "",
"Timeout": 0,
"Url": "",
"UseAutoDiscovery": false,
"UserAgent": "",
"UserName": "",
"Version": 0
},
"NotificationType": 0
},
"Constants": [],
"DefaultRunAsDomain": "",
"DefaultRunAsPassword": "",
"DefaultRunAsUserName": "",
"DefaultUserPropertiesInheritancePath": "",
"DefaultUserPropertiesSpecified": true,
"DisableForegroundTimeout": true,
"EnableSAS": false,
"EventMonitorAutoMateStartMode": 0,
"IndicatorsPropertiesInheritancePath": "",
"IndicatorsPropertiesSpecified": false,
"InterruptHotkey": "Ctrl+Alt+PageUp",
"LoadManagementPropertiesInheritancePath": "",
"LoadManagementPropertiesSpecified": true,
"LogonScript": "{ALT}u{USERNAME}{ALT}p{PASSWORD}{ENTER}",
"LogonScriptKeystrokeDelay": 200,
"LowestCompletionState": 0,
"MIBLocation": "C:\\WINDOWS\\system32",
"MaxRunningTasks": 50,
"ProxyHost": "",
"ProxyPassword": "",
"ProxyPort": 1028,
"ProxyPropertiesInheritancePath": "",
"ProxyPropertiesSpecified": false,
"ProxyUserID": "",
"RunningTaskOnTop": true,
"RunningTaskWindowTransparent": true,
"RunningTaskWindowWithTitleBar": false,
"SMTPPassword": "",
"SMTPPort": 25,
"SMTPPropertiesInheritancePath": "",
"SMTPPropertiesSpecified": false,
"SMTPServer": "",
"SMTPUser": "",
"SNMPPropertiesInheritancePath": "",
"SNMPPropertiesSpecified": false,
"SNMPTrapPort": 162,
"ShowRunningTaskWindow": true,
"ShowTrayIcon": 1,
"ShowTrayIconMenu": true,
"SocksType": 1,
"SqlConnectionConstants": [],
"StagingPropertiesInheritancePath": "",
"StagingPropertiesSpecified": false,
"SystemPropertiesInheritancePath": "",
"SystemPropertiesSpecified": true,
"TaskCacheFilePath": "C:\\ProgramData\\AutoMate\\AutoMate BPA Agent 10",
"TaskIsolation": 2,
"TaskIsolationPropertiesInheritancePath": "",
"TaskIsolationPropertiesSpecified": false,
"TaskTimeout": -1,
"TerminalServicesUser": "",
"UnlockScript": "{ALT}u{USERNAME}{ALT}p{PASSWORD}{ENTER}",
"UseInterruptHotkey": false,
"UseLowestCompletionState": false
}
/agents/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
Results
Description:A list of IDs for all permissions for the specified agent.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/agents/{id}/permissions/create [POST]

Description:Creates a new permission for the specified agent.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/agents/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the agent.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null
}
/agents/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the agent.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/agents/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the agent.
id2stringThe ID of the permission.
/agents/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
Results
Description:A list of IDs for all audit events for the specified agent.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/agents/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the agent.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
"Paging": null,
"LookupTable": null
}
/agents/{id}/execution_events/index [GET]

Description:Gets a list of the IDs of all execution events for the specified agent.
ParametervalueDescription
idstringThe ID of the agent.
Results
Description:A list of IDs for all execution events for the specified agent.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/agents/{id}/execution_events/{id2}/get [GET]

Description:Gets the specified execution event.
ParametervalueDescription
idstringThe ID of the agent.
id2stringThe ID of the execution event.
Results
Description:JSON representation of the execution event.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ExecutionEventConstruct:#AutoMate.Constructs.v10",
"ID": "{000f1858-8575-4176-9407-52977c1a9660}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 17,
"AgentID": "732bb3ec-14a4-4d0e-af3b-cbda7a49e5a7",
"ConstructID": "{f490a51d-5e37-4500-b206-fa5131a66700}",
"EndDateTime": "\/Date(1461208583283)\/",
"InstanceID": "98a90bd4-a080-4e37-a6d5-bfe332781691",
"ResultCode": 2,
"ResultText": "Task 'test' running on agent 'VMGAWAKIAN' failed because: the agent is not connected",
"RowIndex": 2378,
"StartDateTime": "\/Date(1461208583283)\/",
"TransactionID": "bc7d2ec3-cb5e-4016-ad6d-3e36f140eecb",
"UserID": "",
"WorkflowInstanceID": "7c62cda2-bd11-4d06-8995-3c96838dba87"
},
"Paging": null,
"LookupTable": null
}
/agents/{id}/conditions/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all condition of specified agent in the system. Only conditions assigned to an agent within a workflow will be included in the list for that agent. This includes when an agent is explicitly assigned by Agent Name or implicitly assigned as Default Agent.
ParametervalueDescription
idstringThe ID of the agent.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on Name field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all condition of specified agent in the system
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "EventLogTriggerConstruct:#AutoMate.Constructs.v10",
"ID": "{484a4ace-2c69-42be-bcda-5162f7c56102}",
"Name": "test",
"ParentID": "{5B00CA35-3EFB-41ea-95C0-D8B50B9BFA9F}",
"Path": "\\CONDITIONS",
"Type": 4,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1461192584940)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1461192590020)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 1,
"VersionDate": "\/Date(1461192590020)\/",
"AssociatedTaskID": "",
"Description": "Trigger when an event is logged in the log \"Application\". The event source must be \"All sources\". The event type must be \"Any\". The event category must be \"All Categories\". The event description must be \"test\". ",
"IgnoreExistingCondition": false,
"InstanceID": "",
"Timeout": 0,
"TimeoutUnit": 0,
"TriggerAfter": 1,
"TriggerType": 7,
"Wait": true,
"EventCategory": "All Categories",
"EventDescription": "test",
"EventSource": "All sources",
"EventType": 5,
"LogType": "Application"
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "Administrator"
}
]
}
/agents/online/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of IDs for all agents (both task agents and process agents) that are online.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Filter parametes are AgentID, IP , Name, SystemName, Type , Version. Here is an example of compound filter sets: "Name","contains","\"work\""|"IP","=","\"127.0.0.1\"".
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on AgentID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all online agents.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"fb008b29-fc8f-44d2-b4a6-06ab34fbbfe5"
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/agents/{id}/running_instances/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all running instances of specified agent in the system.
ParametervalueDescription
idstringThe ID of the agent.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on Name field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all running instances of specified agent in the system
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "29a5905a-536a-466c-8288-c3da909a50bb",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "ed030dc9-b45c-4e35-9046-e7822044faf9",
"AgentName": "WIN-4U2FKS6FK25",
"AgentPath": "\\TASKAGENTS",
"ConstructEnabled": true,
"ConstructID": "{7e427984-05cf-4552-b544-22cc94424192}",
"ConstructName": "test",
"ConstructPath": "\\TASKS",
"ConstructType": 2,
"CurrentFunctionName": "",
"CurrentStepDescription": "",
"CurrentStepNumber": 0,
"DurationInSeconds": 4,
"EndDateTime": "\/Date(1464211366750)\/",
"InstanceID": "29a5905a-536a-466c-8288-c3da909a50bb",
"LastChanged": "\/Date(-2208988800000)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": -1,
"ResultText": "Task 'test' running on agent 'WIN-4U2FKS6FK25'...",
"Scheduled": false,
"StartDateTime": "\/Date(1464211366750)\/",
"Status": 12,
"TransactionID": "ecf549f1-b3ce-4c35-ac18-6bf2d3bccca6",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "84e4644a-a8ca-45b7-bf21-c109a616399f"
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/agent_groups/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all agent groups.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all agent groups in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{29cccd8f-3e3e-4dff-8c2c-9ed3d2576eef}"
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/agent_groups/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all agent groups.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all agent groups in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "AgentGroupConstruct:#AutoMate.Constructs.v10",
"ID": "{29cccd8f-3e3e-4dff-8c2c-9ed3d2576eef}",
"Name": "AGroup",
"ParentID": "{65B26C46-C286-45d8-88AE-2E16774F0DAB}",
"Path": "\\AGENTGROUPS",
"Type": 11,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452790346657)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452790357857)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 2,
"VersionDate": "\/Date(1452790357857)\/",
"AgentIDs": []
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator"
}
]
}
/agent_groups/create [POST]

Description:Creates a new agent group.
Body
Description:JSON representation of the agent group.
Example:
{"ID":"{37129019-a470-4608-9719-e8995626beb2}",
"Name":"",
"ParentID":"",
"Type":11,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758349346)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758349346)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758349346)\/",
"AgentIDs":[]}}
/agent_groups/{id}/get [GET]

Description:Gets the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group.
Results
Description:JSON representation of the agent group.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "AgentGroupConstruct:#AutoMate.Constructs.v10",
"ID": "{29cccd8f-3e3e-4dff-8c2c-9ed3d2576eef}",
"Name": "AGroup",
"ParentID": "{65B26C46-C286-45d8-88AE-2E16774F0DAB}",
"Path": "",
"Type": 11,
"CompletionState": 2,
"CreatedBy": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"CreatedOn": "\/Date(1452790346657)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452790357857)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 2,
"VersionDate": "\/Date(1452790357857)\/",
"AgentIDs": []
},
"Paging": null,
"LookupTable": null
}
/agent_groups/{id}/update [POST]

Description:Updates the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group.
Body
Description:JSON representation of the agent group.
Example:
{"ID":"{37129019-a470-4608-9719-e8995626beb2}",
"Name":"",
"ParentID":"",
"Type":11,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758349346)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758349346)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758349346)\/",
"AgentIDs":[]}}
/agent_groups/{id}/delete [POST]

Description:Deletes the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group.
/agent_groups/{id}/enable [POST]

Description:Enables the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group to enable.
/agent_groups/{id}/disable [POST]

Description:Disables the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group to disable.
/agent_groups/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group.
Results
Description:A list of IDs for all permissions for the specified agent group.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{7c8e202f-ccde-4760-b54a-5cf118f05fe6}"
],
"Paging": null,
"LookupTable": null
}
/agent_groups/{id}/permissions/create [POST]

Description:Creates a new permission for the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/agent_groups/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the agent group.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null
}
/agent_groups/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the agent group.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/agent_groups/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the agent group.
id2stringThe ID of the permission.
/agent_groups/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified agent group.
ParametervalueDescription
idstringThe ID of the agent group.
Results
Description:A list of IDs for all audit events for the specified agent group.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/agent_groups/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the agent group.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
"Paging": null,
"LookupTable": null
}
/users/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all users.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all users in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{6AD627E8-373B-4104-81B7-9670A9D2F430}"
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/users/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all users.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all users in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "UserConstruct:#AutoMate.Constructs.v10",
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator",
"ParentID": "{CF0A8EFD-08A7-47b1-9A2A-335B743D284A}",
"Path": "\\USERS",
"Type": 10,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501360)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1404237501357)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1404237501360)\/",
"ConditionFolderID": "{5B00CA35-3EFB-41ea-95C0-D8B50B9BFA9F}",
"LockedOutOn": "\/Date(-2208988800000)\/",
"ProcessFolderID": "{8E19BEB0-9625-4810-AF6E-5EAD7069E83C}",
"TaskFolderID": "{E893A7FD-2758-4315-9181-93F8728332E5}",
"WorkflowFolderID": "{589D12C2-1282-4466-B7E3-FE547509AF31}",
"Username": "administrator",
"Role": 999,
"Password": "",
"CipherPassword": "#!ENCRYPTED!#2PfV+HsZnjJp1qUc5AgTdE9\/DVRL+Zqk"
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"Name": "Server"
}
]
}
/users/create [POST]

Description:Creates a new user.
Body
Description:JSON representation of the user.
Example:
{"ID":"{ed6a8832-29f5-4ee9-981d-57e074ca3d4a}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":10,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758382866)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758382866)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758382866)\/",
"ConditionFolderID":"",
"LockedOutOn":"\/Date(-2208960000000-0800)\/",
"ProcessFolderID":"",
"TaskFolderID":"",
"WorkflowFolderID":"",
"Username":"",
"Role":100,
"Password":"",
"CipherPassword":""}}
/users/{id}/get [GET]

Description:Gets the specified user.
ParametervalueDescription
idstringThe ID of the user.
Results
Description:JSON representation of the user.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "UserConstruct:#AutoMate.Constructs.v10",
"ID": "{6AD627E8-373B-4104-81B7-9670A9D2F430}",
"Name": "administrator",
"ParentID": "{CF0A8EFD-08A7-47b1-9A2A-335B743D284A}",
"Path": "",
"Type": 10,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501360)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1404237501357)\/",
"Notes": "",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 0,
"VersionDate": "\/Date(1404237501360)\/",
"ConditionFolderID": "{5B00CA35-3EFB-41ea-95C0-D8B50B9BFA9F}",
"LockedOutOn": "\/Date(-2208988800000)\/",
"ProcessFolderID": "{8E19BEB0-9625-4810-AF6E-5EAD7069E83C}",
"TaskFolderID": "{E893A7FD-2758-4315-9181-93F8728332E5}",
"WorkflowFolderID": "{589D12C2-1282-4466-B7E3-FE547509AF31}",
"Username": "administrator",
"Role": 999,
"Password": "",
"CipherPassword": "#!ENCRYPTED!#2PfV+HsZnjJp1qUc5AgTdE9\/DVRL+Zqk"
},
"Paging": null,
"LookupTable": null
}}
/users/{id}/update [POST]

Description:Updates the specified user.
ParametervalueDescription
idstringThe ID of the user.
Body
Description:JSON representation of the user.
Example:
{"ID":"{ed6a8832-29f5-4ee9-981d-57e074ca3d4a}",
"Name":"",
"ParentID":"",
"Type":10,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758382866)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758382866)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758382866)\/",
"ConditionFolderID":"",
"LockedOutOn":"\/Date(-2208960000000-0800)\/",
"ProcessFolderID":"",
"TaskFolderID":"",
"WorkflowFolderID":"",
"Username":"",
"Role":100,
"Password":"",
"CipherPassword":""}}
/users/{id}/delete [POST]

Description:Deletes the specified user.
ParametervalueDescription
idstringThe ID of the user.
/users/{id}/enable [POST]

Description:Enables the specified user.
ParametervalueDescription
idstringThe ID of the user to enable.
/users/{id}/disable [POST]

Description:Disables the specified user.
ParametervalueDescription
idstringThe ID of the user to disable.
/users/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified user.
ParametervalueDescription
idstringThe ID of the user.
Results
Description:A list of IDs for all permissions for the specified user.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{be18cc9a-2ac7-4bb2-ac1a-38f530653596}"
],
"Paging": null,
"LookupTable": null
}
/users/{id}/permissions/create [POST]

Description:Creates a new permission for the specified user.
ParametervalueDescription
idstringThe ID of the user.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/users/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the user.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null
}
/users/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the user.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/users/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the user.
id2stringThe ID of the permission.
/users/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified user.
ParametervalueDescription
idstringThe ID of the user.
Results
Description:A list of IDs for all audit events for the specified user.
Example:
{"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/users/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the user.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
"Paging": null,
"LookupTable": null
}
/users/authenticate [GET]

Description:Gets whether a username/password pair are valid.
Results
Description:A Data value of "success".
Example:
{
"Result": "success",
"Info": null,
"Data": "success",
"Paging": null,
"LookupTable": null
}
/user_groups/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all user groups.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all user groups in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"{b47dd1f8-7e55-4500-9cc0-8e37c8bbe5bd}",
"{bea62de9-859a-4708-be66-f8b067f18594}"
],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/user_groups/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all user groups.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, no folder filtering is applied.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all user groups in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "UserGroupConstruct:#AutoMate.Constructs.v10",
"ID": "{b47dd1f8-7e55-4500-9cc0-8e37c8bbe5bd}",
"Name": "Administrators",
"ParentID": "{E6B6C664-3B87-43a1-AD19-4B60191B8F3C}",
"Path": "\\USERGROUPS",
"Type": 12,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501307)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452805696337)\/",
"Notes": "Default user group that has all permissions granted",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 1,
"VersionDate": "\/Date(1452805696337)\/",
"UserIDs": []
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": [
{
"ID": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"Name": "Server"
}
]
}
/user_groups/create [POST]

Description:Creates a new user group.
Body
Description:JSON representation of the user group.
Example:
{
"ID": "{b47dd1f8-7e55-4500-9cc0-8e37c8bbe5bd}",
"Name": "Administrators",
"ParentID": "{E6B6C664-3B87-43a1-AD19-4B60191B8F3C}",
"Path": "\\USERGROUPS",
"Type": 12,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501307)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452805696337)\/",
"Notes": "Default user group that has all permissions granted",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 1,
"VersionDate": "\/Date(1452805696337)\/",
"UserIDs": []
}
/user_groups/{id}/get [GET]

Description:Gets the specified user group.
ParametervalueDescription
idstringThe ID of the user group.
Results
Description:JSON representation of the user group.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "UserGroupConstruct:#AutoMate.Constructs.v10",
"ID": "{b47dd1f8-7e55-4500-9cc0-8e37c8bbe5bd}",
"Name": "Administrators",
"ParentID": "{E6B6C664-3B87-43a1-AD19-4B60191B8F3C}",
"Path": "",
"Type": 12,
"CompletionState": 0,
"CreatedBy": "{F910794D-0969-409d-9096-BB9A5BF3D5FE}",
"CreatedOn": "\/Date(1404237501307)\/",
"Empty": false,
"Enabled": true,
"EndedOn": "\/Date(-2208988800000)\/",
"ExclusionSchedules": [],
"LockedBy": "",
"ModifiedOn": "\/Date(1452805696337)\/",
"Notes": "Default user group that has all permissions granted",
"Removed": false,
"ResultCode": 0,
"ResultText": "",
"StartedOn": "\/Date(-2208988800000)\/",
"Version": 1,
"VersionDate": "\/Date(1452805696337)\/",
"UserIDs": []
},
"Paging": null,
"LookupTable": null
}
/user_groups/{id}/update [POST]

Description:Updates the specified user group.
ParametervalueDescription
idstringThe ID of the user group.
Body
Description:JSON representation of the user group.
Example:
{
"ID":"{5e91a915-7914-421f-b04e-ba1f3dd95fef}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":12,
"CompletionState":0,
"CreatedBy":"",
"CreatedOn":"\/Date(1437758411172)\/",
"Empty":false,
"Enabled":true,
"EndedOn":"\/Date(-2208960000000-0800)\/",
"ExclusionSchedules":[],
"LockedBy":"",
"ModifiedOn":"\/Date(1437758411172)\/",
"Notes":"",
"Removed":false,
"ResultCode":0,
"ResultText":"",
"StartedOn":"\/Date(-2208960000000-0800)\/",
"Version":1,
"VersionDate":"\/Date(1437758411172)\/",
"UserIDs":[]
}
/user_groups/{id}/delete [POST]

Description:Deletes the specified user group.
ParametervalueDescription
idstringThe ID of the user group.
/user_groups/{id}/enable [POST]

Description:Enables the specified user group.
ParametervalueDescription
idstringThe ID of the user group to enable.
/user_groups/{id}/disable [POST]

Description:Disables the specified user group.
ParametervalueDescription
idstringThe ID of the user group to disable.
/user_groups/{id}/permissions/index [GET]

Description:Gets a list of the IDs of all permissions for the specified user group.
ParametervalueDescription
idstringThe ID of the user group.
Results
Description:A list of IDs for all permissions for the specified user group.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/user_groups/{id}/permissions/create [POST]

Description:Creates a new permission for the specified user group.
ParametervalueDescription
idstringThe ID of the user group.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/user_groups/{id}/permissions/{id2}/get [GET]

Description:Gets the specified permission.
ParametervalueDescription
idstringThe ID of the user group.
id2stringThe ID of the permission.
Results
Description:JSON representation of the permission.
Example:
{"Result":"success",
"Info":null,
"Data":
{"__type":"ItemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false},
"Paging": null,
"LookupTable": null
}
/user_groups/{id}/permissions/{id2}/update [POST]

Description:Updates the specified permission.
ParametervalueDescription
idstringThe ID of the user group.
id2stringThe ID of the permission.
Body
Description:JSON representation of the permission.
Example:
{"ID":"{5052fcda-8236-4294-9af7-2790e099742e}",
"Name":"",
"ParentID":"",
"Type":34,
"AssignPermission":false,
"ConstructID":"",
"CreatePermission":false,
"DeletePermission":false,
"EditPermission":false,
"EnablePermission":false,
"ExportPermission":false,
"GroupID":"",
"ImportPermission":false,
"LockPermission":false,
"MovePermission":false,
"ReadPermission":false,
"ResumePermission":false,
"ResurrectPermission":false,
"RunFromHerePermission":false,
"RunPermission":false,
"SecurityPermission":false,
"StagingPermission":false,
"StopPermission":false,
"UpgradePermission":false}
/user_groups/{id}/permissions/{id2}/delete [POST]

Description:Deletes the specified permission.
ParametervalueDescription
idstringThe ID of the user group.
id2stringThe ID of the permission.
/user_groups/{id}/audit_events/index [GET]

Description:Gets a list of the IDs of all audit events for the specified user group.
ParametervalueDescription
idstringThe ID of the user group.
Results
Description:A list of IDs for all audit events for the specified user group.
Example:
{
"Result":"success",
"Info":null,
"Data":["AA","BB","CC"],
"Paging": null,
"LookupTable": null
}
/user_groups/{id}/audit_events/{id2}/get [GET]

Description:Gets the specified audit event.
ParametervalueDescription
idstringThe ID of the user group.
id2stringThe ID of the audit event.
Results
Description:JSON representation of the audit event.
Example:
{
"Result":"success",
"Info":null,
"Data":
{"__type":"GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID":"{fd0302fd-5f35-4eff-a1fc-5dea4ee139aa}",
"Name":"",
"ParentID":"",
"Path": "",
"Type":16,
"Data":null,
"EventDateTime":"\/Date(-62135568000000-0800)\/",
"EventText":null,
"EventType":0,
"PrimaryConstructID":null,
"RowIndex":-1,
"SessionID":"",
"StatusType":0,
"UserID":null},
"Paging": null,
"LookupTable": null
}
/calendar/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&type={ScheduleType}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of scheduled workflows for a given time range.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time plus 24 hours is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on NextRunTime field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the workflow folder to include, and includes all child folders. If omitted, the root workflow folder is used.
typestringThe type of schedule triggers to report on. If omitted, all types are shown. Valid values are: Specific, Weekly, Monthly, Holidays, Non-interval
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the calendar events.
Example:
{"Result":"success",
"Info":null,
"Data":
[
{"__type":"CalendarEventConstruct:#AutoMate.Constructs.v10",
"NextRunTime":"\/Date(1441114877000)\/",
"ScheduleDescription":"Trigger every 1 day(s) at 6:41:17 AM. Do not trigger on holidays for Bradland between 12:00:00 AM and 11:59:59 AM.",
"ScheduleID":"{a315f5e1-ee88-4aa2-8459-68f54ab26ca1}",
"ScheduleName":"6274",
"SchedulePath":null,
"ScheduleType":"",
"WorkflowID":"{d974cf41-5e69-4b22-aa20-49266c8ace5c}",
"WorkflowName":"6274",
"WorkflowPath":""
}
],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/audit_events/get?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of audit events for a given time range.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the audit events.
Example:
{"Result":"success",
"Info":null,
"Data":
[ {
"__type": "GeneralEventConstruct:#AutoMate.Constructs.v10",
"ID": "{fc028d0b-b9d4-4b01-b7a4-6b1cbf5a8609}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 16,
"Data": "SessionID:{02500350-9a0f-4d4a-86a4-a856ead151a1}|IP:127.0.0.1|AgentID:6c7f52be-715c-4eb7-ba6a-6873c28c46d1|MachineName:WIN-4U2FKS6FK25",
"EventDateTime": "\/Date(1452021746367)\/",
"EventText": "Task agent 'WIN-4U2FKS6FK25' connected from machine 'WIN-4U2FKS6FK25' (IP: 127.0.0.1)",
"EventType": 304,
"PrimaryConstructID": "6c7f52be-715c-4eb7-ba6a-6873c28c46d1",
"RowIndex": 44,
"SessionID": "{02500350-9a0f-4d4a-86a4-a856ead151a1}",
"StatusType": 0,
"UserID": null
}],
"Paging": {
"TotalSetSize": 1,
"PageStartIndex": 0,
"PageSize": 1
},
"LookupTable": null
}
/execution_events/get?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of execution events for a given time range.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the execution events.
Example:
{"Result":"success",
"Info":null,
"Data": [
{
"__type": "ExecutionEventConstruct:#AutoMate.Constructs.v10",
"ID": "{00567e81-7f5d-4d98-a9fa-28e485962340}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 17,
"AgentID": "732bb3ec-14a4-4d0e-af3b-cbda7a49e5a7",
"ConstructID": "{f490a51d-5e37-4500-b206-fa5131a66700}",
"EndDateTime": "\/Date(1452732828373)\/",
"InstanceID": "51eb10a1-4ef7-4827-b773-b664c5da1a8a",
"ResultCode": 12,
"ResultText": "Task 'test' running on agent 'xxxx'...",
"RowIndex": 5949,
"StartDateTime": "\/Date(1452732828373)\/",
"TransactionID": "eb949e7f-182f-4ac5-b065-6de1e88fef1f",
"UserID": "",
"WorkflowInstanceID": "aa093596-8829-47a0-9e9b-433606dd798a"
},
"Paging": {
"TotalSetSize": 1234,
"PageStartIndex": 2,
"PageSize": 2
},
"LookupTable": null
}
/instances/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}&include_relatives={IncludeRelatives} [GET]

Description:Gets a list of instances.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on StartDateTime field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, all folders are used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
include_relativesbooleanDefault value is false. If set than instances related to TransactionID returns.
Results
Description:List of the JSON representation of the instances.
Example:
{
"Result":"success",
"Info":null,
"Data":
[
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "{c85a87cb-1ed4-4d16-b9d8-268fcc7f1cfa}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "",
"AgentName": "",
"AgentPath": "",
"ConstructID": "{a3202832-5de9-4abb-a2c6-65ead6747834}",
"ConstructName": "abcd",
"ConstructPath": "\\WORKFLOWS",
"ConstructType": 3,
"DurationInSeconds": 7,
"EndDateTime": "\/Date(1455766411443-0800)\/",
"InstanceID": "54642ac6-ec1d-495f-8150-2fb18c0f943d",
"LastChanged": "\/Date(1455766411443-0800)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": 1,
"ResultText": "Workflow 'abcd' completed successfully.",
"Scheduled": false,
"StartDateTime": "\/Date(1455766404867-0800)\/",
"Status": 1,
"TransactionID": "50533231-5764-4e8d-8301-a508e64f3720",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "54642ac6-ec1d-495f-8150-2fb18c0f943d"
},
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "{1a5c072a-f7e1-480f-9183-581a8181180e}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "55e506fc-434f-451c-a157-b3d40d56ecc8",
"AgentName": "WIN-4U2FKS6FK25",
"AgentPath": "\\TASKAGENTS",
"ConstructID": "{4959fe12-edbd-4167-93c9-2daf8914a9af}",
"ConstructName": "abcd",
"ConstructPath": "\\TASKS",
"ConstructType": 2,
"DurationInSeconds": 7,
"EndDateTime": "\/Date(1455766411407-0800)\/",
"InstanceID": "529da014-16f0-4d41-8a67-55d1c300590d",
"LastChanged": "\/Date(1455766411407-0800)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": 1,
"ResultText": "Task 'abcd' running on agent 'WIN-4U2FKS6FK25' completed successfully.",
"Scheduled": false,
"StartDateTime": "\/Date(1455766405147-0800)\/",
"Status": 1,
"TransactionID": "50533231-5764-4e8d-8301-a508e64f3720",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "54642ac6-ec1d-495f-8150-2fb18c0f943d"
}
],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/instances/running/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}&include_relatives={IncludeRelatives} [GET]

Description:Gets a list of running instances.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on StartDateTime field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, all folders are used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
include_relativesbooleanDefault value is false. If set than instances related to TransactionID returns.
Results
Description:List of the JSON representation of the instances.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "{e7472852-e337-4513-b05a-e4ecf96611b8}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "",
"AgentName": "",
"AgentPath": "",
"ConstructID": "{a3202832-5de9-4abb-a2c6-65ead6747834}",
"ConstructName": "abcd",
"ConstructPath": "\\WORKFLOWS",
"ConstructType": 3,
"DurationInSeconds": 40,
"EndDateTime": "\/Date(1456889406020-0800)\/",
"InstanceID": "bc9c876f-6411-47a9-8982-a0aa509ba6cd",
"LastChanged": "\/Date(1456889406020-0800)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": -1,
"ResultText": "Workflow 'abcd' running...",
"Scheduled": false,
"StartDateTime": "\/Date(1456889406020-0800)\/",
"Status": 12,
"TransactionID": "d5a3039d-3474-4c51-87f8-9c8c1e769167",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "bc9c876f-6411-47a9-8982-a0aa509ba6cd"
},
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "{a99cc3ec-c794-4d67-ba73-f32392a701b0}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "55e506fc-434f-451c-a157-b3d40d56ecc8",
"AgentName": "WIN-4U2FKS6FK25",
"AgentPath": "\\TASKAGENTS",
"ConstructID": "{4959fe12-edbd-4167-93c9-2daf8914a9af}",
"ConstructName": "abcd",
"ConstructPath": "\\TASKS",
"ConstructType": 2,
"DurationInSeconds": 40,
"EndDateTime": "\/Date(1456889406127-0800)\/",
"InstanceID": "d201d360-4c58-4275-b1ab-75320ecc4099",
"LastChanged": "\/Date(1456889406127-0800)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": -1,
"ResultText": "Task 'abcd' running on agent 'WIN-4U2FKS6FK25'...",
"Scheduled": false,
"StartDateTime": "\/Date(1456889406127-0800)\/",
"Status": 12,
"TransactionID": "d5a3039d-3474-4c51-87f8-9c8c1e769167",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "bc9c876f-6411-47a9-8982-a0aa509ba6cd"
}
],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/instances/completed/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize}&include_relatives={IncludeRelatives} [GET]

Description:Gets a list of completed instances.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on StartDateTime field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
folder_idstringThe ID of the folder to include results for, and includes all child folders. If omitted, all folders are used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
include_relativesbooleanDefault value is false. If set than instances related to TransactionID returns.
Results
Description:List of the JSON representation of the instances.
Example:
{
"Result":"success",
"Info":null,
"Data":
[
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "{2314d4cd-b48c-4ef1-ac8b-786e89e43dae}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "",
"AgentName": "",
"AgentPath": "",
"ConstructID": "{a3202832-5de9-4abb-a2c6-65ead6747834}",
"ConstructName": "abcd",
"ConstructPath": "\\WORKFLOWS",
"ConstructType": 3,
"DurationInSeconds": 7,
"EndDateTime": "\/Date(1455766411443-0800)\/",
"InstanceID": "54642ac6-ec1d-495f-8150-2fb18c0f943d",
"LastChanged": "\/Date(1455766411443-0800)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": 1,
"ResultText": "Workflow 'abcd' completed successfully.",
"Scheduled": false,
"StartDateTime": "\/Date(1455766404867-0800)\/",
"Status": 1,
"TransactionID": "50533231-5764-4e8d-8301-a508e64f3720",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "54642ac6-ec1d-495f-8150-2fb18c0f943d"
},
{
"__type": "InstanceConstruct:#AutoMate.Constructs.v10",
"ID": "{df433dfd-f2b9-445d-8220-fe72681243ba}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "55e506fc-434f-451c-a157-b3d40d56ecc8",
"AgentName": "WIN-4U2FKS6FK25",
"AgentPath": "\\TASKAGENTS",
"ConstructID": "{4959fe12-edbd-4167-93c9-2daf8914a9af}",
"ConstructName": "abcd",
"ConstructPath": "\\TASKS",
"ConstructType": 2,
"DurationInSeconds": 7,
"EndDateTime": "\/Date(1455766411407-0800)\/",
"InstanceID": "529da014-16f0-4d41-8a67-55d1c300590d",
"LastChanged": "\/Date(1455766411407-0800)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": 1,
"ResultText": "Task 'abcd' running on agent 'WIN-4U2FKS6FK25' completed successfully.",
"Scheduled": false,
"StartDateTime": "\/Date(1455766405147-0800)\/",
"Status": 1,
"TransactionID": "50533231-5764-4e8d-8301-a508e64f3720",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": "54642ac6-ec1d-495f-8150-2fb18c0f943d"
}
],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/metrics/execution/get [GET]

Description:Gets the metrics for the execution server.
Results
Description:JSON representation of the Execution Server metrics.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ExecutionServerMetrics:#AutoMate.Constructs.v10",
"ComputerName": "VMBREYNOLDS",
"FreeRAM": 2313012,
"Is64BitOperatingSystem": true,
"OSVersion": "Microsoft Windows NT 6.2.9200.0",
"Timestamp": "\/Date(1446763184368)\/",
"TotalCPUPercentage": 0,
"TotalCores": 4,
"TotalRAM": 4193780,
"CPUPercentage": 0,
"HandleCount": 920,
"Is64BitProcess": true,
"PrivateMemory": 91004,
"ThreadCount": 47,
"Uptime": "00.00:00:30",
"WorkingSet": 141760,
"ConnectedAgentsCount": 0,
"GlobalTriggeringEnabled": false,
"LifetimeProcessInstanceCount": 0,
"LifetimeTaskInstanceCount": 0,
"LifetimeWorkflowInstanceCount": 0,
"PeakProcessInstanceCount": 0,
"PeakTaskInstanceCount": 0,
"PeakWorkflowInstanceCount": 0,
"ProcessInstanceCount": 0,
"QueuedProcessInstanceCount": 0,
"QueuedTaskInstanceCount": 0,
"QueuedWorkflowInstanceCount": 0,
"TaskInstanceCount": 0,
"WorkflowInstanceCount": 0
},
"Paging": null,
"LookupTable": null
}
/metrics/management/get [GET]

Description:Gets the metrics for the management server.
Results
Description:JSON representation of the Management Server metrics.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "ManagementServerMetrics:#AutoMate.Constructs.v10",
"ComputerName": "VMBREYNOLDS",
"FreeRAM": 2318492,
"Is64BitOperatingSystem": true,
"OSVersion": "Microsoft Windows NT 6.2.9200.0",
"Timestamp": "\/Date(1446763270420)\/",
"TotalCPUPercentage": 0,
"TotalCores": 4,
"TotalRAM": 4193780,
"CPUPercentage": 3,
"HandleCount": 625,
"Is64BitProcess": true,
"PrivateMemory": 51888,
"ThreadCount": 27,
"Uptime": "00.00:01:54",
"WorkingSet": 88836,
"ConnectedClientsCount": 0
},
"Paging": null,
"LookupTable": null
}
/metrics/run/list?range_start={RangeStart}&range_end={RangeEnd}&interval_size={IntervalSize}&filter_sets={FilterSets}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of metrics for running objects.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
interval_sizeintThe size of the intervals in seconds. If omitted, the interval is 60 seconds.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. The object to be filtered for data elements is the instance. Here is an example of compound filter sets: "Name","contains","\"work\""|"ConstructID","=","\"theConstructID\"".
folder_idstringThe ID of the workflow folder to include, and includes all child folders. If omitted, the root workflow folder is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the run interval metrics.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "RunIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1459958848864)\/",
"IntervalEnd": "\/Date(1459958908864)\/",
"CurrentCount": 0,
"MaxCountInInterval": 1,
"MinCountInInterval": 1,
"AverageCountInInterval": 1
},
{
"__type": "RunIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1459958908864)\/",
"IntervalEnd": "\/Date(1459958968864)\/",
"CurrentCount": 0,
"MaxCountInInterval": 1,
"MinCountInInterval": 1,
"AverageCountInInterval": 1
},
{
"__type": "RunIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1459958968864)\/",
"IntervalEnd": "\/Date(1459959028864)\/",
"CurrentCount": 0,
"MaxCountInInterval": 1,
"MinCountInInterval": 1,
"AverageCountInInterval": 1
}
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": null
}
/metrics/completed/list?range_start={RangeStart}&range_end={RangeEnd}&interval_size={IntervalSize}&filter_sets={FilterSets}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of metrics for completed objects.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
interval_sizeintThe size of the intervals in seconds. If omitted, the interval is 60 seconds.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. The object to be filtered for data elements is the instance. Here is an example of compound filter sets: "Name","contains","\"work\""|"ConstructID","=","\"theConstructID\"".
folder_idstringThe ID of the workflow folder to include, and includes all child folders. If omitted, the root workflow folder is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the completed interval metrics.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "CompletedIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1459960854933)\/",
"IntervalEnd": "\/Date(1459960914933)\/",
"SuccessfulCountInInterval": 0,
"FailedCountInInterval": 0
},
{
"__type": "CompletedIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1459960914933)\/",
"IntervalEnd": "\/Date(1459960974933)\/",
"SuccessfulCountInInterval": 0,
"FailedCountInInterval": 0
},
{
"__type": "CompletedIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1459960974933)\/",
"IntervalEnd": "\/Date(1459961034933)\/",
"SuccessfulCountInInterval": 0,
"FailedCountInInterval": 0
}
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": null
}
/metrics/queued/list?range_start={RangeStart}&range_end={RangeEnd}&interval_size={IntervalSize}&filter_sets={FilterSets}&folder_id={FolderID}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of metrics for queued objects.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
interval_sizeintThe size of the intervals in seconds. If omitted, the interval is 60 seconds.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. The object to be filtered for data elements is the instance. Here is an example of compound filter sets: "Name","contains","\"work\""|"ConstructID","=","\"theConstructID\"".
folder_idstringThe ID of the workflow folder to include, and includes all child folders. If omitted, the root workflow folder is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the queued interval metrics.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "RunIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1460107945000)\/",
"IntervalEnd": "\/Date(1460108005000)\/",
"CurrentCount": 0,
"MaxCountInInterval": 1,
"MinCountInInterval": 1,
"AverageCountInInterval": 1
},
{
"__type": "RunIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1460108005000)\/",
"IntervalEnd": "\/Date(1460108065000)\/",
"CurrentCount": 0,
"MaxCountInInterval": 1,
"MinCountInInterval": 1,
"AverageCountInInterval": 1
},
{
"__type": "RunIntervalMetrics:#AutoMate.Communications.Server",
"IntervalStart": "\/Date(1460108065000)\/",
"IntervalEnd": "\/Date(1460108125000)\/",
"CurrentCount": 0,
"MaxCountInInterval": 1,
"MinCountInInterval": 1,
"AverageCountInInterval": 1
}
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": null
}
/metrics/deviations/list?range_start={RangeStart}&range_end={RangeEnd}&filter_sets={FilterSets}&folder_id={FolderID}&deviation_percentage={DeviationPercentage}&deviation_direction={DeviationDirection}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of deviations for the instances.
Optional ParametervalueDescription
range_startdatetimeThe datetime of the start of the filter range. If omitted, the current coordinated universal time (UTC) date and time minus 24 hours is used.
range_enddatetimeThe datetime of the end of the filter range. If omitted, the current coordinated universal time (UTC) date and time is used.
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
folder_idstringThe ID of the workflow folder to include, and includes all child folders. If omitted, the root workflow folder is used.
deviation_percentageintThe percentage of deviation for the instances. If omitted, deviation percentage is 50.
deviation_directionstringGive the direction to start deviation either "BELOW" or "ABOVE". If omitted, deviation direction is BOTH.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:List of the JSON representation of the deviations for the instances.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "Deviation:#AutoMate.Communications.Server",
"AverageDuration": 10,
"Instance": {
"ID": "{f947b283-4bf1-48e3-913f-e0ea61a6b736}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "13ffc625-0b34-4e29-9d08-195c2cc7f63f",
"AgentName": "",
"AgentPath": "",
"ConstructEnabled": true,
"ConstructID": "{7dc5b827-daf1-49af-9be3-b239367fa9f7}",
"ConstructName": "New Process",
"ConstructPath": "\\PROCESSES",
"ConstructType": 40,
"CurrentFunctionName": "",
"CurrentStepDescription": "",
"CurrentStepNumber": 0,
"DurationInSeconds": 0,
"EndDateTime": "\/Date(1458317032460)\/",
"InstanceID": "838d3b3e-636c-45c9-a17c-dfe9ef9a5921",
"LastChanged": "\/Date(1458317032460)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": 1,
"ResultText": "Process 'New Process' running on agent 'ProAgent' completed successfully.",
"Scheduled": false,
"StartDateTime": "\/Date(1458317032460)\/",
"Status": 1,
"TransactionID": "2a9d3521-e092-4c55-9c7f-2e44a9acb23f",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": ""
}
},
{
"__type": "Deviation:#AutoMate.Communications.Server",
"AverageDuration": 10,
"Instance": {
"ID": "{152acf68-bb44-46af-9b6e-58a93ffbe6a7}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 65,
"AgentID": "cfee05c0-21fb-4127-a7a0-284195d58922",
"AgentName": "",
"AgentPath": "",
"ConstructEnabled": true,
"ConstructID": "{7dc5b827-daf1-49af-9be3-b239367fa9f7}",
"ConstructName": "New Process",
"ConstructPath": "\\PROCESSES",
"ConstructType": 40,
"CurrentFunctionName": "",
"CurrentStepDescription": "",
"CurrentStepNumber": 0,
"DurationInSeconds": 0,
"EndDateTime": "\/Date(1458166441737)\/",
"InstanceID": "cfac584a-c604-45f4-84cb-914ed62b165c",
"LastChanged": "\/Date(1458166441737)\/",
"ManuallyRun": false,
"Reactive": false,
"ResultCode": 1,
"ResultText": "Process 'New Process' running on agent 'MyProAgent' completed successfully.",
"Scheduled": false,
"StartDateTime": "\/Date(1458166441737)\/",
"Status": 1,
"TransactionID": "e23f2774-7e5d-4c18-96af-21afe87aff1d",
"TriggerID": "",
"TriggerName": "",
"TriggerPath": "",
"TriggerType": 0,
"Triggered": false,
"UserID": "",
"UserName": "",
"UserPath": "",
"WorkflowInstanceID": ""
}
}

],
"Paging": {
"TotalSetSize": 2,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/system_permissions/index?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of the IDs of all system permissions.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of IDs for all system permissions in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
"AA","BB"
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 2
},
"LookupTable": null
}
/system_permissions/list?filter_sets={FilterSets}&sort_field={SortFieldName}&sort_order={SortOrder}&start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a list of all System Permissions.
Optional ParametervalueDescription
filter_setsstringSets of filter parameters seperated by a pipe (|). The filter parameters are filter field name, filter operation, and filter value. The field name parameter is case sensative. Valid values for the operation are: =, !=, <, >, contains. If the filter value is a string, it must be quoted. Here is an example of compound filter sets: "Name","contains","\"work\""|"ParentID","=","\"thefolderid\""
sort_fieldstringThe name of the field to sort on. If omitted, results are sorted on ID field.
sort_orderstringThe sort order to use. Valid values are "ASC" or "DSC". If omitted, "ASC" is used.
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:A list of all system permissions in the system.
Example:
{
"Result": "success",
"Info": null,
"Data": [
{
"__type": "SystemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID": "{87a8a148-0c8f-4c5a-a2c1-5057cf86e993}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 35,
"DeployPermission": false,
"EditDashboardPermission": false,
"EditDefaultPropertiesPermission": false,
"EditLicensingPermission": false,
"EditPreferencesPermission": false,
"EditServerSettingsPermission": true,
"GroupID": "{5505be4e-aa33-41bd-8d4e-97051c28be68}",
"ToggleTriggeringPermission": false,
"ViewCalendarPermission": false,
"ViewDashboardPermission": false,
"ViewDefaultPropertiesPermission": false,
"ViewLicensingPermission": false,
"ViewPreferencesPermission": false,
"ViewReportsPermission": false,
"ViewServerSettingsPermission": false
},
{
"__type": "SystemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID": "{cc17ced2-5fb2-4136-bd91-91faaf90cXX1}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 35,
"DeployPermission": false,
"EditDashboardPermission": false,
"EditDefaultPropertiesPermission": false,
"EditLicensingPermission": false,
"EditPreferencesPermission": false,
"EditServerSettingsPermission": false,
"GroupID": "{182421bc-decf-400a-a2d2-3477b3031b65}",
"ToggleTriggeringPermission": false,
"ViewCalendarPermission": false,
"ViewDashboardPermission": false,
"ViewDefaultPropertiesPermission": false,
"ViewLicensingPermission": false,
"ViewPreferencesPermission": false,
"ViewReportsPermission": false,
"ViewServerSettingsPermission": true
},
{
"__type": "SystemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID": "cc17ced2-5fb2-4136-bd91-91faaf90c7gg",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 35,
"DeployPermission": true,
"EditDashboardPermission": true,
"EditDefaultPropertiesPermission": true,
"EditLicensingPermission": true,
"EditPreferencesPermission": true,
"EditServerSettingsPermission": true,
"GroupID": "{3bd72b3e-08c7-4ef9-9ece-4f462e134ae2}",
"ToggleTriggeringPermission": false,
"ViewCalendarPermission": false,
"ViewDashboardPermission": false,
"ViewDefaultPropertiesPermission": false,
"ViewLicensingPermission": false,
"ViewPreferencesPermission": false,
"ViewReportsPermission": false,
"ViewServerSettingsPermission": false
}
],
"Paging": {
"TotalSetSize": 3,
"PageStartIndex": 0,
"PageSize": 3
},
"LookupTable": null
}
/system_permissions/create [POST]

Description:Creates a new system permission.
Body
Description:JSON representation of the system permission.The input system-permission to be created,should have an ID in order for method to it.
Example:
{
"ID": "{AA}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 35,
"DeployPermission": true,
"EditDashboardPermission": true,
"EditDefaultPropertiesPermission": true,
"EditLicensingPermission": true,
"EditPreferencesPermission": true,
"EditServerSettingsPermission": true,
"GroupID": "{182421bc-decf-400a-a2d2-3477b3031b65}",
"ToggleTriggeringPermission": true,
"ViewCalendarPermission": true,
"ViewDashboardPermission": true,
"ViewDefaultPropertiesPermission": true,
"ViewLicensingPermission": true,
"ViewPreferencesPermission": true,
"ViewReportsPermission": true,
"ViewServerSettingsPermission": true
}
/system_permissions/{id}/get [GET]

Description:Gets the specified system permission.
ParametervalueDescription
idstringThe ID of the system permission.
Results
Description:JSON representation of the system permission.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "SystemPermissionsConstruct:#AutoMate.Constructs.v10",
"ID": "{AA}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 35,
"DeployPermission": true,
"EditDashboardPermission": true,
"EditDefaultPropertiesPermission": true,
"EditLicensingPermission": true,
"EditPreferencesPermission": true,
"EditServerSettingsPermission": true,
"GroupID": "{BB}",
"ToggleTriggeringPermission": false,
"ViewCalendarPermission": false,
"ViewDashboardPermission": false,
"ViewDefaultPropertiesPermission": false,
"ViewLicensingPermission": false,
"ViewPreferencesPermission": false,
"ViewReportsPermission": false,
"ViewServerSettingsPermission": false
},
"Paging": null,
"LookupTable": null
}
/system_permissions/{id}/update [POST]

Description:Updates the specified system permission.
ParametervalueDescription
idstringThe ID of the system permission.
Body
Description:JSON representation of the system permission.
Example:
{
"ID": "{AA}",
"Name": "",
"ParentID": "",
"Path": "",
"Type": 35,
"DeployPermission": true,
"EditDashboardPermission": true,
"EditDefaultPropertiesPermission": true,
"EditLicensingPermission": true,
"EditPreferencesPermission": true,
"EditServerSettingsPermission": true,
"GroupID": "{BB}",
"ToggleTriggeringPermission": true,
"ViewCalendarPermission": true,
"ViewDashboardPermission": true,
"ViewDefaultPropertiesPermission": true,
"ViewLicensingPermission": true,
"ViewPreferencesPermission": true,
"ViewReportsPermission": true,
"ViewServerSettingsPermission": true
}
/system_permissions/{id}/delete [POST]

Description:Deletes the specified system permission.
ParametervalueDescription
idstringThe ID of the system permission.
output/list?start_index={PageStartIndex}&page_size={PageSize} [GET]

Description:Gets a output messages.
Optional ParametervalueDescription
start_indexintThe index of the result set to begin paging.
page_sizeintThe number of elements in the result set to return.
Results
Description:The JSON representation of the SystemOutput.
Example:
{
"Result": "success",
"Info": null,
"Data": {
"__type": "SystemOutput:#AutoMate.Communications.Server",
"Messages": [
{
"TimeStamp": "\/Date(1458151759811)\/",
"Text": "User 'Administrator' manually started workflow 'test'"
},
{
"TimeStamp": "\/Date(1458151759875)\/",
"Text": "Workflow 'test' running..."
},
{
"TimeStamp": "\/Date(1458151760118)\/",
"Text": "Task 'test' running on agent 'WIN-4U2FKS6FK25'..."
}
],
"IndexOfLastMessage": 3
},
"Paging": null,
"LookupTable": null
}