Skip to navigation

Set field definitions on a matrix plate schema

Beta

Asynchronously set field definitions on a matrix plate schema. Requires permission to update settings on the schema’s registry.

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. Parent links and numeric ranges are not supported. Configured schema field limits apply, and the request fails if the schema has more items than the configured limit for re-syncing item field values.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

matrix_plate_schema_idstringRequired
ID of the MatrixPlateSchema.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
fieldDefinitionslist of objectsRequired

The complete field list in the desired order, including archived fields. Include an ID for each existing field and omit the ID for new fields. Omitted update attributes retain their existing values. To archive an existing field, set archived to true and provide archiveReason; a field that stays archived cannot be modified. All existing fields must be included; omission is not deletion. Parent links and numeric ranges are not supported. Configured schema field limits apply.

Response

Task started
pollingUristringOptionalformat: "uri"
taskIdstringOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error