REST API for Content Capture

System and API Information

get

/capture/api/v1.1/systemInfo

This is a simple operation that will return Capture system and API information.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

General Content Capture System and REST API information.

Root Schema : System Information

Type: object

Title: System Information

This object defines basic Capture system information, such as version and build date.

Show Source

apiVersion(optional): string

The particular version of the REST API. It will resemble something like: v1, v1.1, v1.1.1, etc. depending on the actual version. However, it will always begin with v.
buildRevision(optional): string

The build version of the REST API.
buildTimestamp(optional): string(date-time)

The date/time of the REST API build in ISO-8601 Instant format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'), governed by RFC 3339.
name(optional): string

Name of the Content Capture REST API.

{
    "type":"object",
    "title":"System Information",
    "description":"<p>This object defines basic Capture system information, such as version and build date.</p>\n",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>Name of the Content Capture REST API.</p>\n"
        },
        "apiVersion":{
            "type":"string",
            "description":"<p>The particular version of the REST API. It will resemble something like: <i>v1</i>, <i>v1.1</i>, <i>v1.1.1</i>, etc.\ndepending on the actual version. However, it will always begin with <i>v</i>.</p>\n"
        },
        "buildTimestamp":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date/time of the REST API build in ISO-8601 Instant format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>),\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        },
        "buildRevision":{
            "type":"string",
            "description":"<p>The build version of the REST API.</p>\n"
        }
    }
}

500 Response

Internal Server Error

The server encountered an unexpected condition that prevented it from fulfilling the request. The response will be an Error Detail object.

Examples

Example:

The following example shows how to return Capture system and API information.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/capture/api/v1/systemInfo'

This gets the Content Capture system information.

Response Body

{
   "name": "Content Capture REST API",
   "apiVersion": "v1",
   "buildTimestamp": "2021/08/27T11:08:18.245Z",
   "buildRevision": "capture.master.2591.dc8b52245"
 }