Method: tasks.list

Full name: projects.locations.instances.tasks.list

Lists soar tasks.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list Tasks for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of Tasks to return. The service may return fewer than this value.

pageToken

string

Optional. A page token, received from a previous tasks.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

filter

string

Optional. Filter to be applied over multiple Task fields. Only the following filters are allowed:

orderBy

string

Optional. Configures ordering of Tasks in the response. If not specified, Tasks are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. For example: "createTime desc, updateTime" Supported fields: * order * displayName

Request body

The request body must be empty.

Response body

Response message for listing SOAR tasks.

If successful, the response body contains data with the following structure:

JSON representation
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string
}
Fields
tasks[]

object (Task)

The list of Tasks.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.