Introduction

@thotnr-aws-accl/custom-app-api / Exports

Citta provides a basic in-built app renderer but if there is a need for a custom experience using the data in the objects of a application, a cli and javascript SDK is provided to built and upload a custom HTML/JS based application. The SDK provides a comprehensive utility for managing job executions and performing GraphQL-based data operations for modifying records.

A summary of operations provided through the SDK:

  1. Job Execution Management:

    • executeJob: Executes a job with optional parameters, progress tracking, and error handling. Returns the job execution status.

    • getAllJobExecutions: Fetches all job executions for a given list of job execution IDs.

    • getJobExecution: Retrieves the status of a specific job execution.

    • getJobExecutionStepLogs: Fetches logs for a given job execution, providing insight into execution steps.

    • getJobSteps: Retrieves the steps associated with a particular job code.

  2. Object Record Management:

    • ObjectRecords: A class for managing records for objects.

    • createGraphqlcall: Creates records for an object using GraphQL.

    • createRecords: Allows bulk creation of records with options for error handling and callbacks.

    • deleteGraphqlcall: Deletes records for an object using GraphQL.

    • getStructString: Retrieves a list of records for a struct or object.

    • getUserList: Fetches a list of users for the current tenant.

    • query: Executes GraphQL queries to fetch records for an object.

    • updateGraphqlcall: Updates records for an object using GraphQL.

Last updated