Nifty PMInstall

Summary

Archive or unarchive a task.

Inputs

• taskId (required) — The task to operate on. Select from the task list or provide an ID directly. Modes: 'From List' (searchable via getTasks) or 'By ID'. Defaults to list mode with empty value, requiring explicit selection or ID input before execution.
• archived (required) — Whether to archive (true) or unarchive (false) the task. Sent as the request body property 'archived'. Defaults to true.
• requestOptions — Collection of request-level settings including batching, proxy, SSL validation, and timeout. Is a node setting (applies globally unless overridden). Default is an empty object.

Output shape

The Nifty PM API returns the updated task object with the archived status reflected. Exact shape depends on the API response but typically includes task ID, name, and archived boolean.

The archived parameter is transmitted as the request body. Batching settings (items per batch and interval) throttle API calls when processing multiple tasks. SSL certificate validation can be disabled via allowUnauthorizedCerts if required, though this is insecure. Proxy and timeout settings follow standard HTTP conventions.

Examples

Example 1: Archive a specific task by ID

Set taskId to 'abc123' and archived to true. No requestOptions needed for a single request.

Example 2: Unarchive multiple tasks with batching

Set taskId to a list of task IDs, archived to false, and configure requestOptions.batch.batchSize to 50 and batchInterval to 1000 to throttle the unarchive operations.