Class: FieldClient

FieldClient(jiraClient)

new FieldClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/field'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

createCustomField(opts, callbackopt) → {Promise}

Creates a custom field using a definition (object encapsulating custom field data)

Parameters:
Name Type Attributes Description
opts

The request options to send to Jira

Properties
Name Type Description
field

See https://docs.atlassian.com/jira/REST/latest/#d2e3412

callback <optional>

Called when the custom field has been created.

Source:
Returns:

Resolved when the custom field has been created.

Type
Promise

getAllFields(opts, callbackopt) → {Promise}

Returns a list of all fields, both System and Custom

Parameters:
Name Type Attributes Description
opts

Ignored

callback <optional>

Called when the fields have been retrieved.

Source:
Returns:

Resolved when the fields have been retrieved.

Type
Promise