Programs

Program detail

A program in full: module, type, layer, procedures, the Data Dictionary tables it references (each classified read vs read-write), its program→program call graph (calls / calledBy), the menu facilities it backs, and a display name (registry description for untitled programs). Lookup by TITLE id or basename.

get/v1/programs/{id}

Request

  • Base URL: https://api.rossdata.dev
  • URL: https://api.rossdata.dev/v1/programs/{id}
  • Auth: none declared

Path parameters

idstring required

Response

OK

basenamestring
programIdstring nullable
titlestring nullable
namestring nullable

Display name — TITLE label, or the registry description of a menu facility it backs for untitled programs

registryDescriptionstring nullable

Canonical description of a menu facility this program backs (GEM_FACILITIES)

modulestring
moduleNamestring nullable
typestring nullable
typeNamestring nullable
layer'base' | 'vendor-core'
overridesstring nullable

Layer this vendor-core program overrides

procedureCountinteger
proceduresstring[]

PROCEDURE_FORM block names

tableCountinteger
writeCountinteger

Of the referenced tables, how many the program writes to

sourcestring
linksobject

Example response

{
  "basename": "ap_a_check_register",
  "programId": "AP_A_002",
  "module": "ap",
  "moduleName": "Accounts Payable",
  "type": "a",
  "typeName": "archive",
  "tables": [
    {
      "table": "AP_CONTROLS"
    }
  ],
  "calls": {
    "calls": [
      {
        "basename": "gl_s_post_engine"
      }
    ],
    "calledBy": [
      {
        "basename": "gl_s_post_engine"
      }
    ]
  },
  "menu": [
    {
      "facility": "AP_A_002",
      "url": "https://toc.rossdata.dev/#AP_A_002"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.