Operations with Specific ProjectCustomField
This resource lets you access and configure custom fields in the specific project.
Resource | /api/admin/projects/{projectID}/customFields/{fieldID} |
Returned entity | ProjectCustomField. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
ProjectCustomField attributes
Represents custom field settings for the particular project.
This table describes attributes of the ProjectCustomField
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
field | CustomField | Custom field which project settings are described. |
project | Project | Project to which custom field belongs. |
canBeEmpty | Boolean | If true, this field can have empty value in the issue, otherwise false. |
emptyFieldText | String | Text that is shown as a placeholder when field is empty. |
ordinal | Int | Number of this field in project. |
isPublic | Boolean | If true, issue public read/update are sufficient for accessing this field, otherwise private read/update are required. |
hasRunningJob | Boolean | |
Update a Specific ProjectCustomField
Change settings of the specific custom field in the project.
Required permissions
Requires Update Project permission.
Request syntax
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of ProjectCustomField attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Sample request body
Sample response body
Read a Specific ProjectCustomField
Get settings of the specific custom field in the project.
Required permissions
If the field is public, requires Create Issue OR Read Issue permission.
If the field is private, requires Read Issue Private Fields permission.
Request syntax
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of ProjectCustomField attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Sample response body
Delete a Specific ProjectCustomField
Remove the specific custom field from the project.
Required permissions
Requires Update Project permission.
Request syntax
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of ProjectCustomField attributes that should be returned in the response. If no field is specified,only the |