spec.json

{ "openapi": "3.0.1", "info": { "title": "LEAPWORK API", "version": "v4" }, "paths": { "/api/v4/schedules": { "get": { "tags": [
"Integrations"
], "summary": "Get All Schedules", "description": "Returns a list of all schedules currently configured on the controller.\r\n\r\nThe returned list of schedules will give access to names and IDs of the schedules which is needed to call other endpoints in the API.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } } } } } } }, "/api/v4/run/{runId}": { "get": { "tags": [
"Integrations"
], "summary": "Get Run by Id", "description": "Returns all information about a scheduled run identified by the {runId}.\r\n\r\nThe {runId} used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "A unique Id for the individual run instance of a schedule",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunIntegrationInfo" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunIntegrationInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunIntegrationInfo" } } } } } } }, "/api/v4/run/{runId}/status": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Status by Run Id", "description": "Returns the run status of a specific scheduled run identified by the {runId}.\r\n\r\nThe {runId} used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "A unique Id for the individual run instance of a schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StatusApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusApiResponse" } } } } } } }, "/api/v4/schedules/hierarchy": { "get": { "tags": [
"Integrations"
], "summary": "Get Schedules Hierarchy", "description": "Returns hierarchy along with schedules information for all schedules currently configured on the controller.\r\n\r\nThe hierarchy has a limit upto 10 folder levels from the scheduler.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleInfoWithHierarchy" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleInfoWithHierarchy" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleInfoWithHierarchy" } } } } } } } }, "/api/v4/runItems/{runItemId}": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item by Id", "description": "Returns detailed information about a run of a flow in a schedule.\r\nThe run of the flow (RunItem) is identified by the Id of the RunItem.\r\nThe runItemId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"description": "Unique Id for the individual run instance of a flow in a run.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunItemIntegrationInfoV4" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunItemIntegrationInfoV4" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunItemIntegrationInfoV4" } } } } } } }, "/api/v4/schedules/run/{runId}": { "get": { "tags": [
"Integrations"
], "summary": "Get All Schedules", "description": "Returns a list of all schedules currently configured on the controller.\r\nThe returned list of schedules will give access to names and IDs of the schedules which is needed to call other endpoints in the API.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "Filter by run id.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } } } } } } }, "/api/v4/run/{runId}/runItemIds": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Ids by Run Id", "description": "Returns a list of the IDs of the RunItems generated by a scheduled run identified by the {runId}.\r\n\r\nThe {runId} used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "Unique Id for the individual run instance of a schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunItemIdsApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunItemIdsApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunItemIdsApiResponse" } } } } } } }, "/api/v4/schedules/{scheduleId}": { "get": { "tags": [
"Integrations"
], "summary": "Get Schedule by Id", "description": "Returns complete information about a schedule selected by the scheduleId.\r\nOn success the returned response consists of information like ‘Schedule Title’, ‘Id’, ‘DateModify’, ‘DateCreation’, ‘IsEnabled’ etc.\r\nThis information can be used to get the status of a specific schedule and call other endpoints in the API.\r\nThe scheduleId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "Unique identifier for a Schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleApiInfo" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ScheduleApiInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduleApiInfo" } } } } } } }, "/api/v4/schedules/{scheduleName}": { "get": { "tags": [
"Integrations"
], "summary": "Get All Schedules", "description": "Returns a list of all schedules currently configured on the controller.\r\nThe returned list of schedules will give access to names and IDs of the schedules which is needed to call other endpoints in the API.", "parameters": [
{
"name": "scheduleName",
"in": "path",
"description": "Filter by schedule name.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" } } } } } } } }, "/api/v4/schedules/{scheduleName}/paginated": { "get": { "tags": [
"Integrations"
], "summary": "Get All Schedules (Paginated)", "description": "Returns a list of all schedules currently configured on the controller.\r\nThe returned list of schedules will give access to names and IDs of the schedules which is needed to call other endpoints in the API.", "parameters": [
{
"name": "scheduleName",
"in": "path",
"description": "Filter by schedule name.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "filter by page Number.",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "perPage",
"in": "query",
"description": "filter by per page.",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleApiInfoPaginatedApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ScheduleApiInfoPaginatedApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduleApiInfoPaginatedApiResponse" } } } } } } }, "/api/v4/runItems/{runItemId}/video": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Video", "description": "'Get Run Item Video' endpoint returns a video file, identified by the RunItemId. \r\nRunItemID can be fetched from the Response Body of the 'Get Run Items Id by Run Id' endpoint.\r\nNote: If video recordings are enabled (default is enabled) each execution of a flow will have an associated video recording of the flow run.", "parameters": [
{
"name": "runItemId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "description": "File download", "format": "binary" } } } } } } }, "/api/v4/runItems/{runItemId}/report": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item PDF Report", "description": "'Get Run Item PDF Report' endpoint returns a pdf report file. \r\nRunItemID can be fetched from the Response Body of the 'Get Run Items Id by Run Id' endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "description": "PDF file download", "format": "binary" } } } } } } }, "/api/v4/flows/{flowId}/runItems/all": { "get": { "tags": [
"Integrations"
], "summary": "Get all run ids by flow id", "description": "Get All Run Ids by Flow Id returns a list of all RunItemId of a flow execution specified by the FlowId.\r\nRunItemId is a unique Id for the individual run instance of a flow.", "parameters": [
{
"name": "flowId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunItemIdsApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunItemIdsApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunItemIdsApiResponse" } } } } } } }, "/api/v4/flows/{flowId}/runItems/last": { "get": { "tags": [
"Integrations"
], "summary": "Get last run id by flow id", "description": "Get Last RunId by FlowId returns the RunItemId of a flow execution using the FlowId.\r\nRunItemId is a unique Id for the individual run instance of a flow.", "parameters": [
{
"name": "flowId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLastRunItemIdApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/GetLastRunItemIdApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLastRunItemIdApiResponse" } } } } } } }, "/api/v4/schedules/{scheduleId}/status": { "get": { "tags": [
"Integrations"
], "summary": "Get Schedule Run Status", "description": "Returns the execution status of a schedule identified by the scheduleId.\r\nThis endpoint is used to check the current execution state of schedule. E.g. to check if the schedule can be started on a different agent.\r\nThe scheduleId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "Unique identifier for schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StatusApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusApiResponse" } } } } } } }, "/api/v4/runItems/{runItemId}/subtitles": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Video Subtitles", "description": "'Get Run Item Video Subtitles' endpoint returns a subtitles file, identified by the RunItemId. \r\nRunItemID can be fetched from the Response Body of the 'Get Run Items Id by Run Id' endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "description": "File download", "format": "binary" } } } } } } }, "/api/v4/steps/{runListStepId}/flowInfos": { "get": { "tags": [
"Integrations"
], "summary": "Get flow titles by run list's step id", "description": "Get list of flow titles associated with specific step.", "parameters": [
{
"name": "runListStepId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunListStepFlowsResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunListStepFlowsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunListStepFlowsResponse" } } } } } } }, "/api/v4/runItems/{runItemId}/keyframes/{offset}": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Keyframes", "description": "The complete logging of running a flow consists of a number of keyframes.\r\nEach keyframe contains information about a specific point in time in the execution of the flow, i.e. starting an application, clicking a button etc.\r\nThis endpoint returns a list of keyframes of a run of a flow identified by the RunItemId, with the option of specifying a number of keyframes to offset to the list with.\r\nThe runItemId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"description": "Unique Id for the individual run instance of a flow in a test run.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of keyframes to offset. A keyframe is block execution information with log message and timestamp.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "offset",
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" } } } } } } } }, "/api/v4/schedules/{scheduleId}/runIds/{filterBy}": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Ids by Schedule Id", "description": "Returns a list of the IDs of the run instances generated by a schedule identified by the scheduleId.\r\nThe scheduleId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "Unique identifier for schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "filterBy",
"in": "query",
"description": "Filter paramter for schedules",
"schema": {
"type": "string"
}
},
{
"name": "filterBy",
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "'count' specifies the number of the last run ids to return. If value is 0, returns all. Specifies the number of days for the 'LastDays' filter.",
"schema": {
"type": "string",
"format": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunIdsApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunIdsApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunIdsApiResponse" } } } } } } }, "/api/v4/runItems/{runItemId}/screenshot/{screenshotId}": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Screenshot By ScreenshotId", "description": "'Get Run Item Screenshot By ScreenshotId' endpoint returns an image captured as a screenshot (Log Screenshot) in a flow identified by the RunItemId.\r\nScreenshots can be added at multiple points within a flow.\r\nEach screenshot has a ScreenshotId associated which can be fetched from the Response Body of the 'Get Run Item Keyframes' endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "screenshotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "description": "File download", "format": "binary" } } } } } } }, "/api/v4/runItems/{runItemId}/keyframes/{offset}/{blockTitle}/{logMessage}": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Keyframes", "description": "The complete logging of running a flow consists of a number of keyframes.\r\nEach keyframe contains information about a specific point in time in the execution of the flow, i.e. starting an application, clicking a button etc.\r\nThis endpoint returns a list of keyframes of a run of a flow identified by the RunItemId, with the option of specifying a number of keyframes to offset to the list with.\r\nThe runItemId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"description": "Unique Id for the individual run instance of a flow in a test run.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of keyframes to offset. A keyframe is block execution information with log message and timestamp.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "blockTitle",
"in": "path",
"description": "Filter by block title.",
"schema": {
"type": "string"
}
},
{
"name": "logMessage",
"in": "path",
"description": "Filter by log message.",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" } } } } } } } }, "/api/v4/runItems/{runItemId}/keyframes/{offset}/{blockTitle}/{logMessage}/paginated": { "get": { "tags": [
"Integrations"
], "summary": "Get Run Item Keyframes (Paginated)", "description": "The complete logging of running a flow consists of a number of keyframes.\r\nEach keyframe contains information about a specific point in time in the execution of the flow, i.e. starting an application, clicking a button etc.\r\nThis endpoint returns a list of keyframes of a run of a flow identified by the RunItemId, with the option of specifying a number of keyframes to offset to the list with.\r\nThe runItemId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runItemId",
"in": "path",
"description": "Unique Id for the individual run instance of a flow in a test run.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of keyframes to offset. A keyframe is block execution information with log message and timestamp.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "blockTitle",
"in": "path",
"description": "Filter by block title.",
"schema": {
"type": "string"
}
},
{
"name": "logMessage",
"in": "path",
"description": "Filter by log message.",
"schema": {
"type": "string"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "filter by page Number.",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "perPage",
"in": "query",
"description": "filter by per page.",
"schema": {
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "offset",
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyFrameIntegrationInfoPaginatedApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/KeyFrameIntegrationInfoPaginatedApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeyFrameIntegrationInfoPaginatedApiResponse" } } } } } } }, "/api/v4/run/{runId}/stop": { "put": { "tags": [
"Integrations"
], "summary": "Stop Schedule by Run Id", "description": "Stop an already running schedule identified by its {runId}.\r\n\r\nThe {runId} is a unique Id for the individual instance run of a schedule.\r\n\r\nOn successful stop of a run, the end-point will return ‘true’ in the response body.\r\n\r\nThe {runId} used as input can be obtained from the endpoint.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "A unique Id for the individual run instance of a schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StopApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StopApiResponse" } } } } } } }, "/api/v4/run/{runId}/reRunOnAgents": { "put": { "tags": [
"Integrations"
], "summary": "Re-Run on Agents", "description": "Triggers a run identified by the {runId}.\r\n\r\n'Start Run Now' endpoint re-triggers a schedule identified by the runId. The response is a new runId, which is a unique value for the specific run. \r\nThe runId is generated from the 'Run Schedule Now' endpoint.\r\nIn the configuration of a schedule using Leapwork Studio, it is possible to define variables and assign values to the variables.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "Unique identifier for a run.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "Re-run options", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ApiRerunOptions" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiRerunOptions" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiRerunOptions" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApiRerunOptions" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRunApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StartRunApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StartRunApiResponse" } } } } } } }, "/api/v4/run/{runId}/reRun/{agentId}": { "put": { "tags": [
"Integrations"
], "summary": "Re-Run", "description": "Triggers a run identified by the runId.\r\n'Start Run Now' endpoint re-triggers a schedule identified by the runId. The response is a new runId, which is a unique value for the specific run. \r\nThe runId is generated from the 'Run Schedule Now' endpoint.\r\nIn the configuration of a schedule using Leapwork Studio, it is possible to define variables and assign values to the variables.", "parameters": [
{
"name": "runId",
"in": "path",
"description": "Unique identifier for a run.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "agentId",
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "var1",
"in": "query",
"description": "The value of 'var1' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "var2",
"in": "query",
"description": "The value of 'var2' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRunApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StartRunApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StartRunApiResponse" } } } } } } }, "/api/v4/schedules/{scheduleId}/stop": { "put": { "tags": [
"Integrations"
], "summary": "Stop Schedule by Schedule Id", "description": "Stops an already running schedule identified by the scheduleId.\r\nOn the successful stop of a schedule, the endpoint will return ‘true’ in the response body.\r\nThe scheduleId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "Unique identifier for a schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/StopApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StopApiResponse" } } } } } } }, "/api/v4/schedules/{scheduleId}/runNow": { "put": { "tags": [
"Integrations"
], "summary": "Run Schedule Now", "description": "Triggers a schedule identified by the scheduleId.\r\nThis endpoint is used a lot for integration with Continuous integration (CI) system to trigger collections of automation cases as part of a greater release plan.\r\nIn the configuration of a schedule using Leapwork Studio, it is possible to define variables and assign values to the variables.\r\nIt is also possible to set the values of the variables using this endpoint, by adding the nae of the variable and the value as GET parameters in the calling URL.\r\nThe scheduleId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "scheduleId",
"in": "path",
"description": "Unique identifier for a schedule.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "var1",
"in": "query",
"description": "The value of 'var1' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "var2",
"in": "query",
"description": "The value of 'var2' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunScheduleApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunScheduleApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunScheduleApiResponse" } } } } } } }, "/api/v4/flows/{flowId}/agent/{agentId}": { "put": { "tags": [
"Integrations"
], "summary": "Run Flow by Id", "description": "The Run Flow by Id endpoint runs a flow on an agent by creating a temporary schedule, using the flowId and agentId. The response is a runId, which is a unique value for a specific run of the triggered schedule.\r\nFlowId can be fetched by passing flowId to the endpoint.\r\nThis endpoint can be used to rerun failed tests or a single test on a specific agent.", "parameters": [
{
"name": "flowId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "isDelete",
"in": "query",
"description": "The value of 'isDelete' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "var1",
"in": "query",
"description": "The value of 'var1' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "var2",
"in": "query",
"description": "The value of 'var2' can be used dynamically in the automation flows as schedule variable",
"schema": {
"type": "string",
"format": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunScheduleApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/RunScheduleApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunScheduleApiResponse" } } } } } } }, "/api/v4/agents": { "get": { "tags": [
"Agent"
], "summary": "Get All Agents", "description": "Returns a list of all agents currently configured on the controller.\r\nEach agent contains a list of schedules which use this agent\r\nThe returned list of agents will give access to names and IDs of the agents which is needed to call other endpoints in the API.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentApiInfo" } } } } } } } }, "/api/v4/agents/{agentId}": { "get": { "tags": [
"Agent"
], "summary": "Get Agent by Id", "description": "Returns complete information about an agent selected by the agentId.\r\nOn success the returned response consists of common information like ‘Agent Title’, ‘Id’, ‘DateModify’, ‘DateCreation’, ‘IsEnabled’ etc,\r\nand specific information dependent on agent type.\r\n\r\nThe agentId used as input can be obtained from the endpoint.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentApiInfo" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AgentApiInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentApiInfo" } } } } } } }, "/api/v4/agents/agentsStatuses": { "get": { "tags": [
"Agent"
], "summary": "Get all agents connection statuses", "description": "Returns complete information about all agents' connection status (can it be connected or not).", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentConnectionStatusApiResult" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentConnectionStatusApiResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentConnectionStatusApiResult" } } } } } } } }, "/api/v4/agents/agentStatus/{agentId}": { "get": { "tags": [
"Agent"
], "summary": "Get agent's connection status", "description": "Returns complete information about an agent's connection status selected by the agentId (can it be connected or not).", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentConnectionStatusApiResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AgentConnectionStatusApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AgentConnectionStatusApiResult" } } } } } } }, "/api/v4/agents/create/saucelabs": { "put": { "tags": [
"Agent"
], "summary": "Create Sauce Labs", "description": "Used to create agent Sauce Labs.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/gridlastic": { "put": { "tags": [
"Agent"
], "summary": "Create Gridlastic", "description": "Used to create agent Gridlastic.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/lambdatest": { "put": { "tags": [
"Agent"
], "summary": "Create LambdaTest", "description": "Used to create agent LambdaTest.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/remoteagent": { "put": { "tags": [
"Agent"
], "summary": "Create Remote Agent", "description": "Used to create agent Remote Agent.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/browserstack": { "put": { "tags": [
"Agent"
], "summary": "Create Browser Stack", "description": "Used to create agent Browser Stack.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/seleniumgrid": { "put": { "tags": [
"Agent"
], "summary": "Create Selenium Grid", "description": "Used to create agent Selenium Grid.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/{teamId}/saucelabs": { "put": { "tags": [
"Agent"
], "summary": "Create Sauce Labs", "description": "Used to create agent Sauce Labs.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/{teamId}/gridlastic": { "put": { "tags": [
"Agent"
], "summary": "Create Gridlastic", "description": "Used to create agent Gridlastic.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/{teamId}/lambdatest": { "put": { "tags": [
"Agent"
], "summary": "Create LambdaTest", "description": "Used to create agent LambdaTest.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/update/saucelabs/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Sauce Labs", "description": "Used to update agent Sauce Labs.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/create/{teamId}/remoteagent": { "put": { "tags": [
"Agent"
], "summary": "Create Remote Agent", "description": "Used to create agent Remote Agent.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/update/gridlastic/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Gridlastic", "description": "Used to update agent Gridlastic.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/lambdatest/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update LambdaTest", "description": "Used to update agent LambdaTest.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/create/{teamId}/browserstack": { "put": { "tags": [
"Agent"
], "summary": "Create Browser Stack", "description": "Used to create agent Browser Stack.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/create/{teamId}/seleniumgrid": { "put": { "tags": [
"Agent"
], "summary": "Create Selenium Grid", "description": "Used to create agent Selenium Grid.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgentResponse" } } } } } } }, "/api/v4/agents/update/remoteagent/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Remote Agent", "description": "Used to update agent Remote Agent.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/browserstack/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Browser Stack", "description": "Used to update agent Browser Stack.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/seleniumgrid/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Selenium Grid", "description": "Used to update agent Selenium Grid.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Unique identifier for an Agent.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/{teamId}/saucelabs/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Sauce Labs", "description": "Used to update agent Sauce Labs.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SauceLabsInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/{teamId}/gridlastic/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Gridlastic", "description": "Used to update agent Gridlastic.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GridlasticInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/{teamId}/lambdatest/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update LambdaTest", "description": "Used to update agent LambdaTest.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LambdaTestInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/{teamId}/remoteagent/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Remote Agent", "description": "Used to update agent Remote Agent.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoteAgentInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/{teamId}/browserstack/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Browser Stack", "description": "Used to update agent Browser Stack.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BrowserStackInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/update/{teamId}/seleniumgrid/{agentId}": { "put": { "tags": [
"Agent"
], "summary": "Update Selenium Grid", "description": "Used to update agent Selenium Grid.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SeleniumGridInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAgentResponse" } } } } } } }, "/api/v4/agents/delete/{agentId}": { "delete": { "tags": [
"Agent"
], "summary": "Deleting Remote Agent", "description": "To understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAgentResponse" } } } } } } }, "/api/v4/agents/delete/{teamId}/{agentId}": { "delete": { "tags": [
"Agent"
], "summary": "Deleting Remote Agent", "description": "To understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agentId",
"in": "path",
"description": "Environment identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAgentResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteAgentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAgentResponse" } } } } } } }, "/api/v4/variables": { "get": { "tags": [
"Variables"
], "summary": "Get All Variables", "description": "Returns list of all permanent variables.\r\nThese variables are static across the Leapwork Controller and should not be confused with the variables used to trigger a Schedule.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableProxy" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableProxy" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VariableProxy" } } } } } } }, "put": { "tags": [
"Variables"
], "summary": "Edit Variable by Name", "description": "Updates the value of a permanent variable identified by the requestBody.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } } } } } } }, "/api/v4/variables/{name}": { "get": { "tags": [
"Variables"
], "summary": "Get Variable by Name", "description": "Returns details of a specific permanent variable identified by the variable name.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "name",
"in": "path",
"description": "Name of the variable.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/VariableProxy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VariableProxy" } } } } } } }, "/api/v4/export/{timeoutMinutes}/{targetItemId}": { "get": { "tags": [
"ImportExport"
], "summary": "Export", "description": "'Export' endpoint returns a zip file containing all assets ('Folder', 'Runlist', 'Flow', 'DataFile', 'SubFlow', etc.) on the basis of an itemId.\r\nThe itemId is a unique Id of an element in the asset menu.\r\nIf an itemId is not supplied the endpoint will export all assets in the asset menu available in the controller. \r\nThe output zip file can be used as input parameter to the 'Import' end point or can be imported manually in Leapwork Studio.\r\n\r\nBe noticed that 'targetItemId' must be an itemId of Folder(containing flows) or Flow.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "timeoutMinutes",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "targetItemId",
"in": "query",
"description": "",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "exportType",
"in": "query",
"description": "Set ExportType to 0 or blank for Flow Export, and 1 for Runlist Export.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "description": "File download", "format": "binary" } } } } } } }, "/api/v4/export/{teamId}/{timeoutMinutes}/{targetItemId}": { "get": { "tags": [
"ImportExport"
], "summary": "Export", "description": "'Export' endpoint returns a zip file containing all assets ('Folder', 'Runlist', 'Flow', 'DataFile', 'SubFlow', etc.) on the basis of an itemId.\r\nThe itemId is a unique Id of an element in the asset menu.\r\nIf an itemId is not supplied the endpoint will export all assets in the asset menu available in the controller. \r\nThe output zip file can be used as input parameter to the 'Import' end point or can be imported manually in Leapwork Studio.\r\n\r\nBe noticed that 'targetItemId' must be an itemId of Folder(containing flows) or Flow.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "timeoutMinutes",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "targetItemId",
"in": "query",
"description": "",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "exportType",
"in": "query",
"description": "Set ExportType to 0 or blank for Flow Export, and 1 for Runlist Export.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "description": "File download", "format": "binary" } } } } } } }, "/api/v4/import/{timeoutMinutes}/{targetItemId}": { "post": { "tags": [
"ImportExport"
], "summary": "Import", "description": "'Import' is used to import already exported zip file to the Controller.\r\nThis endpoint can be used to move flows from one controller another.\r\n \r\nBe noticed that 'targetItemId' must be an itemId of Folder.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "timeoutMinutes",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "targetItemId",
"in": "query",
"description": "",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "importType",
"in": "query",
"description": "Set ImportType to 0 or blank for Flow Import, and 1 for Runlist Import.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force mode locks all user-opened flows which should be replaced during import caused by title collision",
"schema": {
"type": "string",
"format": "string"
}
}
], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [
"zip file"
], "type": "object", "properties": { "zip file": { "type": "string", "description": "Upload zip file to import", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ImportApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportApiResponse" } } } } } } }, "/api/v4/import/{teamId}/{timeoutMinutes}/{targetItemId}": { "post": { "tags": [
"ImportExport"
], "summary": "Import", "description": "'Import' is used to import already exported zip file to the Controller.\r\nThis endpoint can be used to move flows from one controller another.\r\n \r\nBe noticed that 'targetItemId' must be an itemId of Folder.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "teamId",
"in": "path",
"description": "Team identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "timeoutMinutes",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "targetItemId",
"in": "query",
"description": "",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "importType",
"in": "query",
"description": "Set ImportType to 0 or blank for Flow Import, and 1 for Runlist Import.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force mode locks all user-opened flows which should be replaced during import caused by title collision",
"schema": {
"type": "string",
"format": "string"
}
}
], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [
"zip file"
], "type": "object", "properties": { "zip file": { "type": "string", "description": "Upload zip file to import", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ImportApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportApiResponse" } } } } } } }, "/api/v4/hierarchy/{itemId}": { "get": { "tags": [
"FlowHierarchy"
], "summary": "Get Hierarchy", "description": "Returns a hierarchical list of the Asset Menu (Folders, flows, data etc.). \r\nThe returned hierarchy contains detailed information about the following types of items: 'Folder', 'Flow', 'DataFile', 'SubFlow', 'InteractiveImage', 'DesktopElement', 'WebElement', 'InteractiveImageCollection'.\r\n \r\nThe ItemIDs in the hierarchy can be used as 'targetItemId' for the Import/Export endpoints.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "itemId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetHierarchyApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetHierarchyApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetHierarchyApiInfo" } } } } } } } }, "/api/v4/hierarchy/flowinfo/{itemId}": { "get": { "tags": [
"FlowHierarchy"
], "summary": "Get Flow Info", "description": "Returns information of a Flow or Sub-flow. \r\nThe returned information contains detailed information about 'Flow', 'SubFlow'.\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowInfoResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/FlowInfoResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlowInfoResponse" } } } } } } }, "/api/v4/hierarchy/create/folder/{itemId}": { "put": { "tags": [
"FlowHierarchy"
], "summary": "Create Folder Hierarchy", "description": "Creates folder or folder hierarchy with corresponding title(s) in 'folder' parameter\r\n \r\nTo create folder hierarchy enter folder titles one after another separated by '/' symbol\r\n \r\nThe ItemID is the hierarchy item id in which folder hierarchy is going to be created.\r\nIf item is null or empty, folder hierarchy will be created in the root folder\r\n \r\nIf ItemId cannot create folder, returns 400 error\r\n\r\nIf ItemId already contains non-folder item with the same title, returns 409 (Conflict) error\r\n\r\nIf ItemId already contains hierarchy, equal to which one is going to be created, returns 409 (Conflict) error\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "itemId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "folder",
"in": "query",
"description": "Enter here folder name or several names using '/' separator to create folder hierarchy",
"schema": {
"type": "string",
"format": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedHierarchyItemApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreatedHierarchyItemApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatedHierarchyItemApiResponse" } } } } } } }, "/api/v4/hierarchy/create/folder/{teamId}/{itemId}": { "put": { "tags": [
"FlowHierarchy"
], "summary": "Create Folder Hierarchy", "description": "Creates folder or folder hierarchy with corresponding title(s) in 'folder' parameter\r\n \r\nTo create folder hierarchy enter folder titles one after another separated by '/' symbol\r\n \r\nThe TeamId is unique identifier of the Team\r\n\r\nThe ItemID is the hierarchy item id in which folder hierarchy is going to be created.\r\nIf item is null or empty, folder hierarchy will be created in the root folder\r\n \r\nIf ItemId cannot create folder, returns 400 error\r\n\r\nIf ItemId already contains non-folder item with the same title, returns 409 (Conflict) error\r\n\r\nIf ItemId already contains hierarchy, equal to which one is going to be created, returns 409 (Conflict) error\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "teamId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "itemId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "folder",
"in": "query",
"description": "Enter here folder name or several names using '/' separator to create folder hierarchy",
"schema": {
"type": "string",
"format": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedHierarchyItemApiResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreatedHierarchyItemApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatedHierarchyItemApiResponse" } } } } } } }, "/api/v4/license/all": { "get": { "tags": [
"License"
], "summary": "Get all licenses, including expired", "description": "Get All Licenses returns a list of all active and expired licenses residing on the Controller. The returned list of licences will give access to LicenseId, DateActivated, ExpireDays, and LicenseType licenses. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseApiInfo" } } } } } } } }, "/api/v4/license/active": { "get": { "tags": [
"License"
], "summary": "Get all active licenses", "description": "Get Active License returns all active licenses on the Controller. The returned licences will give access to LicenseId, DateActivated, ExpireDays, and LicenseType licenses.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseApiInfo" } } } } } } } }, "/api/v4/license/controllerId": { "get": { "tags": [
"License"
], "summary": "Get controller id", "description": "The Get Controller Id returns the unique machine ID of the Controller machine. The licenses are tied up with this machine ID. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerApiInfo" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/ControllerApiInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControllerApiInfo" } } } } } } }, "/api/v4/license/refresh-license": { "get": { "tags": [
"License"
], "summary": "Refresh license", "description": "Refresh license api refreshes the license of the Controller machine. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseApiInfo" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LicenseApiInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LicenseApiInfo" } } } } } } }, "/api/v4/license/activate": { "put": { "tags": [
"License"
], "summary": "Tries to activate input license", "description": "Activate License returns recently activated licenses on the controller. The returned licences will give access to LicenseId, DateActivated, ExpireDays, and LicenseType. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "If force is true, active license will be replaced by this one (in case when you want to replace trial license).",
"schema": {
"type": "string",
"format": "string"
}
}
], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "description": "Enter base64 string that represents license", "format": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseApiInfo" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/LicenseApiInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LicenseApiInfo" } } } } } } }, "/api/v4/team/all": { "get": { "tags": [
"Team"
], "summary": "Get all teams", "description": "Get All Teams returns a list of teams. The returned list of teams will give access to Id, Title, DateActivated, DateCreation, DateModify, CreatedBy, and ModifiedBy. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamApiInfo" } } } } } } } }, "/api/v4/user/all": { "get": { "tags": [
"User"
], "summary": "Get All Users", "description": "Returns a list of both Leapwork and Active Directory users. \r\nThe returned list of users will give access to Id, Username, Usertype, Fullname, LastActiveDate and TeamNames. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiInfo" } } } } } } } }, "/api/v4/user/notActive/{date}/{teamId}": { "get": { "tags": [
"User"
], "summary": "Get Users not active since a date", "description": "Returns a list of both Leapwork and Active Directory users. \r\nThe returned list of users will give access to Id, Username, Usertype, Fullname, LastActiveDate and TeamNames. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "date",
"in": "path",
"description": "Date since which user has not been active",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "teamId",
"in": "path",
"description": "Optional Team id of users",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiInfo" } } } } } } } }, "/api/v4/user/new": { "put": { "tags": [
"User"
], "summary": "Create User", "description": "Used to create new Leapwork user(with no team(s)). \r\nFor Leapwork Enterprise Edition, this ‘Create User’ endpoint along with ‘Add User To Teams’ endpoint is used to create user with different teams. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to create new user. Access can have possible values - Reader, NoAccess, Contributor, Administrator", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewUserInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewUserInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewUserInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewUserInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/CreateUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserResponse" } } } } } } }, "/api/v4/user/password/{userId}": { "put": { "tags": [
"User"
], "summary": "Update User Password", "description": "Used to update existing Leapwork user’s password using userId. \r\nThe userId used as the input can be obtained from the 'Get All Users' endpoint with UserType as 'Leapwork'.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "userId",
"in": "path",
"description": "User id for whom password is to be changed",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserPasswordInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPasswordInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPasswordInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserPasswordInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } } } } } } }, "/api/v4/user/{userId}/AddUserToTeams": { "put": { "tags": [
"User"
], "summary": "Add User To Teams", "description": "Used to add an existing Leapwork or Active Directory user to multiple teams in the Leapwork application, using userId and TeamIds.\r\nThe userId used as the input can be obtained from the 'Get All Users' endpoint with UserType as 'Leapwork' or 'ActiveDirectory'.\r\nThe TeamIds used as the input can be obtained from the 'Get All Teams' endpoint. \r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "userId",
"in": "path",
"description": "User id for whom id needs to be addded in teams",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body to add user to teams.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } } } } } } }, "/api/v4/user/{userId}": { "delete": { "tags": [
"User"
], "summary": "Delete User By userId", "description": "Used to delete an existing Leapwork or Active Directory user from the Leapwork application, using userId. \r\nThe userId used as the input can be obtained from the 'Get All Users' endpoint with UserType as 'Leapwork' or 'ActiveDirectory'.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "userId",
"in": "path",
"description": "User id to delete",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteUserResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DeleteUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteUserResponse" } } } } } } }, "/api/v4/user/{userId}/RemoveUserFromTeams": { "delete": { "tags": [
"User"
], "summary": "Remove User From Teams", "description": "Used to remove an existing Leapwork or Active Directory user from multiple teams in the Leapwork application, using userId and TeamIds. \r\nThe userId used as the input can be obtained from the 'Get All Users' endpoint with UserType as 'Leapwork' or 'ActiveDirectory'.\r\nThe TeamIds used as the input can be obtained from the 'Get All Teams' endpoint.\r\n\r\nTo understand more about using this endpoint, please read the documentation.", "parameters": [
{
"name": "userId",
"in": "path",
"description": "User id for whom needs to be removed from provided teams",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "requestBody": { "description": "The request body which contains Team Id's to delete from", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserTeamInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } } } } } } }, "/api/v4/auditlogs/export": { "get": { "tags": [
"AuditLogs"
], "summary": "Export Audit Logs", "description": "returns a list of audit log entries between fromDate and toDate in json format.", "parameters": [
{
"name": "fromDate",
"in": "query",
"description": "\r\nInput format:-\r\n\r\nyyyy-MM-dd HH:mm\r\n\r\nOr\r\n\r\nyyyy-MM-dd\r\n\r\nPlease add the time in local time zone of controller machine. The time will be converted to UTC.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "toDate",
"in": "query",
"description": "\r\nInput format:-\r\n\r\nyyyy-MM-dd HH:mm\r\n\r\nOr\r\n\r\nyyyy-MM-dd\r\n\r\nPlease add the time in local time zone of controller machine. The time will be converted to UTC.",
"schema": {
"type": "string"
}
},
{
"name": "accessKey",
"in": "header",
"description": "An access key is required to restrict unauthorized access to the API.",
"required": true,
"schema": {
"type": "string"
}
}
], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogsInfo" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogsInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogsInfo" } } } } } } } } }, "components": { "schemas": { "AgentApiInfo": { "type": "object", "properties": { "Team": { "$ref": "#/components/schemas/TeamApiShortInfo" }, "UsedBySchedules": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleIntegrationInfo" }, "nullable": true }, "HostName": { "type": "string", "nullable": true }, "Port": { "type": "integer", "format": "int32" }, "DisplayWidth": { "type": "integer", "format": "int32" }, "DisplayHeight": { "type": "integer", "format": "int32" }, "Display": { "type": "integer", "format": "int32" }, "Browser": { "$ref": "#/components/schemas/BrowserName" }, "BrowserWidth": { "type": "integer", "format": "int32" }, "BrowserHeight": { "type": "integer", "format": "int32" }, "BrowserVersion": { "type": "string", "nullable": true }, "UserAgent": { "type": "string", "nullable": true }, "UserProfile": { "type": "string", "nullable": true }, "UserName": { "type": "string", "nullable": true }, "OSType": { "$ref": "#/components/schemas/SeleniumGridPlatformType" }, "OS": { "type": "string", "nullable": true }, "OSVersion": { "type": "string", "nullable": true }, "MobileDevice": { "type": "string", "nullable": true }, "MobileDeviceOrientation": { "$ref": "#/components/schemas/MobileDeviceOrientation" }, "PixelRatio": { "type": "number", "format": "double" }, "IsWebLocal": { "type": "boolean", "nullable": true }, "LocalIdentifier": { "type": "string", "nullable": true }, "SapLogonMode": { "$ref": "#/components/schemas/SAPLogonMode" }, "TerminalApplication": { "$ref": "#/components/schemas/SupportedTerminalApp" }, "IsDisabled": { "type": "boolean" }, "ConnectionTimeout": { "type": "integer", "format": "int32" }, "ConnectionType": { "$ref": "#/components/schemas/EnvironmentConnectionType" }, "Description": { "type": "string", "nullable": true }, "DateCreation": { "$ref": "#/components/schemas/DapperDateTimeOffset" }, "DateModify": { "$ref": "#/components/schemas/DapperDateTimeOffset" }, "Title": { "type": "string", "nullable": true }, "Type": { "$ref": "#/components/schemas/EnumAssetHierarchyType" }, "Id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AgentAuthenticationType": { "enum": [
"WindowsLogin",
"WindowsAutoLogin",
"Password"
], "type": "string" }, "AgentConnectionStatus": { "enum": [
"Unknown",
"Available",
"Unavailable"
], "type": "string" }, "AgentConnectionStatusApiResult": { "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid" }, "Title": { "type": "string", "nullable": true }, "Host": { "type": "string", "nullable": true }, "Port": { "type": "integer", "format": "int32" }, "ConnectionStatus": { "$ref": "#/components/schemas/AgentConnectionStatus" }, "BlockedByLicense": { "$ref": "#/components/schemas/AgentLicenseBlockState" } }, "additionalProperties": false }, "AgentIntegrationInfo": { "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid", "readOnly": true }, "AgentTitle": { "type": "string", "nullable": true, "readOnly": true }, "ConnectionType": { "$ref": "#/components/schemas/EnvironmentConnectionType" } }, "additionalProperties": false }, "AgentLicenseBlockState": { "enum": [
"Unknown",
"Disabled",
"Available"
], "type": "string" }, "ApiRerunOptions": { "type": "object", "properties": { "Variables": { "type": "array", "items": { "$ref": "#/components/schemas/ApiScheduleVariable" }, "nullable": true }, "Steps": { "type": "array", "items": { "$ref": "#/components/schemas/ApiScheduleStep" }, "nullable": true } }, "additionalProperties": false }, "ApiRunItemFailReason": { "enum": [
"None",
"ConnectionFailed",
"FlowExecutionFailed",
"StartApplicationFailed"
], "type": "string" }, "ApiRunItemStatus": { "enum": [
"NoStatus",
"Passed",
"Failed",
"Done",
"Cancelled",
"Error",
"IsProcessing"
], "type": "string" }, "ApiRunType": { "enum": [
"Undefined",
"Preview",
"Scheduled",
"Manual"
], "type": "string" }, "ApiScheduleStep": { "type": "object", "properties": { "RunListStepId": { "type": "string", "format": "uuid" }, "AgentIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "EnvironmentParallelization": { "$ref": "#/components/schemas/EnvironmentParallelization" }, "StartOrder": { "$ref": "#/components/schemas/RunListStepStartOrder" } }, "additionalProperties": false }, "ApiScheduleVariable": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssetHierarchyApiInfo": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "readOnly": true }, "InfoId": { "type": "string", "format": "uuid", "readOnly": true }, "Title": { "type": "string", "nullable": true, "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Description": { "type": "string", "nullable": true, "readOnly": true }, "PreviousSiblingId": { "type": "string", "format": "uuid", "readOnly": true }, "ParentId": { "type": "string", "format": "uuid", "readOnly": true }, "DateCreation": { "type": "string", "nullable": true }, "DateModify": { "type": "string", "nullable": true }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/AssetHierarchyApiInfo" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AuditLogsInfo": { "type": "object", "properties": { "Date": { "type": "string", "nullable": true }, "IPAddress": { "type": "string", "nullable": true }, "Hostname": { "type": "string", "nullable": true }, "UserOrSystem": { "type": "string", "nullable": true }, "Team": { "type": "string", "nullable": true }, "Event": { "type": "string", "nullable": true }, "Asset": { "type": "string", "nullable": true }, "Details": { "type": "string", "nullable": true }, "UserComment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BrowserName": { "enum": [
"NotDefined",
"Chrome",
"Firefox",
"Edge",
"InternetExplorer",
"Opera",
"Safari",
"Android",
"iPhone",
"iPad",
"ChromiumEdge",
"Electron",
"AppiumBrowser",
"EdgeIEMode"
], "type": "string" }, "BrowserStackInfo": { "type": "object", "properties": { "IsWebLocal": { "type": "boolean" }, "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "UserName": { "type": "string", "nullable": true }, "AccessKey": { "type": "string", "nullable": true }, "LocalIdentifier": { "type": "string", "nullable": true }, "OSType": { "$ref": "#/components/schemas/SeleniumGridPlatformType" }, "OSVersion": { "type": "string", "nullable": true }, "Browser": { "$ref": "#/components/schemas/BrowserName" }, "BrowserVersion": { "type": "string", "nullable": true }, "ScreenResolution": { "$ref": "#/components/schemas/ResolutionInfo" } }, "additionalProperties": false }, "ControllerApiInfo": { "type": "object", "properties": { "ControllerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAgentResponse": { "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid" }, "IsSuccessful": { "type": "boolean" } }, "additionalProperties": false }, "CreateUserResponse": { "type": "object", "properties": { "UserId": { "type": "string", "format": "uuid" }, "OperationCompleted": { "type": "boolean" } }, "additionalProperties": false }, "CreatedHierarchyItemApiResponse": { "type": "object", "properties": { "HierarchyItemId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "DapperDateTimeOffset": { "type": "object", "properties": { "Value": { "type": "string", "format": "date-time" }, "LocalDateTime": { "type": "string", "format": "date-time", "readOnly": true }, "UtcDateTime": { "type": "string", "format": "date-time", "readOnly": true }, "Ticks": { "type": "integer", "format": "int64", "readOnly": true } }, "additionalProperties": false }, "DeleteAgentResponse": { "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid" }, "IsSuccessful": { "type": "boolean" } }, "additionalProperties": false }, "DeleteUserResponse": { "type": "object", "properties": { "OperationCompleted": { "type": "boolean" } }, "additionalProperties": false }, "EnumAssetHierarchyType": { "enum": [
"Folder",
"Environment",
"InteractiveImage",
"ElectronElement",
"WebElement",
"DesktopElement",
"DataFile",
"SapElement",
"GreenScreenElement",
"MobileElement",
"ScheduleInfo",
"TemporaryScheduleInfo",
"SubFlow",
"ReportInfo",
"Flow",
"RunList",
"InteractiveImageCollection",
"WebElementCollection",
"DesktopElementCollection",
"Dashboard",
"SeleniumGridWebConnection",
"SauceLabsWebConnection",
"BrowserStackWebConnection",
"LambdaTestWebConnection",
"GridlasticWebConnection",
"AppiumServerMobileConnection",
"HeadSpinMobileConnection",
"SauceLabsMobileConnection",
"BrowserStackMobileConnection",
"LambdaTestMobileConnection",
"LdapConnection",
"AzureAdConnection",
"AzureDevOpsConnection",
"MicrosoftSharePointConnection",
"AgentConfiguration",
"RootFolderContextMenuItem",
"OktaSso"
], "type": "string" }, "EnvironmentConnectionType": { "enum": [
"RemoteAgent",
"Local",
"SauceLabs",
"SeleniumGrid",
"BrowserStack",
"Gridlastic",
"LambdaTest",
"LeapworkCloudAgent"
], "type": "string" }, "EnvironmentParallelization": { "enum": [
"RunAllFlows",
"RunFlowsOnce",
"RunFlowsOnFirstAvailableAgent"
], "type": "string" }, "FlowInfoResponse": { "type": "object", "properties": { "TimeoutSeconds": { "type": "integer", "format": "int32", "nullable": true }, "DefaultTimeoutSec": { "type": "integer", "format": "int32", "nullable": true }, "AssigneeUserId": { "type": "string", "format": "uuid", "nullable": true }, "AgentConfigurationId": { "type": "string", "format": "uuid", "nullable": true }, "Description": { "type": "string", "nullable": true }, "DateCreation": { "type": "string", "nullable": true }, "DateModify": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Type": { "$ref": "#/components/schemas/EnumAssetHierarchyType" }, "IsDeleted": { "type": "boolean" } }, "additionalProperties": false }, "FlowIntegrationInfo": { "type": "object", "properties": { "FlowId": { "type": "string", "format": "uuid", "readOnly": true }, "FlowTitle": { "type": "string", "nullable": true, "readOnly": true }, "Status": { "$ref": "#/components/schemas/ApiRunItemStatus" }, "FlowVersionNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowShortInfo": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlowStatusEnum": { "enum": [
"NoStatus",
"Initializing",
"Connecting",
"Connected",
"Running",
"Passed",
"Failed",
"Timeout",
"Inconclusive",
"Cancelled",
"Error",
"Done",
"LoggedId",
"Disconnected",
"Skipped",
"BrokenFlow",
"Preparing",
"LeapworkCopilotInvestigation"
], "type": "string" }, "GetLastRunItemIdApiResponse": { "type": "object", "properties": { "RunItemId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GridlasticInfo": { "type": "object", "properties": { "Port": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "HubUserName": { "type": "string", "nullable": true }, "SubDomain": { "type": "string", "nullable": true }, "HubPassword": { "type": "string", "nullable": true }, "OSType": { "$ref": "#/components/schemas/SeleniumGridPlatformType" }, "OSVersion": { "type": "string", "nullable": true }, "Browser": { "$ref": "#/components/schemas/BrowserName" }, "BrowserVersion": { "type": "string", "nullable": true }, "ScreenResolution": { "$ref": "#/components/schemas/ResolutionInfo" } }, "additionalProperties": false }, "ImportApiResponse": { "type": "object", "properties": { "IsSuccessful": { "type": "boolean" } }, "additionalProperties": false }, "KeyFrameIntegrationInfo": { "type": "object", "properties": { "ScreenshotId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "FileId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "ErrorBlockType": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "ErrorBlockId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "ErrorBlockKeyframeMessage": { "type": "string", "nullable": true, "readOnly": true }, "AutomationRunItemId": { "type": "string", "format": "uuid" }, "Timestamp": { "$ref": "#/components/schemas/DapperDateTimeOffset" }, "Elapsed": { "type": "string", "format": "date-span" }, "Level": { "$ref": "#/components/schemas/LevelEnum" }, "Status": { "$ref": "#/components/schemas/FlowStatusEnum" }, "UsingMetadataTypes": { "$ref": "#/components/schemas/KeyframeMetadataTypeEnum" }, "BlockId": { "type": "string", "format": "uuid", "nullable": true }, "ParentBlockId": { "type": "string", "format": "uuid", "nullable": true }, "LogMessage": { "type": "string", "nullable": true }, "Order": { "type": "integer", "format": "int32" }, "BlockTitle": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "KeyFrameIntegrationInfoPaginatedApiResponse": { "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32", "nullable": true }, "TotalPages": { "type": "integer", "format": "int32", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/KeyFrameIntegrationInfo" }, "nullable": true }, "TotalRecords": { "type": "integer", "format": "int32" }, "Id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "KeyframeMetadataTypeEnum": { "enum": [
"None",
"Rect",
"Point",
"Line",
"Points",
"All"
], "type": "string" }, "LSignal": { "type": "object", "properties": { "Value": { "type": "object" } }, "additionalProperties": false }, "LambdaTestInfo": { "type": "object", "properties": { "HostName": { "type": "string", "nullable": true }, "Port": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "UserName": { "type": "string", "nullable": true }, "AccessKey": { "type": "string", "nullable": true }, "PlatformName": { "type": "string", "nullable": true }, "OSType": { "$ref": "#/components/schemas/SeleniumGridPlatformType" }, "OSVersion": { "type": "string", "nullable": true }, "Browser": { "$ref": "#/components/schemas/BrowserName" }, "BrowserVersion": { "type": "string", "nullable": true }, "MobileDevice": { "type": "string", "nullable": true }, "ScreenResolution": { "$ref": "#/components/schemas/ResolutionInfo" }, "CustomCapabilities": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LevelEnum": { "enum": [
"Trace",
"Info",
"Warning",
"Error"
], "type": "string" }, "LicenseApiInfo": { "type": "object", "properties": { "LicenseId": { "type": "string", "format": "uuid" }, "DateActivated": { "type": "string", "format": "date-time" }, "ExpireDays": { "type": "integer", "format": "int32" }, "LicenseType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MobileDeviceOrientation": { "enum": [
"Portrait",
"Landscape"
], "type": "string" }, "NewUserInfo": { "type": "object", "properties": { "FullName": { "type": "string", "nullable": true }, "UserName": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "ForceChangePasswordOnFirstLogin": { "type": "boolean" }, "Access": { "$ref": "#/components/schemas/UserApiAccess" } }, "additionalProperties": false }, "ProxyType": { "enum": [
"NoProxy",
"AutomaticDetection",
"AutomaticFromUrl",
"ManualSettings"
], "type": "string" }, "RemoteAgentInfo": { "type": "object", "properties": { "Port": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "HostName": { "type": "string", "nullable": true }, "AuthenticationType": { "$ref": "#/components/schemas/AgentAuthenticationType" }, "Password": { "type": "string", "nullable": true }, "WindowsLogin": { "type": "string", "nullable": true }, "WindowsPassword": { "type": "string", "nullable": true }, "LockSessionAfterDisconnect": { "type": "boolean" }, "ScreenResolution": { "$ref": "#/components/schemas/ResolutionInfo" }, "SapLogonMode": { "$ref": "#/components/schemas/SAPLogonMode" }, "TerminalApplication": { "$ref": "#/components/schemas/SupportedTerminalApp" }, "ProxyConfiguration": { "$ref": "#/components/schemas/WebProxyConfigurationInfo" }, "LockRecordingOnSelectedScreen": { "type": "boolean" } }, "additionalProperties": false }, "ReserveAgentsStrategyEnum": { "enum": [
"ReserveAllAgentsForStepBeforeStartingStep",
"ReserveAllAgentsForAllStepsBeforeStartingSchedule"
], "type": "string" }, "ResolutionInfo": { "type": "object", "properties": { "Width": { "type": "integer", "format": "int32" }, "Height": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RunIdsApiResponse": { "type": "object", "properties": { "RunIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RunIntegrationInfo": { "type": "object", "properties": { "RunId": { "type": "string", "format": "uuid" }, "Schedule": { "$ref": "#/components/schemas/ScheduleIntegrationInfo" }, "Status": { "$ref": "#/components/schemas/RunStatus" }, "Passed": { "type": "integer", "format": "int32", "readOnly": true }, "Failed": { "type": "integer", "format": "int32", "readOnly": true }, "Done": { "type": "integer", "format": "int32", "readOnly": true }, "Total": { "type": "integer", "format": "int32", "readOnly": true }, "ExecutionTotalTime": { "type": "string", "format": "date-span", "readOnly": true }, "ExecutionMilliseconds": { "type": "number", "format": "double", "readOnly": true }, "ExecutionSeconds": { "type": "number", "format": "double", "readOnly": true }, "RunFolderPath": { "type": "string", "nullable": true, "readOnly": true }, "CreatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "RunType": { "$ref": "#/components/schemas/ApiRunType" } }, "additionalProperties": false }, "RunItemIdsApiResponse": { "type": "object", "properties": { "RunItemIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RunItemIntegrationInfoV4": { "type": "object", "properties": { "RunItemId": { "type": "string", "format": "uuid", "readOnly": true }, "RunId": { "type": "string", "format": "uuid", "readOnly": true }, "FlowInfo": { "$ref": "#/components/schemas/FlowIntegrationInfo" }, "AgentInfo": { "$ref": "#/components/schemas/AgentIntegrationInfo" }, "Elapsed": { "type": "string", "format": "date-span", "readOnly": true }, "ElapsedMilliseconds": { "type": "number", "format": "double", "readOnly": true }, "ElapsedSeconds": { "type": "number", "format": "double", "readOnly": true }, "RunItemVideoURL": { "type": "string", "nullable": true }, "TimeStamp": { "type": "string", "format": "date-time", "readOnly": true }, "Status": { "$ref": "#/components/schemas/ApiRunItemStatus" }, "RetryAttempt": { "type": "integer", "format": "int32", "readOnly": true }, "FailReason": { "$ref": "#/components/schemas/ApiRunItemFailReason" } }, "additionalProperties": false }, "RunListStepFlowsResponse": { "type": "object", "properties": { "RunListStepId": { "type": "string", "format": "uuid" }, "FlowInfos": { "type": "array", "items": { "$ref": "#/components/schemas/FlowShortInfo" }, "nullable": true } }, "additionalProperties": false }, "RunListStepStartCondition": { "enum": [
"Always",
"OnlyPreviousStepSuccess",
"OnlyAllPreviousStepSuccess",
"AnyPreviousStepFailed"
], "type": "string" }, "RunListStepStartOrder": { "enum": [
"Defined",
"Random"
], "type": "string" }, "RunScheduleApiResponse": { "type": "object", "properties": { "RunId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "RunStatus": { "enum": [
"Queued",
"Executing",
"Finished"
], "type": "string" }, "SAPLogonMode": { "enum": [
"SAPLogonPAD",
"SAPLogon"
], "type": "string" }, "SauceLabsInfo": { "type": "object", "properties": { "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "UserName": { "type": "string", "nullable": true }, "AccessKey": { "type": "string", "nullable": true }, "OSType": { "$ref": "#/components/schemas/SeleniumGridPlatformType" }, "OSVersion": { "type": "string", "nullable": true }, "Browser": { "$ref": "#/components/schemas/BrowserName" }, "BrowserVersion": { "type": "string", "nullable": true }, "MobileDevice": { "type": "string", "nullable": true }, "ScreenResolution": { "$ref": "#/components/schemas/ResolutionInfo" } }, "additionalProperties": false }, "ScheduleApiInfo": { "type": "object", "properties": { "Recurring": { "$ref": "#/components/schemas/ScheduleRecurringApiModel" }, "RunListSteps": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleRunListStepApiModel" }, "nullable": true }, "Team": { "$ref": "#/components/schemas/TeamApiShortInfo" }, "RunListInfoId": { "type": "string", "description": "Run list info ID", "format": "uuid" }, "IsEnabled": { "type": "boolean", "description": "Enabled" }, "IsScheduled": { "type": "boolean", "description": "Scheduled" }, "StartDateTime": { "$ref": "#/components/schemas/DapperDateTimeOffset" }, "AlreadyRunningBehavior": { "$ref": "#/components/schemas/ScheduleCantRunBehavior" }, "AgentBusyBehavior": { "$ref": "#/components/schemas/ScheduleCantRunBehavior" }, "ReserveAgentsStrategy": { "$ref": "#/components/schemas/ReserveAgentsStrategyEnum" }, "IsStopIfFlowFailed": { "type": "boolean", "description": "Flag to stop if flow failed" }, "FlowFailedCount": { "type": "integer", "description": "Count of failed flow", "format": "int32" }, "IsDisableScheduleIfFlowFailed": { "type": "boolean", "description": "Flag to stop and disable schedule if flow failed" }, "FlowFailedCountToDisableSchedule": { "type": "integer", "description": "Count of failed flow to stop and disable schedule", "format": "int32" }, "IsEnabledReTryPolicy": { "type": "boolean", "description": "Flag to disable retry policy" }, "ReTryPolicyType": { "$ref": "#/components/schemas/ScheduleReTryPolicyType" }, "CountOfReTryFlowIfFailed": { "type": "integer", "description": "Count of flow retries if failed", "format": "int32" }, "FlowReportType": { "$ref": "#/components/schemas/ScheduleFlowReportTypeEnum" }, "IsStopIfLateness": { "type": "boolean", "description": "Flag to stop if run time longer than estimated" }, "EstimatedRunTimePrecision": { "type": "integer", "description": "Percentage of excess of execution time over estimated to stop", "format": "int32" }, "IsStopAfterElapsedInterval": { "type": "boolean", "description": "Is stop if running for more than" }, "StopIntervalMinutes": { "type": "integer", "description": "Stop interval", "format": "int32" }, "RevisionTimestamp": { "type": "integer", "format": "int64", "nullable": true }, "TimeZoneOffset": { "type": "integer", "format": "int64" }, "TimeZoneId": { "type": "string", "nullable": true }, "InternalVersion": { "type": "integer", "format": "int32" }, "CreatedBy": { "type": "string", "description": "Created by", "format": "uuid", "nullable": true }, "ModifiedBy": { "type": "string", "description": "Modified by", "format": "uuid", "nullable": true }, "AgentConfigurationId": { "type": "string", "format": "uuid", "nullable": true }, "Description": { "type": "string", "nullable": true }, "DateCreation": { "$ref": "#/components/schemas/DapperDateTimeOffset" }, "DateModify": { "$ref": "#/components/schemas/DapperDateTimeOffset" }, "Title": { "type": "string", "nullable": true }, "Type": { "$ref": "#/components/schemas/EnumAssetHierarchyType" }, "Id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ScheduleApiInfoPaginatedApiResponse": { "type": "object", "properties": { "CurrentPage": { "type": "integer", "format": "int32", "nullable": true }, "TotalPages": { "type": "integer", "format": "int32", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleApiInfo" }, "nullable": true }, "TotalRecords": { "type": "integer", "format": "int32" }, "Id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ScheduleCantRunBehavior": { "enum": [
"QueueNextRun",
"SkipNextRun",
"StopCurrentStartNextRun"
], "type": "string" }, "ScheduleFlowReportTypeEnum": { "enum": [
"None",
"StandardReport",
"DetailedReport"
], "type": "string" }, "ScheduleHierarchyApiInfo": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Title": { "type": "string", "nullable": true }, "Type": { "$ref": "#/components/schemas/EnumAssetHierarchyType" }, "Parent": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleHierarchyApiInfo" }, "nullable": true } }, "additionalProperties": false }, "ScheduleInfoWithHierarchy": { "type": "object", "properties": { "ScheduleHierarchy": { "$ref": "#/components/schemas/ScheduleHierarchyApiInfo" }, "ScheduleInfo": { "$ref": "#/components/schemas/ScheduleApiInfo" } }, "additionalProperties": false }, "ScheduleIntegrationInfo": { "type": "object", "properties": { "ScheduleId": { "type": "string", "format": "uuid", "readOnly": true }, "ScheduleTitle": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ScheduleReTryPolicyType": { "enum": [
"None",
"ReTryFlowIfFailed",
"UseGlobalReTrySettings",
"UseRunListReTrySettings"
], "type": "string" }, "ScheduleRecurringApiModel": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ScheduleInfoId": { "type": "string", "format": "uuid" }, "Type": { "$ref": "#/components/schemas/ScheduleRecurringType" }, "Period": { "type": "integer", "format": "int32" }, "EndType": { "$ref": "#/components/schemas/ScheduleRecurringEndType" }, "EndDateTime": { "type": "string", "format": "date-time" }, "RunsToEnd": { "type": "integer", "format": "int32" }, "EveryMonth": { "$ref": "#/components/schemas/ScheduleRecurringMonthApiModel" }, "EveryWeek": { "$ref": "#/components/schemas/ScheduleRecurringWeekApiModel" }, "EveryDay": { "$ref": "#/components/schemas/ScheduleRecurringDayApiModel" }, "EverySmallUnitOfTime": { "$ref": "#/components/schemas/ScheduleRecurringSmallUnitOfTimeApiModel" } }, "additionalProperties": false }, "ScheduleRecurringDayApiModel": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ScheduleRecurringId": { "type": "string", "format": "uuid" }, "SkipWeekends": { "type": "boolean" } }, "additionalProperties": false }, "ScheduleRecurringEndType": { "enum": [
"NoEnd",
"AfterRuns",
"UseEndDateTime"
], "type": "string" }, "ScheduleRecurringMonthApiModel": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ScheduleRecurringId": { "type": "string", "format": "uuid" }, "UseExactDayOfMonth": { "type": "boolean" }, "ExactDayOfMonthNumber": { "type": "integer", "format": "int32" }, "SpecificDayType": { "$ref": "#/components/schemas/SpecificDayType" }, "SpecificDayUnit": { "$ref": "#/components/schemas/SpecificDayUnit" } }, "additionalProperties": false }, "ScheduleRecurringSmallUnitOfTimeApiModel": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ScheduleRecurringId": { "type": "string", "format": "uuid" }, "EveryDay": { "type": "boolean" }, "Delay": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ScheduleRecurringType": { "enum": [
"EverySecond",
"EveryMinute",
"EveryHour",
"EveryDay",
"EveryWeek",
"EveryMonth",
"WithDelayAfterLastRun",
"Disable"
], "type": "string" }, "ScheduleRecurringWeekApiModel": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ScheduleRecurringId": { "type": "string", "format": "uuid" }, "Monday": { "type": "boolean" }, "Tuesday": { "type": "boolean" }, "Wednesday": { "type": "boolean" }, "Thursday": { "type": "boolean" }, "Friday": { "type": "boolean" }, "Saturday": { "type": "boolean" }, "Sunday": { "type": "boolean" } }, "additionalProperties": false }, "ScheduleRunListStepApiModel": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "RunListStepId": { "type": "string", "format": "uuid" }, "ScheduleInfoId": { "type": "string", "format": "uuid" }, "StepIndex": { "type": "integer", "format": "int32" }, "StepName": { "type": "string", "nullable": true }, "StepStartCondition": { "$ref": "#/components/schemas/RunListStepStartCondition" }, "EnvironmentParallelization": { "$ref": "#/components/schemas/EnvironmentParallelization" }, "StartOrder": { "$ref": "#/components/schemas/RunListStepStartOrder" }, "Agents": { "type": "array", "items": { "$ref": "#/components/schemas/AgentIntegrationInfo" }, "nullable": true } }, "additionalProperties": false }, "SeleniumGridInfo": { "type": "object", "properties": { "Port": { "type": "integer", "format": "int32" }, "HostName": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "UserProfile": { "type": "string", "nullable": true }, "PlatformName": { "type": "string", "nullable": true }, "Browser": { "$ref": "#/components/schemas/BrowserName" }, "Version": { "type": "string", "nullable": true }, "ScreenResolution": { "$ref": "#/components/schemas/ResolutionInfo" }, "ProxyConfiguration": { "$ref": "#/components/schemas/WebProxyConfigurationInfo" } }, "additionalProperties": false }, "SeleniumGridPlatformType": { "enum": [
"Windows",
"MacOS",
"Linux",
"Android",
"iOS",
"NotDefined"
], "type": "string" }, "SpecificDayType": { "enum": [
"First",
"Second",
"Third",
"Fourth",
"Last"
], "type": "string" }, "SpecificDayUnit": { "enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday",
"Weekday",
"DayOfMonth"
], "type": "string" }, "StartRunApiResponse": { "type": "object", "properties": { "RunId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "StatusApiResponse": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/RunStatus" } }, "additionalProperties": false }, "StopApiResponse": { "type": "object", "properties": { "OperationCompleted": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SupportedTerminalApp": { "enum": [
"IBMiAccessClientSolutions_x32",
"IBMiAccessClientSolutions_x64",
"RumbaPlusDesktopMainframe",
"RumbaPlusDesktopAS400",
"Undefined"
], "type": "string" }, "TeamApiInfo": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Title": { "type": "string", "nullable": true }, "DateCreation": { "type": "string", "format": "date-time" }, "DateModify": { "type": "string", "format": "date-time" }, "CreatedBy": { "type": "string", "format": "uuid", "nullable": true }, "ModifiedBy": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "TeamApiShortInfo": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateAgentResponse": { "type": "object", "properties": { "AgentId": { "type": "string", "format": "uuid" }, "IsSuccessful": { "type": "boolean" } }, "additionalProperties": false }, "UpdateUserResponse": { "type": "object", "properties": { "OperationCompleted": { "type": "boolean" } }, "additionalProperties": false }, "UserApiAccess": { "enum": [
"Reader",
"Contributor",
"Administrator",
"NoAccess"
], "type": "string" }, "UserApiInfo": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "UserName": { "type": "string", "nullable": true, "readOnly": true }, "FullName": { "type": "string", "nullable": true, "readOnly": true }, "UserType": { "$ref": "#/components/schemas/UserType" }, "LastActiveDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "TeamNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UserPasswordInfo": { "type": "object", "properties": { "Password": { "type": "string", "nullable": true }, "ForceChangePasswordOnFirstLogin": { "type": "boolean" } }, "additionalProperties": false }, "UserTeamInfo": { "type": "object", "properties": { "TeamIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UserType": { "enum": [
"Leapwork",
"ActiveDirectory",
"SSO"
], "type": "string" }, "VariableProxy": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Value": { "$ref": "#/components/schemas/LSignal" } }, "additionalProperties": false }, "WebProxyConfigurationInfo": { "type": "object", "properties": { "ProxyType": { "$ref": "#/components/schemas/ProxyType" }, "AutomaticConfigAddress": { "type": "string", "nullable": true }, "HttpProxyAddress": { "type": "string", "nullable": true }, "HttpsProxyAddress": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }