MarkLogic Server 11.0 Product DocumentationGET /manage/v2?view=describe
Summary
This resource address returns a description of the methods available on this endpoint.
| URL Parameters | |
|---|---|
| format | The format of the returned data. Allowed values:
html, json, or xml (default). This value overrides
the Accept header if both are present.
|
| Request Headers | |
|---|---|
| Accept | The expected MIME type of the response.
If the format parameter is present, it takes precedence over the Accept
header.
|
Response
Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data.
Required Privileges
This operation requires themanage-user role, or the following
privilege: http://marklogic.com/xdmp/privileges/manage
Usage Notes
The JSON output for this request minimally matches the OPENAPI specification. For details, see http://swagger.io.specification.Example
curl --anyauth --user username:password -i -H "Accept: application/xml" \
http://localhost:8002/manage/v2?view=describe
==> MarkLogic responds with output similar to the following. (The output has
been truncated in this example.)
HTTP/1.1 200 OK
Content-type: application/xml; charset=UTF-8
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 571873
Connection: Keep-Alive
Keep-Alive: timeout=5
<describe xmlns="http://marklogic.com/manage/describe">
<info>
<title>REST Management API</title>
<description>OpenAPI definition of the REST Management API.</description>
<version>v2</version>
</info>
<host>localhost:8002</host>
<schemes>
<scheme>http</scheme>
</schemes>
<basePath>/manage/v2</basePath>
<paths>
<path uri="">
<method type="get">
<type>get</type>
<tags>
<tag>datetime</tag>
</tags>
<summary>GET Method</summary>
<description/>
<consumes/>
<produces/>
<parameters>
<parameter>
<name>fullrefs</name>
<in>query</in>
<description/>
<required>false</required>
<type>boolean</type>
</parameter>
...
</parameters>
<responses>
<response status="200">
<description>retrieve resource</description>
<schema ref="#/definitions/Resource"/>
</response>
<response status="default">
<description>error</description>
<schema ref="#/definitions/Error"/>
</response>
</responses>
</method>
</path>
...
Example
curl --anyauth --user username:password -i -H "Accept: application/json" \
http://localhost:8002/manage/v2?view=describe
==> MarkLogic responds with output similar to the following. (The output has
been truncated in this example.)
HTTP/1.1 200 OK
Content-type: application/json; charset=UTF-8
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 307980
Connection: Keep-Alive
Keep-Alive: timeout=5
{"swagger":"2.0",
"info":{
"title":"REST Management API",
"description":"OpenAPI definition of the REST Management API.",
"version":"v2"
},
"host":"localhost:8002",
"schemes":["http"],
"basePath":"/manage/v2",
"paths":{
"":{
"get":{
"tags":["unsupported-versions"],
"summary":"GET Method",
"description":"",
"consumes":[],
"produces":[
"application/xml",
"application/json",
"text/html"
],
"parameters":[
{ "name":"fullrefs",
"in":"query",
"description":"",
"required":false,
"type":"boolean"
},
{ "name":"view",
"in":"query",
"description":"",
"required":false,
"type":"string",
"enum":["default"]
},
{ "name":"format",
"in":"query",
"description":"",
"required":false,
"type":"string",
"enum":["xml", "json", "html"]
}
],
"responses":{
"200":{
"description":"retrieve resource",
"schema":{"$ref":"#/definitions/Resource"}},
"default":{
"description":"error",
"schema":{"$ref":"#/definitions/Error"}
}
}
},
"options":{ ... },
"head":{ ... },
},
...
}
"definitions":{},
"externalDocs":{
"description":"MarkLogic documentation",
"url":"http://docs.marklogic.com/REST/management"
}
}