Class Status

Index

Constructors

Methods

createStatuses deleteStatusesById getProjectIssueTypeUsagesForStatus getProjectUsagesForStatus getStatusesById getStatusesByName getWorkflowUsagesForStatus search updateStatuses

Constructors

constructor

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

Methods

createStatuses

createStatuses<
    T = {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[],
>(
    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 = {
      description: string;
      id: string;
      name: string;
      scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
      statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
      usages?: { issueTypes?: string[]; project?: { id: string } };
  }[]
Parameters
- parameters: Version3Parameters.CreateStatuses
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:64
createStatuses<
    T = {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[],
>(
    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 = {
      description: string;
      id: string;
      name: string;
      scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
      statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
      usages?: { issueTypes?: string[]; project?: { id: string } };
  }[]
Parameters
- parameters: Version3Parameters.CreateStatuses
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:76

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:131
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:143

getProjectIssueTypeUsagesForStatus

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

getProjectUsagesForStatus

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

getStatusesById

getStatusesById<
    T = {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[],
>(
    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 = {
      description: string;
      id: string;
      name: string;
      scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
      statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
      usages?: { issueTypes?: string[]; project?: { id: string } };
  }[]
Parameters
- parameters: string | Version3Parameters.GetStatusesById
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:22
getStatusesById<
    T = {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[],
>(
    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 = {
      description: string;
      id: string;
      name: string;
      scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
      statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
      usages?: { issueTypes?: string[]; project?: { id: string } };
  }[]
Parameters
- parameters: string | Version3Parameters.GetStatusesById
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:34

getStatusesByName

getStatusesByName<
    T = {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[],
>(
    parameters: { name: string[]; projectId?: string },
    callback: Callback<T>,
): Promise<void>
Returns a list of the statuses specified by one or more status names.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
- Browse projects project permission.
Type Parameters
- T = {
      description: string;
      id: string;
      name: string;
      scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
      statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
      usages?: { issueTypes?: string[]; project?: { id: string } };
  }[]
Parameters
- parameters: { name: string[]; projectId?: string }
  - name: string[]
    The list of status names.
    
    Min items 1, Max items 50
  - OptionalprojectId?: string
    The project the status is part of or null for global statuses.
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:170
getStatusesByName<
    T = {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[],
>(
    parameters: { name: string[]; projectId?: string },
    callback?: undefined,
): Promise<T>
Returns a list of the statuses specified by one or more status names.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
- Browse projects project permission.
Type Parameters
- T = {
      description: string;
      id: string;
      name: string;
      scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
      statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
      usages?: { issueTypes?: string[]; project?: { id: string } };
  }[]
Parameters
- parameters: { name: string[]; projectId?: string }
  - name: string[]
    The list of status names.
    
    Min items 1, Max items 50
  - OptionalprojectId?: string
    The project the status is part of or null for global statuses.
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:183

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:300
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:305

search

search<
    T = {
        isLast: boolean;
        maxResults: number;
        self: string;
        startAt: number;
        total: number;
        values: {
            description: string;
            id: string;
            name: string;
            scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
            statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
            usages?: { issueTypes?: string[]; project?: { id: string } };
        }[];
    },
>(
    parameters: Version3Parameters.Search | undefined,
    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 = {
      isLast: boolean;
      maxResults: number;
      self: string;
      startAt: number;
      total: number;
      values: {
          description: string;
          id: string;
          name: string;
          scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
          statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
          usages?: { issueTypes?: string[]; project?: { id: string } };
      }[];
  }
Parameters
- parameters: Version3Parameters.Search | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/status.ts:214
search<
    T = {
        isLast: boolean;
        maxResults: number;
        self: string;
        startAt: number;
        total: number;
        values: {
            description: string;
            id: string;
            name: string;
            scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
            statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
            usages?: { issueTypes?: string[]; project?: { id: string } };
        }[];
    },
>(
    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 = {
      isLast: boolean;
      maxResults: number;
      self: string;
      startAt: number;
      total: number;
      values: {
          description: string;
          id: string;
          name: string;
          scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
          statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
          usages?: { issueTypes?: string[]; project?: { id: string } };
      }[];
  }
Parameters
- Optionalparameters: Version3Parameters.Search
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/status.ts:227

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:101
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:110

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>

getStatusesByName

Type Parameters

Parameters

name: string[]

OptionalprojectId?: string

Returns Promise<void>

Type Parameters

Parameters

name: string[]

OptionalprojectId?: string

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

`Optional`projectId?: string

`Optional`projectId?: string