Skip to main content

GetDocs

GetDocs

This method returns the text for the all of the specified source code files in the namespace.

URL

POST https://<baseURL>/api/atelier/v1/namespace/docs

Where <baseURL> is the base URL for your instance.

A list of source code files to be fetched is passed in the body of the http request. The request body is a JSON array of names of source code files you want to fetch. For example, [ "%Api.DocDB.cls", ... ].

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

JSON Messages

Return content is an array of source code file objects. See GetDoc method for an example of the structure of a source code file object.

Errors pertaining to a source code file will be in the status property of each source code file object. This method does NOT support the storageOnly flag. Neither does it do ETAG checking (and therefore will not return an HTTP 304 under any circumstances).

HTTP Return Codes

  • HTTP 200 if OK.

  • HTTP 415 if the passed 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