OfficeAutomata Server API




OfficeAutomata Server API


OfficeAutomata API that the OpenAPI 3.0 specification for export of Tasks and Processes
Version: 1.0.0
BasePath:/api
Apache-2.0

Access

  1. APIKey KeyParamName:License KeyInQuery:true KeyInHeader:false

Methods

[ Jump to Models ]

Table of Contents

Event

Process

Task

Event

Up

get /task/select
Find Task by ID (getTaskById)
Returns a Task with Id, Name, and Events array

Query parameters

LicenseID (required)
Query Parameter — The client license number default: demo
TaskID (required)
Query Parameter — format: int32

Return type

Example data

Content-Type: application/json
{
  "Events" : [ {
    "UI_Element" : "UI_Element",
    "Pattern_Value" : "Pattern_Value",
    "AppFile" : "AppFile",
    "X_Path" : "X_Path",
    "Index" : 1,
    "Time" : "Time",
    "Data" : "Data",
    "WorkflowID" : 6,
    "AutoID_Control" : "AutoID_Control",
    "Type" : "Type",
    "UI_Element_Pattern" : "UI_Element_Pattern",
    "Value" : "Value",
    "API" : "API",
    "Application" : "Application",
    "AppFrame_1" : "AppFrame_1",
    "Location" : "Location"
  }, {
    "UI_Element" : "UI_Element",
    "Pattern_Value" : "Pattern_Value",
    "AppFile" : "AppFile",
    "X_Path" : "X_Path",
    "Index" : 1,
    "Time" : "Time",
    "Data" : "Data",
    "WorkflowID" : 6,
    "AutoID_Control" : "AutoID_Control",
    "Type" : "Type",
    "UI_Element_Pattern" : "UI_Element_Pattern",
    "Value" : "Value",
    "API" : "API",
    "Application" : "Application",
    "AppFrame_1" : "AppFrame_1",
    "Location" : "Location"
  } ],
  "ID" : 0,
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

successful operation
TaskSummary

400

Invalid License

404

Task not found


Process

Up

get /process/all
Get all Processes (getAllProcesses)
Get all Process Names and Process IDs

Query parameters

LicenseID (required)
Query Parameter — The client license number default: demo

Return type

Example data

Content-Type: application/json
[ {
  "ID" : 0,
  "Name" : "Name"
}, {
  "ID" : 0,
  "Name" : "Name"
} ]

Produces

This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

successful operation
Processes

400

Invalid License


Task

Up

get /task/all
Get all Tasks (getAllTasks)
Get all Task Names and Task IDs

Query parameters

LicenseID (required)
Query Parameter — The client license number default: demo

Return type

Example data

Content-Type: application/json
[ {
  "ID" : 0,
  "Name" : "Name"
}, {
  "ID" : 0,
  "Name" : "Name"
} ]

Produces

This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

pet response
Tasks

400

Invalid License


Up

get /task/select
Find Task by ID (getTaskById)
Returns a Task with Id, Name, and Events array

Query parameters

LicenseID (required)
Query Parameter — The client license number default: demo
TaskID (required)
Query Parameter — format: int32

Return type

Example data

Content-Type: application/json
{
  "Events" : [ {
    "UI_Element" : "UI_Element",
    "Pattern_Value" : "Pattern_Value",
    "AppFile" : "AppFile",
    "X_Path" : "X_Path",
    "Index" : 1,
    "Time" : "Time",
    "Data" : "Data",
    "WorkflowID" : 6,
    "AutoID_Control" : "AutoID_Control",
    "Type" : "Type",
    "UI_Element_Pattern" : "UI_Element_Pattern",
    "Value" : "Value",
    "API" : "API",
    "Application" : "Application",
    "AppFrame_1" : "AppFrame_1",
    "Location" : "Location"
  }, {
    "UI_Element" : "UI_Element",
    "Pattern_Value" : "Pattern_Value",
    "AppFile" : "AppFile",
    "X_Path" : "X_Path",
    "Index" : 1,
    "Time" : "Time",
    "Data" : "Data",
    "WorkflowID" : 6,
    "AutoID_Control" : "AutoID_Control",
    "Type" : "Type",
    "UI_Element_Pattern" : "UI_Element_Pattern",
    "Value" : "Value",
    "API" : "API",
    "Application" : "Application",
    "AppFrame_1" : "AppFrame_1",
    "Location" : "Location"
  } ],
  "ID" : 0,
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

successful operation
TaskSummary

400

Invalid License

404

Task not found


Models

[ Jump to Methods ]

Table of Contents

  1. Event
  2. Process
  3. Processes
  4. Task
  5. TaskSummary
  6. Tasks

Event Up

WorkflowID (optional)
Integer format: int32
Index (optional)
Integer format: int32
UI_Element (optional)
AutoID_Control (optional)
UI_Element_Pattern (optional)
Pattern_Value (optional)
X_Path (optional)
Type (optional)
Value (optional)
Time (optional)
AppFile (optional)
AppFrame_1 (optional)
Location (optional)
Application (optional)
Data (optional)
API (optional)

Process Up

Name
ID
Integer format: int32

Task Up

Name
ID
Integer format: int32

TaskSummary Up

Name
ID
Integer format: int32
Events