Project Custom Fields
Resource | /api/admin/customFieldSettings/customFields/{fieldID}/instances |
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 | true if there is a background job running for this field. In this case some field operations can be temporary unaccessible. |
Read a List of ProjectCustomFields
Get all project related settings of this custom field.
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 |
$skip | int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | int | Optional. Lets you specify the maximum number of entries that are returned in the response. |