Function: getProperty()

function getProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key: string;
  value: unknown;
}>;

Defined in: src/agile/api/sprint.ts:230

Returns the value of the property with a given key from the sprint identified by the provided id. The user who retrieves the property is required to have permissions to view the sprint.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ propertyKey: string; sprintId: string; }	-
parameters.propertyKey	string	The key of the property to return.
parameters.sprintId?	string	The ID of the sprint from which the property will be returned.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; key: string; value: unknown; }>