Skip to main content

GetModifiedDocNames

GetModifiedDocNames

This method returns a list of source code files that have been modified since the time the databases had the specified hashes. It is passed a list of database keys and hashes as a JSON array. The hash values are used to determine if anything has changed in the database defined by the key. Typically, you first call this api with an empty array as the incoming JSON message. This returns the names of all source code files in the namespace with the database key and hash for each file. Then you can post the dbname and dbhash to discover which source code files have been modified on the server since the last call.

You post the list of source code files to check as shown in the following example:

[ { "dbname" : "USER",
    "dbhash" : "KWAGbOdnRblPzANaiv1Oiu0BZLI" 
}, ... ]

URL

POST https://<baseURL>/api/atelier/v1/namespace/modified/type

Where:

The base URL for your instance.

type

Specifies a source code file type as * or a three-letter code, ls, mac, int, inc, bas, or mvi. Default is *.

This call requires the header Content-Type application/json.

JSON Messages

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

[ { "dbname" : "USER", 
    "dbhash" : "Qx1zuNaulq3b_1yR9ahZAfjkc-",
    "crhash" : "47763751EC",
    "docs": [{
            "name": "User.NewClass1.cls",
            "ts": "2016-01-04 14:00:04.000",
            "gen": false,
            "depl": false
            }, ... ]
   }, ... ]

If a source code file has been deleted since the specified dbhash, it is returned in the list with a time stamp set to an empty string:

"ts": ""

If a database was included because of mapping and the mapping is removed, both dbhash and crhash are returned with a "000" value and docs is returned as an empty array.

HTTP Return Codes

  • HTTP 200 if OK.

  • HTTP 400 if the posted content is empty or type is anything other than CLS.

  • HTTP 415 if content type is not application/json.

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

FeedbackOpens in a new tab