Class Status

Index

Constructors

Methods

createStatuses deleteStatusesById getProjectIssueTypeUsagesForStatus getProjectUsagesForStatus getStatusesById getWorkflowUsagesForStatus search updateStatuses

Constructors

constructor

new Status(client: Client): Version3.Status
Parameters
- client: Client
Returns Version3.Status
- Defined in src/version3/status.ts:8

Methods

createStatuses

createStatuses<T = Version3Models.JiraStatus[]>(
parameters: Version3Parameters.CreateStatuses,
callback: Callback<T>,
): Promise<void>
Creates statuses for a global or project scope.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = Version3Models.JiraStatus[]
Parameters
- parameters: Version3Parameters.CreateStatuses
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:60
createStatuses<T = Version3Models.JiraStatus[]>(
parameters: Version3Parameters.CreateStatuses,
callback?: undefined,
): Promise<T>
Creates statuses for a global or project scope.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = Version3Models.JiraStatus[]
Parameters
- parameters: Version3Parameters.CreateStatuses
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:72

deleteStatusesById

deleteStatusesById<T = void>(
parameters: string | Version3Parameters.DeleteStatusesById,
callback: Callback<T>,
): Promise<void>
Deletes statuses by ID.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteStatusesById
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:127
deleteStatusesById<T = void>(
parameters: string | Version3Parameters.DeleteStatusesById,
callback?: undefined,
): Promise<T>
Deletes statuses by ID.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteStatusesById
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:139

getProjectIssueTypeUsagesForStatus

getProjectIssueTypeUsagesForStatus<T = StatusProjectIssueTypeUsage>(
parameters: Version3Parameters.GetProjectIssueTypeUsagesForStatus,
callback: Callback<T>,
): Promise<void>
Returns a page of issue types in a project using a given status.
Type Parameters
- T = StatusProjectIssueTypeUsage
Parameters
- parameters: Version3Parameters.GetProjectIssueTypeUsagesForStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:198
getProjectIssueTypeUsagesForStatus<T = StatusProjectIssueTypeUsage>(
parameters: Version3Parameters.GetProjectIssueTypeUsagesForStatus,
callback?: undefined,
): Promise<T>
Returns a page of issue types in a project using a given status.
Type Parameters
- T = StatusProjectIssueTypeUsage
Parameters
- parameters: Version3Parameters.GetProjectIssueTypeUsagesForStatus
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:203

getProjectUsagesForStatus

getProjectUsagesForStatus<T = StatusProjectUsage>(
parameters: Version3Parameters.GetProjectUsagesForStatus,
callback: Callback<T>,
): Promise<void>
Returns a page of projects using a given status.
Type Parameters
- T = StatusProjectUsage
Parameters
- parameters: Version3Parameters.GetProjectUsagesForStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:224
getProjectUsagesForStatus<T = StatusProjectUsage>(
parameters: Version3Parameters.GetProjectUsagesForStatus,
callback?: undefined,
): Promise<T>
Returns a page of projects using a given status.
Type Parameters
- T = StatusProjectUsage
Parameters
- parameters: Version3Parameters.GetProjectUsagesForStatus
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:229

getStatusesById

getStatusesById<T = Version3Models.JiraStatus[]>(
parameters: string | Version3Parameters.GetStatusesById,
callback: Callback<T>,
): Promise<void>
Returns a list of the statuses specified by one or more status IDs.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = Version3Models.JiraStatus[]
Parameters
- parameters: string | Version3Parameters.GetStatusesById
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:18
getStatusesById<T = Version3Models.JiraStatus[]>(
parameters: string | Version3Parameters.GetStatusesById,
callback?: undefined,
): Promise<T>
Returns a list of the statuses specified by one or more status IDs.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = Version3Models.JiraStatus[]
Parameters
- parameters: string | Version3Parameters.GetStatusesById
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:30

getWorkflowUsagesForStatus

getWorkflowUsagesForStatus<T = StatusWorkflowUsage>(
parameters: Version3Parameters.GetWorkflowUsagesForStatus,
callback: Callback<T>,
): Promise<void>
Returns a page of workflows using a given status.
Type Parameters
- T = StatusWorkflowUsage
Parameters
- parameters: Version3Parameters.GetWorkflowUsagesForStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:250
getWorkflowUsagesForStatus<T = StatusWorkflowUsage>(
parameters: Version3Parameters.GetWorkflowUsagesForStatus,
callback?: undefined,
): Promise<T>
Returns a page of workflows using a given status.
Type Parameters
- T = StatusWorkflowUsage
Parameters
- parameters: Version3Parameters.GetWorkflowUsagesForStatus
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:255

search

search<T = Version3Models.PageOfStatuses>(
parameters: undefined | Version3Parameters.Search,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of statuses that match a search on name or project.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = Version3Models.PageOfStatuses
Parameters
- parameters: undefined | Version3Parameters.Search
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:166
search<T = Version3Models.PageOfStatuses>(
parameters?: Version3Parameters.Search,
callback?: undefined,
): Promise<T>
Returns a paginated list of statuses that match a search on name or project.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = Version3Models.PageOfStatuses
Parameters
- Optionalparameters: Version3Parameters.Search
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:179

updateStatuses

updateStatuses<T = void>(
parameters: Version3Parameters.UpdateStatuses,
callback: Callback<T>,
): Promise<void>
Updates statuses by ID.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateStatuses
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:97
updateStatuses<T = void>(
parameters: Version3Parameters.UpdateStatuses,
callback?: undefined,
): Promise<T>
Updates statuses by ID.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateStatuses
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:106

Class Status

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Status

Methods

createStatuses

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteStatusesById

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectIssueTypeUsagesForStatus

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectUsagesForStatus

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getStatusesById

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowUsagesForStatus

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

search

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateStatuses

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page