Method: attachments.list

Full name: projects.locations.instances.legacySoarUsers.attachments.list

List Attachments.

HTTP request


Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

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

string

Optional. A page token, received from a previous attachments.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to attachments.list must match the call that provided the page token.
filter

string

Optional. Filter to be applied over multiple Attachment fields. Only the following filters are allowed: file, description, mimeType, and author.
orderBy

string

Optional. Configures the order in which Attachments are returned.

Request body

The request body must be empty.

Response body

ListAttachmentsResponse contains the list of Attachments.

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

JSON representation 
{
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
attachments[]

object (Attachment)

The list of Attachments.
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.
totalSize

integer

Optional. The total number of Attachments matching the request.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.