Skip to content

Introduction

Overview

For the dataset defination, dataset defined mapping 1-1 with end tables specific in database.

Currently, our intenral operation has been working with namespace of Innotech provider only.

So for design with the datasets, each view of dataset will be mapping into path of /datasets/{id}

In some case, for special events, it's will mapping with the prefix of namespace after id, likewise of /datasets/{namespace}/{id}

Global concept of workloads for datasets

Introduction

Each dataset will mapping related to API endpoints that interactive with database layer with following actions:

Endpoint Description Comment
GET /{dataset} View the datset with filterset
POST /{dataset} Insert a record
PUT /{dataset} Update a record
PATCH /{dataset} Update fields related to a record *
POST /{dataset}/bulk/import Bulk import from a file or memory of multiple records **
DELETE /{dataset}/{record-id} Delete a record by record UUID
POST /{dataset}/{action} Checker has actions related to maker actions ***

Note:

  • (*) Method PATCH currently not supported, at 2024-05-06

  • (**) Bulk import supported for specific datasets, not apply to global concept

  • (***) For the action related to declare at Action

Required Permission

Included handle:

(a) Add the authentication by headers key in X-Requested-By

(b) There are related to matrix handler permissions for each records. The sample of permission of tables

Task Admin Operation
TASK-01 X X
TASK-02 X X
...
TASK-04 X X
TASK-05 X

Table of datasets

No. Namespace Datasets Go to
1 INNO Quote View > Datasets > Quote
2 INNO Corporate Action View > Datasets > Corporate Action
3 INNO Settlement View > Datasets > Settlement
4 INNO Historical Outstanding Share View > Datasets > Historical Outstanding Share