List task history
Relative path: /v1/device_tasks/{taskUuid}/runs
List task history - all the runs of the task.
For sake of forensics, the [task run]s are listed collectively, not as children of their parent task. Information about task runs might easily survive their parent task.
Migration from EP/ESMC/ERA: To list what is called
Executions
setonly_latest
flag totrue
.Info: Modeled based on https://google.aip.dev/152#executions-and-results with ESET specific vocabulary.
Query parameters
Name |
Type |
Description |
---|---|---|
deviceUuid |
string |
Only include runs on specific device (if filled). type: device_management/v1/Device |
listOnlyLastRuns |
boolean |
If true, the result will only contain the latest runs per device. |
pageSize |
integer |
Limit for pagination purposes. If unspecified or 0, default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string |
Page token of current page. If not given or "", the first page is returned.
|
Parameters in path
Name |
Type |
Required |
Description |
---|---|---|---|
taskUuid |
string |
Yes |
Include only runs of specific task. Mandatory. type: DeviceTask |
Responses
Display Schema instead of an Example or vice-versa
Code |
Description |
Example |
Schema |
---|---|---|---|
200 |
Successful response. |
{ "taskRuns": [ { "deviceUuid": "string", "endTime": "string", "result": { "@type": "string" }, "startTime": "string", "status": "TASK_RUN_STATUS_UNSPECIFIED", "taskUuid": "string", "uuid": "string" } ], "nextPageToken": "string" } |
{ "$ref": "v1ListTaskRunsResponse", "taskRuns": [ { "$ref": "v1DeviceTaskRun", "description": "One run (an execution) of the [device task] on some device. [Task run] inherits all of its properties from the corresponding [device task]. Additional documentation about task run results can be found at ESET PROTECT Cloud help. Migration from EP/ESMC/ERA: TaskRun maps to the concept of Execution Info: Identity of the [task run] is kept for one task + device combination + start_time combination.", "deviceUuid": { "type": "string", "description": "Device where task is executed. For tasks assigned to device group there can be multiple task runs from each member of the group. type: device_management.v1.Device" }, "endTime": { "type": "string", "description": "Timestamp of run end. Meaningful for finished and failed task runs.", "format": "date-time", "readOnly": true }, "result": { "$ref": "protobufAny", "description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example 'foo.bar.com/x/y.z' will yield type name 'y.z'. JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { '@type': 'type.googleapis.com/google.profile.Person', 'firstName': <string>, 'lastName': <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { '@type': 'type.googleapis.com/google.protobuf.Duration', 'value': '1.212s' }", "@type": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one '/' character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading '.' is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: If no scheme is provided, https is assumed. An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics." } }, "startTime": { "type": "string", "description": "Timestamp of run start.", "format": "date-time" }, "status": { "$ref": "v1TaskRunStatus", "title": "Possible TaskRun states", "type": "string", "description": "TASK_RUN_STATUS_UNSPECIFIED: fallback TASK_RUN_STATUS_QUEUED: Task run has been processed but it is not yet running on target. Migration from EP/ESMC/ERA: Maps to STARTING. - TASK_RUN_STATUS_RUNNING: Task is being executed on the target. - TASK_RUN_STATUS_FINISHED: Task execution finished successfully. - TASK_RUN_STATUS_FAILED: Task execution failed. - TASK_RUN_STATUS_SUPPRESSED: The task was not executed due to suppression policies. Suppression might occur for certain task sources to prevent damaging results. For example: a rule system that would wipe the device as a response to threat detection.", "default": "TASK_RUN_STATUS_UNSPECIFIED", "enum": [ "TASK_RUN_STATUS_UNSPECIFIED", "TASK_RUN_STATUS_QUEUED", "TASK_RUN_STATUS_RUNNING", "TASK_RUN_STATUS_FINISHED", "TASK_RUN_STATUS_FAILED", "TASK_RUN_STATUS_SUPPRESSED" ] }, "taskUuid": { "title": "[Device task] reference", "type": "string", "description": "type: DeviceTask" }, "uuid": { "type": "string", "description": "Universally Unique Identifier References use this identifier so it must be filled in all the cases except resource creation. Compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace Formatted according to template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on wikipedia. For example: '123e4567-e89b-12d3-a456-426614174000'" } } ], "nextPageToken": { "type": "string", "description": "Page token of next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or https://cloud.google.com/apis/design/design_patterns#list_pagination" } } |
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
null |
[] |
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
null |
[] |
401 |
Token has expired or is invalid. |
null |
[] |
403 |
Access denied. Check permissions. |
null |
[] |
404 |
Requested resource not found. |
null |
[] |
429 |
Rate limit reached. Try again later. |
null |
[] |
500 |
Internal server failure. Try again later. |
null |
[] |
502 |
Internal server failure. Try again later. |
null |
[] |
503 |
Environment under maintenance. Try again later. |
null |
[] |
504 |
Action took too long; timeout reached |
null |
[] |