Function: getStatus()

function getStatus(client, parameters): Promise<{
[key: string]: unknown;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  scope?: {
   [key: string]: unknown;
     project?: {
      [key: string]: unknown;
        avatarUrls?: {
         [key: string]: unknown;
           16x16?: string;
           24x24?: string;
           32x32?: string;
           48x48?: string;
        };
        id?: string;
        key?: string;
        name?: string;
        projectCategory?: {
         [key: string]: unknown;
           description?: string;
           id?: string;
           name?: string;
           self?: string;
        };
        projectTypeKey?:   | string & object
           | "software"
           | "service_desk"
           | "business"
           | "product_discovery"
           | "customer_service";
        self?: string;
        simplified?: boolean;
     };
     type?: string & object | "PROJECT" | "TEMPLATE";
  };
  self?: string;
  statusCategory?: {
   [key: string]: unknown;
     colorName?: string;
     id?: number;
     key?: string;
     name?: string;
     self?: string;
  };
  untranslatedName?: string;
}>;

Defined in: src/cloud/api/workflowStatuses.ts:39

Returns a status. The status must be associated with an active workflow to be returned.

If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ idOrName: string; }	-
parameters.idOrName	string	The ID or name of the status.

Returns

Promise<{ [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; id?: string; key?: string; name?: string; projectCategory?: { [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; statusCategory?: { [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }; untranslatedName?: string; }>