Jump to

• Request
• Response
• Examples

Get APICS version information

get

/apiplatform/administration/v1/version

Returns version and build information.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Version information.

Body ()

Root Schema : VersionResponse

Type: object

Show Source

• branch(optional): string
  The branch.
• buildDate(optional): string
  The build date.
• cloudVersion(optional): string
  The cloud version.
• revision(optional): string
  The revision.
• version(optional): string
  The version.

{
    "type":"object",
    "properties":{
        "cloudVersion":{
            "type":"string",
            "description":"The cloud version."
        },
        "buildDate":{
            "type":"string",
            "description":"The build date."
        },
        "version":{
            "type":"string",
            "description":"The version."
        },
        "branch":{
            "type":"string",
            "description":"The branch."
        },
        "revision":{
            "type":"string",
            "description":"The revision."
        }
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve version information about your Oracle API Platform Cloud Service instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/administration/v1/roles/version

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Mon, 18 Dec 2017 07:24:25 GMT
Content-Length:  177
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00018fc1
X-oracle-dms-rid:  0
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following example shows the contents of the response body in JSON format.

{ 
"cloudVersion": "18.1.1",
"buildDate": "2017-11-08T11:48:37-0800",
"version": "2.0.0",
"branch": "apip_18.1.1",
"revision": "6b72b0ce747aa18b89067584912f3edfe182b69a"
}

Back to Top