Package com.atlassian.jira.rest.v2.issue.customfield

Class CustomFieldResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.customfield.CustomFieldResource

@Path("customFields")
@Consumes("application/json")
@Produces("application/json")
public class CustomFieldResource
extends Object

Since:

7.12

Constructor Summary

Constructors

Constructor	Description
CustomFieldResource(JiraAuthenticationContext jiraAuthenticationContext, CustomFieldBeanFactory customFieldBeanFactory, OptionsManager optionsManager, javax.ws.rs.core.UriInfo contextUriInfo, com.atlassian.event.api.EventPublisher eventPublisher, I18nHelper i18nHelper)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	bulkDeleteCustomFields(List<String> customFieldsIds)
static javax.ws.rs.core.Response	createErrorResponse(ServiceResult result)
javax.ws.rs.core.Response	getCustomFieldOptions(long customFieldId, List<Long> projectIds, List<String> issueTypeIds, String query, int maxResults, int page)	Returns custom field's options defined in a given context composed of projects and issue types.
javax.ws.rs.core.Response	getCustomFields(long startAt, int maxResults, String searchString, List<String> projectIds, List<String> screenIds, List<String> types, String sortOrder, String sortColumn, Long lastValueUpdate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CustomFieldResource

@Inject
public CustomFieldResource(JiraAuthenticationContext jiraAuthenticationContext,
 CustomFieldBeanFactory customFieldBeanFactory,
 OptionsManager optionsManager,
 javax.ws.rs.core.UriInfo contextUriInfo,
 com.atlassian.event.api.EventPublisher eventPublisher,
 I18nHelper i18nHelper)

Method Details

getCustomFields

@GET
public javax.ws.rs.core.Response getCustomFields(@DefaultValue("1") @QueryParam("startAt")
 long startAt,
 @DefaultValue("50") @QueryParam("maxResults")
 int maxResults,
 @QueryParam("search")
 String searchString,
 @QueryParam("projectIds")
 List<String> projectIds,
 @QueryParam("screenIds")
 List<String> screenIds,
 @QueryParam("types")
 List<String> types,
 @QueryParam("sortOrder")
 String sortOrder,
 @QueryParam("sortColumn")
 String sortColumn,
 @QueryParam("lastValueUpdate")
 Long lastValueUpdate)

Returns:

a list of Custom Fields in the given range.

bulkDeleteCustomFields

@DELETE
public javax.ws.rs.core.Response bulkDeleteCustomFields(@QueryParam("ids")
 List<String> customFieldsIds)

Returns:

Lists of deleted and not deleted custom fields

getCustomFieldOptions

@GET
@Path("{customFieldId}/options")
@ExperimentalApi
public javax.ws.rs.core.Response getCustomFieldOptions(@PathParam("customFieldId")
 long customFieldId,
 @QueryParam("projectIds")
 List<Long> projectIds,
 @QueryParam("issueTypeIds")
 List<String> issueTypeIds,
 @QueryParam("query") @DefaultValue("")
 String query,
 @QueryParam("maxResults") @DefaultValue("100")
 int maxResults,
 @QueryParam("page") @DefaultValue("1")
 int page)

Returns custom field's options defined in a given context composed of projects and issue types.

If the projects and issue types match more than one context or the context for such a combination does not exist then no options are returned.

Parameters:

customFieldId - id of a custom field.

projectIds - a list of projects in a context.

issueTypeIds - a list of issue types in a context.

query - a string used to filter options. An option matches the query if any word in option's name starts with the given query.

maxResults - a limit of results.

page - the page of options to return.

Returns:

a response containing a collection of options truncated to maxResults with the total number of options meeting the query criteria or an error message.

createErrorResponse

public static javax.ws.rs.core.Response createErrorResponse(ServiceResult result)