Skip to main content

API endpoints screen

The API Endpoints screen has Grouped and Flat views.

N
Written by Niyaz

The API Endpoints screen has Grouped and Flat views. Open API Endpoints in the ERP Manager menu to see the list.

API Endpoints in Grouped view with function rows and expanded endpoint tables

List view

Grouped is selected initially; the list also includes Search function, Sync, New fan-out group and Create.

Views and controls

Control

Details

Grouped

Selected view with function rows and nested endpoint tables.

Flat

Selecting this tab opens the Flat view.

Search function

Text field with the placeholder Search function…

Grouped table columns

Column

What it shows

Function

Function identifier; some rows also have a ⚠ no group link.

Group · data mapping

Group or data mapping names for the function row.

Members

Membership column in the function table.

Ready

Ready counts expressed as a fraction for each function row.

Cron

Cron counts expressed as a fraction for each function row.

Expanded endpoint columns

Column

What it shows

Endpoint

Endpoint identifier.

Data mapping

Data mapping name for the endpoint.

Query

Query indicator for the endpoint.

Ready

Ready indicator for the endpoint.

Cron

Cron indicator for the endpoint.

Member of

Membership column in the endpoint table.

Endpoint form

The form heading reads Edit Api Endpoint when an existing record is open.

Edit Api Endpoint form with Data mapping and Api function selectors, four switches and a toolbar

Fields

Field

Required

What it holds

Data mapping

Required.

Data mapping selector. On an existing record, this field and the Open button beside it are disabled.

Api function

Required.

API function selector. On an existing record, this field is disabled.

Ready

Optional.

This field is a switch.

Cron Job

Optional.

This field is a switch.

Sync once

Optional.

This field is a switch.

Pricing Calculator

Optional.

This field is a switch.

Toolbar actions

Action

What it does

Save

Disabled when an existing record is first opened.

Notes

  • The Data mapping and Api function fields are disabled on an existing record.

Related

Did this answer your question?