ESET PROTECT On-Prem

Offline | Przejdź do trybu online

ESET PROTECT On-Prem – Spis treści

# List task runs

Skopiuj adres URL bieżącego artykułu Udostępnij przez e-mail

Relative path: /v1/device_tasks/{taskUuid}/runs

List task history - all the runs of the task.

For the 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.

> Info:
> Modeled based on Jobs: Executions and results with ESET specific vocabulary.

### URL example

https://10.1.180.105:9443/v1/device_tasks/48d027ed-51a6-44f0-bd39-b60fdeb6ab31/runs

### Query parameters

Name | Type | Description
--- | --- | ---
deviceUuid | string | Include only 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, the default value is 100. The maximum value is 10000; values above 1000 will be coerced to 10000. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination
pageToken | string | Page token of the current page. If not given or "", the first page is returned. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination

### Parameters in path

Name | Type | Required | Description
--- | --- | --- | ---
taskUuid | string | Yes | Include only runs of specific task. Mandatory. type: DeviceTask

### Responses

Display Schema+Headers instead of an Example or vice-versa

Code | Description and Example | Description, Schema and Headers
--- | --- | ---
200 | A successful response. Response example
    {
      "taskRuns": [
        {
          "deviceUuid": "string",
          "endTime": "string",
          "result": {
            "@type": "string",
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
          },
          "startTime": "string",
          "status": "TASK_RUN_STATUS_UNSPECIFIED",
          "taskUuid": "string",
          "uuid": "string"
        }
      ],
      "nextPageToken": "string"
    }
| A successful response. Response schema
    {
      "$ref": "v1ListTaskRunsResponse",
      "taskRuns": [
        {
          "$ref": "v1DeviceTaskRun",
          "description": "One run (an execution) of the [device task]. [Task run] inherits all of its properties from the corresponding [device task]. Info: Identity of the [task run] is kept for one task + device combination + start_time combination.",
          "deviceUuid": {
            "type": "string",
            "description": "Device where the task is executed. For tasks assigned to a 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); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... 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 whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. 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). 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.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
            },
            "additionalProperties": {
              "type": "object"
            }
          },
          "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: The task run has been processed but it is not yet running on the target. TASK_RUN_STATUS_RUNNING: The task is being executed on the target. TASK_RUN_STATUS_FINISHED: The task execution finished successfully. TASK_RUN_STATUS_FAILED: The 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.",
            "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": {
            "type": "string",
            "description": "Reference to [Device task]. Required. type: DeviceTask"
          },
          "uuid": {
            "type": "string",
            "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
          }
        }
      ],
      "nextPageToken": {
        "type": "string",
        "description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
      }
    }
default | An unexpected error response. Response example
    {
      "code": 0,
      "message": "string",
      "details": [
        {
          "@type": "string",
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        }
      ]
    }
| An unexpected error response. Response schema
    {
      "$ref": "rpcStatus",
      "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.",
      "code": {
        "type": "integer",
        "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
        "format": "int32"
      },
      "message": {
        "type": "string",
        "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
      },
      "details": [
        {
          "$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); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... 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 whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. 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). 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.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
          },
          "additionalProperties": {
            "type": "object"
          }
        }
      ]
    }

˄˅