Ross ERP Data Dictionary

Overview of the Ross ERP 8.0 schema in one call: object counts by type, module list, total/distinct columns, audit-twin pairs, and the top tables/columns/modules. Use this first to orient before drilling in.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Browse and filter Ross ERP 8.0 objects (tables / views / procedures / functions). Filter by type, database, module, or a name substring; paginate with limit/offset. Returns object summaries — use lookup_table for full detail.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Object type filter: table | view | procedure | function"
    },
    "db": {
      "type": "string",
      "description": "Database filter, e.g. FIN or MAN"
    },
    "module": {
      "type": "string",
      "description": "Module filter, e.g. GL or PO"
    },
    "q": {
      "type": "string",
      "description": "Name substring filter, e.g. GL_"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "description": "Max objects (default 100)"
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "description": "Pagination offset (default 0)"
    }
  },
  "additionalProperties": false
}

Look up a single column by exact name across the whole Ross ERP 8.0 schema: its description, valid values, notes, every table that carries it, and any foreign-key roles it plays.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Column name, e.g. POSTING_DATE or GL_ACCOUNT"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Full schema for a Ross ERP 8.0 object (table / view / procedure / function): columns with type, nullability, keys, descriptions and valid values, foreign keys in and out, related tables, and usage.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Object name, e.g. GL_ACCOUNTS or ACCOUNT_TYPES"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Search the Ross ERP 8.0 schema by name (and column descriptions). Returns matching objects and columns.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search text, e.g. posting_date or GL_ACCOUNTS"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Max results per group (default 25)"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Cross-domain search in one call — spans schema objects, columns, UI facilities and programs at once. Use this when you don't yet know which layer a term lives in (e.g. 'check register' is a screen, a program and a table). Scope to one layer with type = object | column | facility | program (default all); limit is per domain.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search text, e.g. check register or posting_date"
    },
    "type": {
      "type": "string",
      "enum": [
        "all",
        "object",
        "column",
        "facility",
        "program"
      ],
      "description": "Restrict to one domain (default all). 'table' is accepted as an alias for object."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Max results per domain (default 25)"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Return the CREATE TABLE (DDL) for a Ross ERP 8.0 table, with column descriptions as comments plus primary-key and foreign-key constraints.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Table name, e.g. GL_ACCOUNTS"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

List the knowledge-graph neighbours of an object — the programs, tables, views and procedures directly connected to it, with relationship type and direction.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Object name, e.g. GL_ACCOUNTS"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "Max neighbours (default 100)"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Find the shortest path between two objects in the Ross ERP 8.0 knowledge graph (how A reaches B through calls / references / accesses).

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "description": "Start object name"
    },
    "to": {
      "type": "string",
      "description": "Destination object name"
    }
  },
  "required": [
    "from",
    "to"
  ],
  "additionalProperties": false
}

Overview of the Ross ERP 8.0 application layer — the client menu tree of UI facilities (screens, reports, inquiries, maintenance functions): total facilities, and their breakdown by system (e.g. ACCOUNTS_PAYABLE), database (FIN/MAN) and class (REPORT, MAINTENANCE, INQUIRY, ...). Use this first to orient before browsing facilities.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Browse and filter Ross ERP 8.0 UI facilities (menu screens/functions). Filter by system, database, class, a name/code substring, or withTables (only facilities whose table cluster is known); paginate with limit/offset. Returns summaries — use lookup_facility for full detail.

{
  "type": "object",
  "properties": {
    "system": {
      "type": "string",
      "description": "System filter, e.g. ACCOUNTS_PAYABLE or GENERAL_LEDGER"
    },
    "database": {
      "type": "string",
      "description": "Database filter: FIN or MAN"
    },
    "class": {
      "type": "string",
      "description": "Class filter: REPORT | MAINTENANCE | INQUIRY | UPDATE | TRANSACTION | ARCHIVE | CODES"
    },
    "q": {
      "type": "string",
      "description": "Name or code substring, e.g. CHECK or AP_"
    },
    "withTables": {
      "type": "boolean",
      "description": "Only facilities with a known table cluster (default false)"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "description": "Max facilities (default 100)"
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "description": "Pagination offset (default 0)"
    }
  },
  "additionalProperties": false
}

