Function: setProperty()

function setProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Sets the value of the specified sprint's property.

You can use this resource to store a custom data against the sprint identified by the id. The user who stores the data is required to have permissions to modify the sprint.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ propertyKey: string; propertyValue: Record<string, any>; sprintId: string; }	-
parameters.propertyKey	string	The key of the sprint's property. The maximum length of the key is 255 bytes.
parameters.propertyValue?	Record<string, any>	-
parameters.sprintId?	string	The ID of the sprint on which the property will be set.
options?	RequestOptions	-

Returns

Promise<void>