GetDocNames

This method returns a list of source code file names. The optional cat and type constrain the types of source code files.

For an example and additional details, refer to Getting the Source Code Files Defined in a Namespace.

URL

GET https://<baseURL>/api/atelier/v1/namespace/docnames

GET https://<baseURL>/api/atelier/v1/namespace/docnames/cat

GET https://<baseURL>/api/atelier/v1/namespace/docnames/cat/type

Where:

The base URL for your instance.

cat

Specifies a category code: CLS = class; RTN = routine; CSP = CSP file (not recommended for use with InterSystems IRIS); OTH = other. Default is *.

type

Specifies a source code file type. Can be an * wildcard or a file type. For CLS, type must be *. For RTN, type may be mac, int, inc, bas ,mvi, or mvb. For CSP, type can be a list of file types such as js or css separated by commas. Default is *.

URL Parameters

The URL parameter 'generated=1' specifies that generated source code files should be included.
The URL parameter 'filter' provides a SQL filter that can be used to match the names.

JSON Messages

The following is the returned content, an array of source code file descriptors:

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": {
    "content": [
      {
        "name": "%Api.DocDB.cls",
        "cat": "CLS",
        "ts": "2016-08-03 20:01:42.000",
        "upd": true,
        "db": "IRISLIB",
        "gen": false
      },
      ...
      {
        "name": "EnsProfile.mac",
        "cat": "RTN",
        "ts": "2003-09-19 13:53:31.000",
        "upd": true,
        "db": "INVENTORYR",
        "gen": false
      },
      ...
      {
        "name": "xyz.mac",
        "cat": "RTN",
        "ts": "2016-08-11 15:05:02.167",
        "upd": false,
        "db": "INVENTORYR",
        "gen": false
      }
    ]
  }
}

HTTP Return Codes

HTTP 200 if OK.
HTTP 500 if an unexpected error occurred (details will be in status error array).

GetModifiedDocNames

GetNamespace