Method: projects.instructions.list

Lists instructions for a project. Pagination is supported.

HTTP request

GET https://datalabeling.googleapis.com/v1beta1/{parent=projects/*}/instructions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Instruction resource parent, format: projects/{project_id}

Authorization requires the following Google IAM permission on the specified resource parent:

  • datalabeling.instructions.list

Query parameters

Parameters
filter

string

Optional. Filter is not supported at this moment.

pageSize

number

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

pageToken

string

Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.

Request body

The request body must be empty.

Response body

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

Results of listing instructions under a project.

JSON representation
{
  "instructions": [
    {
      object (Instruction)
    }
  ],
  "nextPageToken": string
}
Fields
instructions[]

object (Instruction)

The list of Instructions to return.

nextPageToken

string

A token to retrieve next page of results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.