@tridion-sites/open-api-client v3.0.0

Tridion Sites Open API Client for Extensions

This package allows extensions developers to easily interact with Tridion Sites API. It provides a convenient interface for making HTTP requests and working with the API.

Note

Due to reliance on various functionality provided at runtime by Tridion Sites, this package is not suitable for standalone usage and can only be utilized as a part of an extension.

Features

• Ready-to-use typescript client for Tridion Sites Open API
• Automatic escaping of TCM URIs
• Compatible with @tridion-sites/models

Installation

To install @tridion-sites/open-api-client, you can use npm or yarn:

$ npm install @tridion-sites/open-api-client
# or
$ yarn add @tridion-sites/open-api-client

Usage

import type { ActivityInstance } from '@tridion-sites/open-api-client';
import { ApiError, WorkflowService } from '@tridion-sites/open-api-client';

export const restartActivity = async (itemUri: string): Promise<ActivityInstance | undefined> => {
    try {
        const activity = await WorkflowService.restartActivity(itemUri);
        return activity;
    } catch (error) {
        if (error instanceof ApiError) {
            console.error(error.message, error);
        } else {
            console.log('Unknown error', error);
        }
    }

    return undefined;
};

// Note that we don't need to escape TCM URIs because the client handles this for us
const activity = await restartActivity('tcm:5-35-131104');

API Documentation

Documentation for all available services, their methods and interfaces can be found at http://developers.rws.com/tridion-sites-extensions-api-docs/open-api-client.html