Field Configuration Functions
- Radu Dumitriu (Deactivated)
- Shane Smith
Field configurations are used ultimately to set up the hidden or required field flags, based on issue types and projects. Most of these only work for Company-Managed Projects (classic projects)
Functions Summary
- admAppendFieldConfigDefaultITMapping — Appends the default issue type - field configuration mapping
- admAppendFieldConfigITMapping — Appends the issue type - field configuration mapping
- admAssignDefaultFieldConfigSchemeToProject — Assigns the default field config scheme to a project
- admAssignFieldConfigSchemeToProject — Assigns a field config scheme to a project
- admCreateFieldConfig — Creates a field configuration
- admCreateFieldConfigScheme — Creates a field config scheme
- admDeleteFieldConfig — Deletes a field configuration
- admDeleteFieldConfigScheme — Deletes a field config scheme
- admGetAllFieldConfigItems — Gets all the field configuration items
- admGetAllFieldConfigs — Gets all the field configs
- admGetAllFieldConfigSchemes — Retrieves all field configuration schemes.
- admGetFieldConfigById — Gets the field configs for a given id
- admGetFieldConfigITMappings — Returns the issue type - field configuration mappings
- admGetFieldConfigsByName — Gets all the field configs matching a given name
- admGetFieldConfigScheme — Retrieves a specific field configuration scheme.
- admRemoveFieldConfigDefaultITMapping — Removes the default issue type - field configuration mapping
- admRemoveFieldConfigITMapping — Removes the issue type - field configuration mapping
- admUpdateFieldConfig — Updates a field configuration
- admUpdateFieldConfigItem — Updates the description and flags for a field configuration item
- admUpdateFieldConfigScheme — Updates a field config scheme
Structures used:
JFieldConfigurationScheme
int id;
string name;
string description;This is the topmost structure, the one you may use to assign to projects
JFieldConfiguration
int id;
string name;
string description;
boolean isDefault;This does not represent a certain field. It’s the totality of the configs you associate with issue types.
JFieldConfigITMapping
int fieldConfigurationId;
int issueTypeId;If issue type id is zero (0) it actually means the default issue type.
JFieldConfigurationItem
string field;
string description;
string renderer;
boolean hidden;
boolean required;Renderer may be changed only for text fields, and accepted values are ‘text-renderer' and ‘wiki-renderer’. Field is the Jira name of the field, like ‘summary’, ‘fixVersions’ or 'customfield_12345’.
Related content
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.