getCustomFieldConfiguration method

Future<PageBeanContextualConfiguration> getCustomFieldConfiguration({ required String fieldIdOrKey, List<int>? id, List<int>? fieldContextId, int? issueId, String? projectKeyOrId, String? issueTypeId, int? startAt, int? maxResults, })

Returns a paginated list of configurations for a custom field created by a Forge app.

The result can be filtered by one of these criteria:

• id.
• fieldContextId.
• issueId.
• projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field.

Implementation

Future<PageBeanContextualConfiguration> getCustomFieldConfiguration(
    {required String fieldIdOrKey,
    List<int>? id,
    List<int>? fieldContextId,
    int? issueId,
    String? projectKeyOrId,
    String? issueTypeId,
    int? startAt,
    int? maxResults}) async {
  return PageBeanContextualConfiguration.fromJson(await _client.send(
    'get',
    'rest/api/3/app/field/{fieldIdOrKey}/context/configuration',
    pathParameters: {
      'fieldIdOrKey': fieldIdOrKey,
    },
    queryParameters: {
      if (id != null) 'id': id.map((e) => '$e').join(','),
      if (fieldContextId != null)
        'fieldContextId': fieldContextId.map((e) => '$e').join(','),
      if (issueId != null) 'issueId': '$issueId',
      if (projectKeyOrId != null) 'projectKeyOrId': projectKeyOrId,
      if (issueTypeId != null) 'issueTypeId': issueTypeId,
      if (startAt != null) 'startAt': '$startAt',
      if (maxResults != null) 'maxResults': '$maxResults',
    },
  ));
}