2. Fetch Applications, Data Plugs and Data Debits

Applications

Get all the apps

The are 2 ways to fetch applications:

  1. With default options.

Example:

try {
    const result = await hat.applications().getAllDefault();

    if (result.parsedBody) {
        // result.parsedBody contains an array of Applications.
    }
} catch (error) {
    // The request failed...
}

2. With custom options.

Example:

// In custom options you can specify the following parameters: "ordering", "orderBy", "take", "skip"

const options = {
    ordering: "descending",
    orderBy: "name"
};

try {
    const result = await hat.applications().getAll(options);

    if (result.parsedBody) {
        // result.parsedBody contains an array of Applications.
    }
} catch (error) {
    // The request failed...
}

Get an application with a specific ID

Example:

Get an application status

Parameters

Type

application

Example:

Generate a Data Plug setup URL

You can generate a URL to redirect the user to setup a Data Plug.

Parameters

Type

application

redirect

string

fallback

string

Example:

Last updated

Was this helpful?