JOC API

Version 1.13.1

Download RAML
JOC API
/documentations
POST

Sends collection of documentations


Parameters in the POST body schema

Name Type Description Example Default
jobschedulerId required, string JobScheduler Master ID scheduler
documentations optional, array Filtered response by a collection of documentations specified by its documentation path. Some other parameters such as folders and regex are ignored if this parameter is defined. [
"/sos/myDocu.html",
"/sos/myDocu/img/my.gif"
]
regex optional, string Regular expression to filter the collection .*
folders optional, string collection of folder objects [{
"folder": "/sos",
"recursive": true
}]
types optional, array This parameter restricts the documentations. Only documentations are in the response with specified media subtypes
Supported types are ["html", "xml", "xsl", "xsd", "javascript", "json", "css", "markdown", "gif", "jpeg", "png"]
[
"html",
"xml"
]