Delete a system field option

Deletes an option from this project's system field definition. An option with links returns 409 unless force=true.
Forced deletion removes links before it deletes the option. Other entity types are rejected.
Requires the SystemFieldOption:Delete permission.

Linked entity typeAdditional permission
TEST_CASERequires the TestCase:Update permission.
EXECUTION, EXECUTION_TEST_RESULT, TEST_SCHEDULERequires the TestRun:Update permission.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

System field key, such as featureArea or testType.

Allowed:
int64
required

System field option ID.

Query Params
boolean
Defaults to false

Delete links to eligible entities before deleting an option.

Headers
string

Optional account UUID for selecting account context explicitly.

int64

Optional organization ID for selecting organization context explicitly.

int64
required

True Platform project ID, not a repository ID.

Responses
204

The option was deleted. No response body.

401

Authentication is missing or invalid.

403

The caller lacks access or the required permission.

404

The requested asset was not found. Some inaccessible or deleted assets can instead return 400 or 403.

default

The request could not be completed. Inspect the response before retrying a mutation.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json