skills.rest
Cumulocity-IoT
Cumulocity-IoTOFFICIAL
Explore all skills by this author →
GitHub

@c8y/client API Usage

Document @c8y/client TypeScript SDK usage for Cumulocity IoT REST API operations.

5|Updated Jan 29, 2026
Search Tags:#typescript#api#rest#sdk#iot#cumulocity
One-click install
npx skills add https://github.com/Cumulocity-IoT/cumulocity-skills --skill c8y-client-api-usage
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: @c8y/client API Usage
Source: https://github.com/Cumulocity-IoT/cumulocity-skills/tree/main/skills/c8y-client-api
Command: npx skills add https://github.com/Cumulocity-IoT/cumulocity-skills --skill c8y-client-api-usage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill simplifies interacting with the Cumulocity IoT REST API by providing clear mappings and usage patterns for the @c8y/client TypeScript SDK, reducing the complexity of direct HTTP calls.

Core Features & Use Cases

  • API Endpoint Mapping: Understand how SDK service methods correspond to specific REST API endpoints.
  • CRUD Operations: Learn to fetch, create, update, and delete resources like managed objects, alarms, and measurements.
  • Advanced Querying: Master complex filtering and sorting using listQuery and QueriesUtil for inventory data.
  • Use Case: Efficiently retrieve all active alarms for a specific device, filter measurements by date range, or query managed objects based on custom criteria.

Quick Start

Use the c8y-client-api skill to find the correct method for fetching a specific managed object by its ID.

Frequently Asked Questions about @c8y/client API Usage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I query Cumulocity IoT managed objects using the TypeScript SDK?▼

Query Cumulocity IoT managed objects by utilizing @c8y/client TypeScript SDK service methods alongside listQuery and QueriesUtil for advanced filtering. This maps SDK methods to REST API endpoints, enabling efficient inventory data retrieval using custom criteria.

What is the best way to fetch active alarms for a specific device in Cumulocity IoT?▼

The best way to fetch active alarms for a specific device is using the @c8y/client TypeScript SDK. It provides dedicated service methods that map to Cumulocity IoT REST API endpoints, simplifying complex HTTP calls for retrieving filtered alarm data.

How does the Cumulocity IoT TypeScript SDK map to REST API endpoints?▼

The @c8y/client TypeScript SDK maps service methods directly to Cumulocity IoT REST API endpoints for CRUD operations. This reduces the complexity of direct HTTP calls when managing resources like managed objects, alarms, and measurements.

Can I filter Cumulocity IoT measurements by date range using TypeScript?▼

You can filter Cumulocity IoT measurements by date range using the @c8y/client TypeScript SDK. It supports advanced querying with filter interfaces and query language, allowing precise retrieval of measurement data within specific timeframes.

Do I need direct HTTP calls for Cumulocity IoT backend development?▼

You do not need direct HTTP calls for Cumulocity IoT backend development if you use the @c8y/client TypeScript SDK. It provides comprehensive service methods and return types that simplify interacting with the REST API for common operations.

Related Skills

Explore More Software Engineering Skills→
Cumulocity-IoTCumulocity-IoT
5

C8Y Client Breaking Changelog

Log breaking changes in the Cumulocity IoT client library.

Official
Basic
Celia-12Celia-12

external_apis

Proxy external web API calls with automatic authentication and asset storage.

Community
Intermediate
daffy0208daffy0208
34

iot-developer

Integrate sensors and devices into IoT systems using MQTT and WebSocket communications.

Community
Intermediate
ericwang915ericwang915
38

http_request

Perform HTTP requests to any API endpoint with custom headers and JSON payloads.

Community
Intermediate