Skip to content

Function: getStatus() ​

ts
function getStatus(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
  statusCategory?: {
   [key: string]: unknown;
     colorName?: string;
     id?: number;
     key?: string;
     name?: string;
     self?: string;
  };
  statusColor?: string;
}>;

Defined in: src/server/api/workflowStatuses.ts:45

Returns a full representation of the Status having the given id or name.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ idOrName: string; }-
parameters.idOrNamestringA numeric Status id or a status name
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }>