IssueFieldConfigurationsApi class
Jira Cloud platform REST API documentation
Constructors
- IssueFieldConfigurationsApi(ApiClient _client)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
assignFieldConfigurationSchemeToProject(
{required FieldConfigurationSchemeProjectAssociation body}) → Future -
Assigns a field configuration scheme to a project. If the field
configuration scheme ID is
null
, the operation assigns the default field configuration scheme. -
createFieldConfiguration(
{required FieldConfigurationDetails body}) → Future< FieldConfiguration> - Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.
-
createFieldConfigurationScheme(
{required UpdateFieldConfigurationSchemeDetails body}) → Future< FieldConfigurationScheme> - Creates a field configuration scheme.
-
deleteFieldConfiguration(
int id) → Future - Deletes a field configuration.
-
deleteFieldConfigurationScheme(
int id) → Future - Deletes a field configuration scheme.
-
getAllFieldConfigurations(
{int? startAt, int? maxResults, List< int> ? id, bool? isDefault, String? query}) → Future<PageBeanFieldConfigurationDetails> - Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
-
getAllFieldConfigurationSchemes(
{int? startAt, int? maxResults, List< int> ? id}) → Future<PageBeanFieldConfigurationScheme> - Returns a paginated list of field configuration schemes.
-
getFieldConfigurationItems(
{required int id, int? startAt, int? maxResults}) → Future< PageBeanFieldConfigurationItem> - Returns a paginated list of all fields for a configuration.
-
getFieldConfigurationSchemeMappings(
{int? startAt, int? maxResults, List< int> ? fieldConfigurationSchemeId}) → Future<PageBeanFieldConfigurationIssueTypeItem> - Returns a paginated list of field configuration issue type items.
-
getFieldConfigurationSchemeProjectMapping(
{int? startAt, int? maxResults, required List< int> projectId}) → Future<PageBeanFieldConfigurationSchemeProjects> - Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeIssueTypesFromGlobalFieldConfigurationScheme(
{required int id, required IssueTypeIdsToRemove body}) → Future - Removes issue types from the field configuration scheme.
-
setFieldConfigurationSchemeMapping(
{required int id, required AssociateFieldConfigurationsWithIssueTypesRequest body}) → Future - Assigns issue types to field configurations on field configuration scheme.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateFieldConfiguration(
{required int id, required FieldConfigurationDetails body}) → Future - Updates a field configuration. The name and the description provided in the request override the existing values.
-
updateFieldConfigurationItems(
{required int id, required FieldConfigurationItemsDetails body}) → Future - Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.
-
updateFieldConfigurationScheme(
{required int id, required UpdateFieldConfigurationSchemeDetails body}) → Future - Updates a field configuration scheme.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited