REST API for Oracle SD-WAN Edge Release 9.1.1

Save datetime details

post

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/datetime_settings/dateTimeSettings

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the date and time details

Root Schema : schema

Type: object

Show Source

day: number

Example: 11
hour: number

Example: 2020
minute: number

Example: 29
month: string

Example: March
second: number

Example: 59
timestamp: string

Default Value:

Example: MXe8234hjDs23==
year: number

Example: 2020

{
    "type":"object",
    "example":{
        "month":"March",
        "day":"11",
        "year":"2020",
        "hour":"09",
        "minute":"29",
        "second":"23",
        "timestamp":"MXe8234hjDs23=="
    },
    "properties":{
        "month":{
            "type":"string",
            "example":"March"
        },
        "day":{
            "type":"number",
            "example":11
        },
        "year":{
            "type":"number",
            "example":2020
        },
        "hour":{
            "type":"number",
            "example":2020
        },
        "minute":{
            "type":"number",
            "example":29
        },
        "second":{
            "type":"number",
            "example":59
        },
        "timestamp":{
            "type":"string",
            "default":"",
            "example":"MXe8234hjDs23=="
        }
    }
}

Example:

{
    "month":"March",
    "day":"11",
    "year":"2020",
    "hour":"09",
    "minute":"29",
    "second":"23",
    "timestamp":"MXe8234hjDs23=="
}

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedPost

Type: object

Show Source

message: string

Example: Operation must use a POST
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a POST"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to save datetime details by submitting a POST request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X POST \
    -b cookies.txt \
    -d@request.json \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/datetime_settings/dateTimeSettings"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "month":"March",
  "day":"11",
  "year":"2020",
  "hour":"09",
  "minute":"29",
  "second":"23",
  "timestamp":<timestamp>
}

Example of the Response Body

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

{
  "data": "Sat Mar 14 09:29:23 SST 2020",
  "status": "success"
}