Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This deleThis page describes REST API operations for managing custom fields in Zephyr for Jira Server.

...

customfieldId: The ID of the custom field to be deleted.

RESPONSE

Response Body

Code Block
{
  "message": ""
}

message: The message to be sent if the field cannot be deleted or if it has been deleted successfully.

Response Codes 

200: The request has been accepted and processed successfully.
400: Bad request. No custom field with the specified ID was found.
401: Unauthorized. Make sure you have specified the correct username and password.
403: Forbidden. Make sure you have the required permissions to perform this action.
404: Not found. The API URL was not found or it was not configured properly.
500: Make sure the server is up and running and Zephyr is configured properly before using the API.

Delete several custom fields

This API deletes several custom fields by their IDs.

REQUEST

DELETE https://<client server base URL>/rest/zapi/latest/customfield/delete-customfields

Authentication type: Basic

Parameters:

customfieldIds: The IDs of the custom fields to be deleted.

Sample payload:

Code Block
{
"customfields":["3","14"]
}

3 and 14 - the IDs of the fields to be deleted.

RESPONSE

Response Body

Code Block
{
  "message": ""
}

...

This API enables or disables a custom field for a project.

REQUEST

DELETE https://<client server base URL>/rest/zapi/latest/customfield/{customFieldId}/{projectId}?enable
Authentication type: Basic

...

Query parameters:
enable: false or true. If false, the custom field will be disabled for the project. Else, the custom field will be enabled.

RESPONSE

Response Body

Code Block
{
  "message": ""
}

...