Update (Run)

URL:
https://<root>/system/tasks/<taskID>/runs/<runID>/update
Methods:
POST
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.9

Description

The update operation modifies an existing run for a scheduled task.

Request parameters

ParameterDetails

status

The status of the run.

Values: scheduled | executing | succeeded | skipped | failed | submitfailed

result

A result string for the run.

Example
Use dark colors for code blocksCopy
1
result=GP Jobs have been cleaned.

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/system/tasks/fdbbc58261544b2f82b61c8111a08f16/runs/a277d60ee7864ab7bd2287c30590f9d1/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

status=executing&result=GP Jobs have been cleaned.&f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.