Search Ross ERP 8.0 UI facilities by code, name, help text, program or tag. Use this to find the screen/report for a task, e.g. 'check register' or 'purchase order receipts'.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search text, e.g. check register or AP_A"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Max results (default 25)"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Full detail for one Ross ERP 8.0 UI facility by code: its name, system, database, class, GEMBASE program, help text, menu paths, the physical table cluster it touches — core (the working set the screen is built on) and reference (control/lookup tables) — and its call graph: the facilities this one invokes (calls) and the facilities that invoke it (calledBy), parsed from the program source.

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Facility code, e.g. AP_A_002"
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false
}

Reverse lookup: which UI facilities (screens/reports/programs) touch a given Ross ERP 8.0 table — split into core (facilities whose working set includes it) and reference (facilities that use it as a control/lookup), each with how many times the program source accesses it. Answers 'what screens read or write this table?'.

{
  "type": "object",
  "properties": {
    "table": {
      "type": "string",
      "description": "Table name, e.g. GL_ACCOUNTS"
    }
  },
  "required": [
    "table"
  ],
  "additionalProperties": false
}

Cross-link a UI facility to the program(s) that implement it — 'what code runs this screen?'. Each program carries a match label: declared (named by the facility's menu entry, authoritative) or titleId (TITLE id equals the facility code). Complements lookup_facility (which gives the facility's tables and call graph). Metadata only — no source body.

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Facility code, e.g. AP_A_002"
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false
}

Overview of the Ross ERP 8.0 program catalog — every application-source program (metadata only, no source body): total programs, how many declare a TITLE id, how many carry Data Dictionary table links, total program→table edges, read/write counts (withWrites programs, writeEdges program→table write edges), base vs vendor-core split, program→program call-graph counts (programs with outbound calls, total call edges) and how many back a menu facility, plus the module and type breakdowns. Use this first to orient before browsing programs.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Browse and filter Ross ERP 8.0 programs (application source, metadata only). Filter by module (ap, gl, ic, sop, ...), type (a=archive, i=inquiry, m=maintenance, r=report, s=server, l=load, u=utility, ...), layer (base | vendor-core), titled (only programs that declare a TITLE id), or a substring of basename/title; paginate with limit/offset. Returns summaries — use lookup_program for full detail.

{
  "type": "object",
  "properties": {
    "module": {
      "type": "string",
      "description": "Module filter, e.g. ap, gl, ic, sop"
    },
    "type": {
      "type": "string",
      "description": "Program-type letter, e.g. r (report), m (maintenance), i (inquiry), s (server)"
    },
    "layer": {
      "type": "string",
      "description": "Source layer: base | vendor-core"
    },
    "titled": {
      "type": "boolean",
      "description": "Only programs that declare a TITLE program-id (default false)"
    },
    "q": {
      "type": "string",
      "description": "Substring of basename or title, e.g. check_register"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "description": "Max programs (default 100)"
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "description": "Pagination offset (default 0)"
    }
  },
  "additionalProperties": false
}

Search Ross ERP 8.0 programs by basename, TITLE program-id, title, module or type. Use this to find the program behind a task, e.g. 'check register' or 'ap_a'.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search text, e.g. check register or AP_A_002"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Max results (default 25)"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Full detail for one Ross ERP 8.0 program, by TITLE program-id (e.g. AP_A_002) or source basename (e.g. ap_a_check_register): its module, type, layer, declared title, internal PROCEDURE_FORM procedures, the Data Dictionary tables it references — each classified read vs read-write (a write is a FIND IN.../LOCK=WRITE update, an ADD, or a DELETE) with a writeCount — its call graph (the programs it invokes and the programs that invoke it, from PERFORM "GEM<mod>:<prog>"), the menu facilities it backs, and — for programs with no TITLE label — a display name carried from the menu facility's registry description. Metadata only — no source body.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Program id or basename, e.g. AP_A_002 or ap_a_check_register"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Reverse lookup: which standard Ross ERP 8.0 programs reference a given table (validated against the Data Dictionary). Answers 'what code touches this table?' — complements table_facilities (which answers 'what screens touch it?'). Metadata only — no source body.

{
  "type": "object",
  "properties": {
    "table": {
      "type": "string",
      "description": "Table name, e.g. GL_ACCOUNTS"
    }
  },
  "required": [
    "table"
  ],
  "additionalProperties": false
}

Reverse of facility_programs: which UI facilities (menu screens / reports / inquiries) a program backs — 'what screens does this program run?'. One program often serves several facilities. Lookup by TITLE id (e.g. AP_I_001) or basename (e.g. ap_i_vendors); each facility carries the same declared / titleId match label.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Program id or basename, e.g. AP_I_001 or ap_i_vendors"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}