Loading TOC...

GET /manage/v2/databases/{id|name}/temporal/collections/properties?collection={name}

Summary

This resource address returns the properties of the specified temporal collection.

URL Parameters
collection The name of the collection.
format The format of the returned data. Can be either 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 Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 (no such collection) is returned if the collection does not exist.

Required Privileges

This operation requires the temporal-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage-user

Usage Notes

The structure of the output returned from this REST API is as follows:

collection-id

The unique ID of the collection.

collection-name

The name of a temporal collection.

system-axis

System axis name for the temproal collection.

valid-axis

Valid axis name for the temporal collection.

options

Options for a temporal collection

This is a complex structure with the following children:

option

Option for temporal collection.

Example


http://localhost:8002/manage/v2/databases/Documents/temporal/collections/properties?collection=mycollection

==> Returns the properties of the collection, "mycollection," from the Documents database.
    

Comments

    Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy