Scripts
scripts
This relation targets the collection of scripts the authenticated user has access to.
4.50.0+
script
This relation targets the canonical representation of a script.
A script is defined by its name and type.
A script type defines how the script can be executed.
4.50.0+
script-runs
This relation targets the collection of script-runs related to the scripts the authenticated user has access to.
4.50.0+
script-run
This relation targets the canonical representation of a script-run.
A script-run represents the live state of one specific execution of a script with a status and start and end dates.
4.50.0+
Single request to run a script
Send a POST request on the script-runs resource: http://baobab.keepeek.com/api/dam/script-runs
The body of the request is the representation of the script to run.
If the script-run creation is successful, the API returns a 201 Created
status code, the URL of the created script-run is included in the Location
header of the response, and the response's body is the representation of the created script-run.
Sample request:
POST http://baobab.keepeek.com/api/dam/script-runs
Content-Type: application/json+hal,[...]
{
"id": 7
}
HTTP/1.1 201 Created
Location: http://baobab.keepeek.com/api/dam/script-runs/22
Content-Type: application/json+hal,[...]
{
"id": 22,
"scriptTitle": "Sept",
"status": "STARTED",
"startDate": "2020-11-12T13:48:48.000Z",
"_links": {
"self": {"href": "http://baobab.keepeek.com/api/dam/script-runs/22"},
"kpk:script": {"href": "http://baobab.keepeek.com/api/dam/scripts/7"}
}
}
4.50.0+