JS executions (1.1)

Download OpenAPI specification:Download

JS executions API

List JsExecutions

Retrieve JsExecutions list

query Parameters

status	string Enum: "CREATED" "SUBMITTED" "REJECTED" "CANCELLED" "RUNNING" "SUCCESSFUL" "UNSUCCESSFUL"
sortBy	string Enum: "ID" "SCHEDULED_TIME"

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"status": "SUCCESSFUL",
"Scheduled at": "2022-08-15T00:12:53.468+03:00[Europe/Minsk]",
"Executed at": "2022-08-15T00:12:54.454+03:00[Europe/Minsk]",
"links": [{"rel": "self",
"href": "http://localhost:8080/executions/0"
},
{"rel": "jsExecutions",
"href": "http://localhost:8080/executions{?status,sortBy}"
},
{"rel": "delete",
"href": "http://localhost:8080/executions/0"
},
{"rel": "scriptbody",
"href": "http://localhost:8080/executions/0/scriptbody"
},
{"rel": "executionlog",
"href": "http://localhost:8080/executions/0/executionlog"
},
{"rel": "errorlog",
"href": "http://localhost:8080/executions/0/errorlog"
}
]
},
{"id": 1,
"status": "CANCELLED",
"Scheduled at": "2022-08-15T00:16:47.446+03:00[Europe/Minsk]",
"Executed at": null,
"links": [{"rel": "self",
"href": "http://localhost:8080/executions/1"
},
{"rel": "jsExecutions",
"href": "http://localhost:8080/executions{?status,sortBy}"
},
{"rel": "delete",
"href": "http://localhost:8080/executions/1"
},
{"rel": "scriptbody",
"href": "http://localhost:8080/executions/1/scriptbody"
},
{"rel": "executionlog",
"href": "http://localhost:8080/executions/1/executionlog"
},
{"rel": "errorlog",
"href": "http://localhost:8080/executions/1/errorlog"
}
]
}
]

Create new JsExecution

Request Body schema: application/json

id	integer <int32>
status	string Enum: "CREATED" "SUBMITTED" "REJECTED" "CANCELLED" "RUNNING" "SUCCESSFUL" "UNSUCCESSFUL"
Executed at	string
Scheduled at	string

Responses

Request samples

Payload

Content type

application/json

{"scriptBody": "console.log('I am js snippet!');"
}

Response samples

201

Content type

application/json

{"id": 0,
"status": "SUBMITTED",
"Scheduled at": "2022-08-15T00:12:53.468+03:00[Europe/Minsk]",
"Executed at": null,
"links": [{"rel": "self",
"href": "http://localhost:8080/executions/0"
},
{"rel": "jsExecutions",
"href": "http://localhost:8080/executions{?status,sortBy}"
},
{"rel": "delete",
"href": "http://localhost:8080/executions/0"
},
{"rel": "cancel",
"href": "http://localhost:8080/executions/0/cancel"
},
{"rel": "scriptbody",
"href": "http://localhost:8080/executions/0/scriptbody"
}
]
}

Get JsExecution

Get JsExecution by id

path Parameters

executionId

required

integer <int32>

Responses

Response samples

200
404

Content type

application/json

{"id": 0,
"status": "SUCCESSFUL",
"Scheduled at": "2022-08-15T00:12:53.468+03:00[Europe/Minsk]",
"Executed at": "2022-08-15T00:12:54.454+03:00[Europe/Minsk]",
"links": [{"rel": "self",
"href": "http://localhost:8080/executions/0"
},
{"rel": "jsExecutions",
"href": "http://localhost:8080/executions{?status,sortBy}"
},
{"rel": "delete",
"href": "http://localhost:8080/executions/0"
},
{"rel": "scriptbody",
"href": "http://localhost:8080/executions/0/scriptbody"
},
{"rel": "executionlog",
"href": "http://localhost:8080/executions/0/executionlog"
},
{"rel": "errorlog",
"href": "http://localhost:8080/executions/0/errorlog"
}
]
}

Delete JsExecution

Delete JsExecution by id

path Parameters

executionId

required

integer <int32>

Responses

Response samples

404

Content type

application/problem+json

{"title": "Not Found",
"status": 404,
"detail": "JsExecution id 10 not found"
}

Get execution details as plain text

Get execution details by JS execution id and property name as plain text

path Parameters

executionId required	integer <int32>
property required	string

Responses

Response samples

200
400
404

Content type

text/plain

This is details report in plain text format. 
It could be very varied.

Cancel or stop JsExecution

path Parameters

executionId

required

integer <int32>

Responses

Response samples

200
404
405

Content type

application/json

{"id": 1,
"status": "CANCELLED",
"Scheduled at": "2022-08-15T00:16:47.446+03:00[Europe/Minsk]",
"Executed at": null,
"links": [{"rel": "self",
"href": "http://localhost:8080/executions/1"
},
{"rel": "jsExecutions",
"href": "http://localhost:8080/executions{?status,sortBy}"
},
{"rel": "delete",
"href": "http://localhost:8080/executions/1"
},
{"rel": "scriptbody",
"href": "http://localhost:8080/executions/1/scriptbody"
},
{"rel": "executionlog",
"href": "http://localhost:8080/executions/1/executionlog"
},
{"rel": "errorlog",
"href": "http://localhost:8080/executions/1/errorlog"
}
]
}