Loading TOC...

GET /manage/v2/databases/{id|name}/temporal/axes/{id|name}/properties

Summary

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

URL Parameters
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 user) is returned if the user does not exist.

Required Privileges

This operation requires the security and manage-admin roles.

Usage Notes

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

axis-id

The unique ID of the axis.

axis-name

The name of a temporal axis.

axis-start

Range index defining the axis start timestamp.

This is a complex structure with the following children:

cts:base-reference

axis-end

Range index defining the axis end timestamp.

This is a complex structure with the following children:

cts:base-reference

Example


http://localhost:8002/manage/v2/databases/Documents/temporal/axes/system/properties

==> Returns the properties of the axis, "system," from the Documents database.
    

Comments

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