Custom Fields
This chapter focuses on custom fields. Custom fields are extra fields that can be attached to certain entities. The set of such extra fields is defined by per-project configuration, which means for instance that two test cases in two distinct projects may have different custom fields.
Please be careful not to be confused with Custom Field Values : whereas a Custom Field is the abstract definition of a field, a Custom Field Value represents an actual value for that field.
TODO : les différents sous-types etc.
Get all custom fields
A GET
to /custom-fields
returns all the custom fields.
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Request parameters
Snippet request-parameters not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Links
Snippet links not found for operation::RestCustomFieldControllerIT/find-all-custom-fields
Get custom field
A GET
to /custom-fields/{id}
returns the custom field with the given ID.
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Request parameters
Snippet request-parameters not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Links
Snippet links not found for operation::RestCustomFieldControllerIT/find-custom-fields-by-id
Create custom field
A POST
to /custom-fields
creates a new custom field.
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Request fields
Snippet request-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Links
Snippet links not found for operation::RestCustomFieldControllerIT/add-new-custom-field
Modify custom field
A PATCH
to /custom-fields/{id}
modifies the custom field with the given id.
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/update-custom-field
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/update-custom-field
Request fields
Snippet request-fields not found for operation::RestCustomFieldControllerIT/update-custom-field
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/update-custom-field
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/update-custom-field
Links
Snippet links not found for operation::RestCustomFieldControllerIT/update-custom-field
Delete custom field
A DELETE
to /custom-fields/{ids}
deletes the custom field(s) with the given id(s).
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/delete-custom-field
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/delete-custom-field
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/delete-custom-field
Warning
|
Features about custom field options must be modified. |
Add custom field option
A POST
to /custom-fields/{id}/options
adds option to the custom field with the given id .
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Request fields
Snippet request-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Links
Snippet links not found for operation::RestCustomFieldControllerIT/add-new-custom-field-option
Update custom field option label
A PATCH
to /custom-fields/{id}/options/{optionLabel}/label/{newValue}
modifies the label of the option with given original label .
HTTP request
Snippet http-request not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Path parameters
Snippet path-parameters not found for operation::RestCustomFieldControllerIT/update-custom-field-option
HTTP response
Snippet http-response not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Response fields
Snippet response-fields not found for operation::RestCustomFieldControllerIT/update-custom-field-option
Links
Snippet links not found for operation::RestCustomFieldControllerIT/update-custom-field-option