REST API for Oracle Commerce Cloud 21C

getExtensionServerLogs

get

/ccadminx/custom/v1/logs

Returns the logs from the extension server for the given logging level and date.

Request

Supported Media Types

application/json

Query Parameters

date(optional): string

The date of the log file to return. Will default to the current day if not supplied.
format(optional): string

supports only format=zip and the log files can be downloaded as a zip file.
loggingLevel: string

The level of the log file to return. must be one of the following; debug, info, warning, error.

Response

Supported Media Types

application/json
application/x-zip-compressed

200 Response

Following model is returned when operation succeeds.

Root Schema : getExtensionServerLogs_response

Type: object

Show Source

fileContents(optional): string

the contents level of the log file whose contents has been returned.
filename(optional): string

the filename of the log file whose contents has been returned.
format(optional): string

supports only format=zip and the log files can be downloaded as a zip file.
logDate(optional): string

the date of the log file whose contents has been returned.
loggingLevel(optional): string

the logging level of the log file whose contents has been returned.

{
    "properties":{
        "filename":{
            "description":"the filename of the log file whose contents has been returned.",
            "type":"string"
        },
        "logDate":{
            "description":"the date of the log file whose contents has been returned.",
            "type":"string"
        },
        "format":{
            "description":"supports only format=zip and the log files can be downloaded as a zip file.",
            "type":"string"
        },
        "fileContents":{
            "description":"the contents level of the log file whose contents has been returned.",
            "type":"string"
        },
        "loggingLevel":{
            "description":"the logging level of the log file whose contents has been returned.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "filename":"20161219.error.log",
    "logDate":"20161219",
    "fileContents":"2016-12-19T10:47:44.864Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T10:49:31.499Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:49:31.512Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:49:31.513Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:53:10.721Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:53:10.721Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:53:10.722Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:54:42.817Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:54:42.818Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:54:42.818Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T10:54:52.369Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\lint\\externalSippingCalculator'\r\n2016-12-19T10:54:52.369Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\lint\\externalSippingCalculator'\r\n2016-12-19T10:54:52.370Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\lint\\externalSippingCalculator'\r\n2016-12-19T10:55:31.296Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\lint\\externalSippingCalculator'\r\n2016-12-19T10:55:31.297Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\lint\\externalSippingCalculator'\r\n2016-12-19T10:55:31.298Z - error: Worker 1 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\lint\\externalSippingCalculator'\r\n2016-12-19T14:07:11.328Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:24:12.633Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:25:35.438Z - error: Worker 1 - ReferenceError: jobId is not defined\n    at isValidDate (C:\\work\\cloud\\occsapp\\lib\\routes\\ccadminx-routes.js:23:17)\n    at C:\\work\\cloud\\occsapp\\lib\\routes\\ccadminx-routes.js:40:8\n    at Layer.handle [as handle_request] (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\layer.js:82:5)\n    at next (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\route.js:110:13)\n    at Route.dispatch (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\route.js:91:3)\n    at Layer.handle [as handle_request] (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\layer.js:82:5)\n    at C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:267:22\n    at Function.proto.process_params (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:321:12)\n    at next (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:261:10)\n    at Function.proto.handle (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:166:3)\r\n2016-12-19T14:28:10.428Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:28:18.363Z - error: Worker 1 - ReferenceError: jobId is not defined\n    at isValidDate (C:\\work\\cloud\\occsapp\\lib\\routes\\ccadminx-routes.js:23:17)\n    at C:\\work\\cloud\\occsapp\\lib\\routes\\ccadminx-routes.js:40:8\n    at Layer.handle [as handle_request] (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\layer.js:82:5)\n    at next (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\route.js:110:13)\n    at Route.dispatch (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\route.js:91:3)\n    at Layer.handle [as handle_request] (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\layer.js:82:5)\n    at C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:267:22\n    at Function.proto.process_params (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:321:12)\n    at next (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:261:10)\n    at Function.proto.handle (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:166:3)\r\n2016-12-19T14:33:31.114Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:34:36.601Z - error: Worker 1 - ReferenceError: jobId is not defined\n    at isValidDate (C:\\work\\cloud\\occsapp\\lib\\routes\\ccadminx-routes.js:23:17)\n    at C:\\work\\cloud\\occsapp\\lib\\routes\\ccadminx-routes.js:40:8\n    at Layer.handle [as handle_request] (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\layer.js:82:5)\n    at next (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\route.js:110:13)\n    at Route.dispatch (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\route.js:91:3)\n    at Layer.handle [as handle_request] (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\layer.js:82:5)\n    at C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:267:22\n    at Function.proto.process_params (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:321:12)\n    at next (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:261:10)\n    at Function.proto.handle (C:\\work\\cloud\\occsapp\\node_modules\\express\\lib\\router\\index.js:166:3)\r\n2016-12-19T14:35:30.160Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:45:55.964Z - error: Worker 2 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:56:23.928Z - error: Worker 3 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T14:57:04.401Z - error: Worker 4 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T15:44:39.178Z - error: Worker 5 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T15:45:05.916Z - error: Worker 6 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T15:47:08.869Z - error: uncaughtException: ENOTEMPTY: directory not empty, rmdir 'C:\\work\\cloud\\occsapp\\extensions\\extracted\\httplib' date=Mon Dec 19 2016 15:47:08 GMT+0000 (GMT Standard Time), pid=13220, uid=null, gid=null, cwd=C:\\work\\cloud\\occsapp, execPath=C:\\Program Files\\nodejs\\node.exe, version=v4.4.5, argv=[C:\\Program Files\\nodejs\\node.exe, C:\\work\\cloud\\occsapp\\bin\\www_custom], rss=37040128, heapTotal=19785040, heapUsed=16039192, loadavg=[0, 0, 0], uptime=21946.7373404, trace=[column=null, file=null, function=Error, line=null, method=null, native=true, column=18, file=fs.js, function=Object.fs.rmdirSync, line=758, method=fs.rmdirSync, native=false, column=11, file=C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\node_modules\\rimraf\\rimraf.js, function=rmkidsSync, line=342, method=null, native=false, column=7, file=C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\node_modules\\rimraf\\rimraf.js, function=rmdirSync, line=332, method=null, native=false, column=9, file=C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\node_modules\\rimraf\\rimraf.js, function=Function.rimrafSync [as sync], line=303, method=rimrafSync [as sync], native=false, column=17, file=C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\lib\\remove\\index.js, function=Object.removeSync, line=4, method=removeSync, native=false, column=10, file=C:\\work\\cloud\\occsapp\\lib\\extension-loader.js, function=null, line=68, method=null, native=false, column=null, file=null, function=Array.forEach, line=null, method=forEach, native=true, column=49, file=C:\\work\\cloud\\occsapp\\lib\\extension-loader.js, function=Object.clean, line=66, method=clean, native=false, column=26, file=C:\\work\\cloud\\occsapp\\custom-server\\clean-extensions.js, function=module.exports.clean, line=6, method=exports.clean, native=false], stack=[Error: ENOTEMPTY: directory not empty, rmdir 'C:\\work\\cloud\\occsapp\\extensions\\extracted\\httplib',     at Error (native),     at Object.fs.rmdirSync (fs.js:758:18),     at rmkidsSync (C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\node_modules\\rimraf\\rimraf.js:342:11),     at rmdirSync (C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\node_modules\\rimraf\\rimraf.js:332:7),     at Function.rimrafSync [as sync] (C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\node_modules\\rimraf\\rimraf.js:303:9),     at Object.removeSync (C:\\work\\cloud\\occsapp\\node_modules\\fs-extra\\lib\\remove\\index.js:4:17),     at C:\\work\\cloud\\occsapp\\lib\\extension-loader.js:68:10,     at Array.forEach (native),     at Object.clean (C:\\work\\cloud\\occsapp\\lib\\extension-loader.js:66:49),     at module.exports.clean (C:\\work\\cloud\\occsapp\\custom-server\\clean-extensions.js:6:26)]\r\n2016-12-19T16:05:47.436Z - error: Worker 1 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T16:12:18.144Z - error: Worker 2 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r\n2016-12-19T16:17:26.544Z - error: Worker 2 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T16:17:26.545Z - error: Worker 2 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T16:17:26.545Z - error: Worker 2 - Error: ENOENT: no such file or directory, access 'C:\\work\\cloud\\occsapp\\jobs\\results\\test\\externalSippingCalculator'\r\n2016-12-19T16:54:49.957Z - error: Worker 3 - ENOENT: no such file or directory, scandir 'C:\\etc\\ssl\\certs'\r",
    "loggingLevel":"error"
}

Example Response (application/x-zip-compressed)

{
    "description":"logs.zip can be downloaded with format=zip parameter."
}

Default Response

The error response

Root Schema : errorModel

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
errors(optional): array errors

An optional list of errors if multiple errors were encountered
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code
type(optional): string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}