Managing tables, views and data using beqom APIs

This article details the use of the data management APIs. This service is used for communication with the beqom application using REST APIs.

This is a tip message.

To authenticate to use the user profile management APIs, refer to Authenticating to use beqom APIs.

Retrieving all tables and views

The following method returns all the tables/views present in the tenant.

Service Action Endpoint Input Output Sample

Gateway

GET

/api/Admin/GetTableViewList

{type}: "table" or "view", nullable

Copy

 {
    "id": -454,
    "supports_datagrid_hierarchy_security": false,
    "text": "k_m_field_perspective",
    "type": "table"
  },
  {
    "id": -302,
    "supports_datagrid_hierarchy_security": false,
    "text": "Kernel_View_Admin_UserProfile",
    "type": "view"
  }

Reading the Data of a Table/View

The following method returns all the records of a selected table/view, with pagination and filtering possibility.

Service Action Endpoint Input Filter Format Output Sample

Gateway

GET

/api/Admin/GetTableViewData

tableViewId
skip, take: for pagination
Filter

Copy

{  
    "fields":[  
        {  
            "Name":"emp_age",
            "Values":[  
                "26"
            ],
            "Type":"9"
        }
    ]
}

//Filter Type

        In = 1,
        NotIn = 2,
        Equals = 3,
        NotEquals = 4,
        StartWith = 5,
        EndWith = 6,
        Contains = 7,
        NotContains = 8,
        Greater = 9,
        Lower = 10,
        EqualGreater = 11,
        EqualLower = 12,
        Between = 13

Copy

{
  "count": 240,
  "records": [
    {
      "band": "Band C",
      "base_salary": 64260,
      "bonus_split_businessunit_margin": 12,
      "bonus_split_businessunit_opex": 6,
      "bonus_split_businessunit_revenue": 12,
      "bonus_split_division": 40,
      "bonus_split_individual": 30,
      "bu_margin_attainment": 0.96,
      "bu_margin_result": 112824,
  ],
  "_expandable": null
}

Adding a Single Record to a Table/View

The following method inserts a single record.

This is an attention message.

This method works only for tables.

Service	Action	Endpoint	Input	Output
Gateway	POST	/api/Admin/AddTableViewData	tableViewID	New object payload

Adding Several Records to a Table/View

The following method bulk inserts records.

This is an attention message.

This method works only for tables.

Service	Action	Endpoint	Input	Output
Gateway	POST	/api/Admin/AddBulk	tableViewID	Array of objects

The bulk operation takes column names from the first record in the body. It then generates an SQL query using columns in the first record and table name in k_referential_tables_views. If there is a difference in column names between records (either the column names are different or the number of columns does not match), then the system returns "500 INTERNAL ERROR".

Updating a Record Within a Table/View

The following method updates a record in an existing table/view. The method operates at property-level.

This is an attention message.

This method works only for tables.

Service	Action	Endpoint	Input
Gateway	PATCH	/api/Admin/UpdateTableViewData	tableViewID recordId

Deleting a Record from a Table/View

The following method deletes a record from an existing table/view.

This is an attention message.

This method works only for tables.

Service	Action	Endpoint	Input
Gateway	DELETE	/api/Admin/DeleteTableViewData	tableViewID recordId

Obtaining Parent/Child Relations

The following method returns child grid records.

Service	Action	Endpoint	Input	Output Sample
Gateway	GET	/api/Admin/GetDatabaseTablesValueWithPaging	gridId: child grid ID pageNum pageSize customFilterColumn sortValue filter sortAscDesc idSim isStaging parentSelectedRowId: ID of the row selected in the parent grid parentGridId: parent grid ID idGridSecurityTree	Copy `{ "totalRows": 3, "records": [ { "idCity": "1", "idCountry": "1", "nameCity": "Istanbul" }, { "idCity": "2", "idCountry": "1", "nameCity": "Ankara" }, { "idCity": "3", "idCountry": "1", "nameCity": "Izmir" } ] }`

Obtaining Drop-Down Associations

The following method returns relational records for drop-down lists.

Service	Action	Endpoint	Input	Output Sample
Gateway	GET	/api/Admin/GetGridFieldAssociatedData	idGrid: idGridField condition searchPattern paheNum pageSize uniqueId cascadeFilter: [{"parentColumnId":<value>,"value":"1"}]. Where parentColumnId is the idGridField of the parent and value is the relational column value	Copy `{ "totalRows": 2, "records": [ { "display_column": "Spain", "value_column": "2" }, { "display_column": "Turkey", "value_column": "1" } ] }`

Exporting a Table/View

There are four methods to perform this operation:

Service	Action	Endpoint	Input	Output
Gateway	POST	/api/Kernel/CheckAndAddServiceMethodCall	serviceId: serviceMethodId itemId	callId

Service	Action	Endpoint	Input
Gateway	GET	/api/Admin/ExportGrid	idGrid: sortV sortAscDsc pageNumber pageSize filter idSim password selectedRowId: string, not nullable; value can be "undefined" parentGridId: nullable idSecurityView: nullable callId: obtained from /api/Admin/CheckAndAddServiceMethodCall lookModuleRights

Service	Action	Endpoint	Input	Output Sample
Gateway	GET	/api/Kernel/GetServiceMethodCallResponse	callId	"Daily\\Excel\\e14ab341-eb46-426e-bf7c-655858aec029.xlsm"

Service	Action	Endpoint	Input
Gateway	GET	/api/File/ExportExcel	fileType: 3 for Excel fileUid: obtained from GetServiceMethodCallResponse downloadFileName

Importing a Grid

The following method imports data in a grid:

Service	Action	Endpoint	Input
Gateway	GET	/api/Data/ImportGrid	files: type = List<IFormFile> idGrid selectedRowId: string, not nullable; value can be "underfined" parendGridId idSecurityView password

HTTP Output

Standard HTTP output

200 Succeeded
401 Unauthorized
404 Not found
500 Internal error

Attachments

zd_v10-help.4.log-567539263.zip
10 KB Download