Interface Search

interface Search {
    expand?: string | string[] | ("usages" | "workflowUsages")[];
    maxResults?: number;
    projectId?: string;
    searchString?: string;
    startAt?: number;
    statusCategory?: string;
}

Properties

expand? maxResults? projectId? searchString? startAt? statusCategory?

Properties

Optional expand

expand?: string | string[] | ("usages" | "workflowUsages")[]

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • usages Returns the project and issue types that use the status in their workflow.
  • workflowUsages Returns the workflows that use the status.

Optional maxResults

maxResults?: number

The maximum number of items to return per page.

Optional projectId

projectId?: string

The project the status is part of or null for global statuses.

Optional searchString

searchString?: string

Term to match status names against or null to search for all statuses in the search scope.

Optional startAt

startAt?: number

The index of the first item to return in a page of results (page offset).

Optional statusCategory

statusCategory?: string

Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

Settings

Member Visibility

Theme

On This Page

expandmaxResultsprojectIdsearchStringstartAtstatusCategory