---
title: "Poll async task status"
method: GET
path: "/api/v3/tasks/study-schema/set-field-definitions/{task_id}"
tags: ["Study Schema"]
---

# Poll async task status

`GET /api/v3/tasks/study-schema/set-field-definitions/{task_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/tasks/study-schema/set-field-definitions/{task_id}`
- Auth: HTTP bearer

Poll the status of the "Set field definitions on a study schema" task.

Asynchronously set field definitions on a study schema. Requires administrator permission on the schema, Studies to be enabled, and updates to be allowed for the schema's study type.

Include every existing field, including archived fields, in the desired order. Provide a field ID to update an existing field; omit the ID to create a new field. Omitted update attributes retain their existing values. To archive a field, set `archived` to `true` and provide `archiveReason`. Omitting a field does not delete it and causes validation to fail. Configured schema field limits apply.

## Path parameters

- `task_id` string, required

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- StudySchemaSetfielddefinitionsGetResponse200
  - `message` string, required
  - `result` SchemaSetFieldDefinitionsOutput: Return shape for the set_field_definitions API on schemas.
    - `fieldDefinitions` SchemaFieldDefinitionRef[]
      - `__typename` string
      - `id` string, api_id
    - `schemaId` string
  - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED', required

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)