Skip to content

Function: getPropertiesKeys() ​

ts
function getPropertiesKeys(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

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

Returns the keys of all properties for the sprint identified by the id. The user who retrieves the property keys is required to have permissions to view the sprint.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ sprintId: string; }-
parameters.sprintIdstringThe ID of the sprint from which property keys will be returned.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; keys?: object[]; }>