Function: getPortal()

function getPortal(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  description?: string;
  get_links?: {
   [key: string]: unknown;
     self?: string;
  };
  id?: number;
  name?: string;
  self?: string;
}>;

Defined in: src/serviceDeskServer/api/portals.ts:10

Get a portal with the specified ID.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ portalId: string; }	-
parameters.portalId	string	The id of the portal.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; description?: string; get_links?: { [key: string]: unknown; self?: string; }; id?: number; name?: string; self?: string; }>