Jump to

• Request
• Response

Export Lifecycle Maintenance History

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/lcmOperations/actions/exportLcmHistory

Exports the database maintenance history for update (patching) and upgrade operations in CSV format.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request to export LCM history data

Show Source

• csvFileLocation: string
  File location where the CSV to be exported

  Example: /scratch/lcmhistory
• csvFileName: string
  CSV file name

  Example: lcmHistory_04122024T10_10_10.csv
• destinationHostCredential: string
  Destination host target credential

  Example: HOST_CRED:ADMIN
• destinationHostName: string
  Destination host target name

  Example: myhost

{
    "description":"Request to export LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "destinationHostName":{
            "description":"Destination host target name",
            "type":"string",
            "example":"myhost"
        },
        "destinationHostCredential":{
            "description":"Destination host target credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "csvFileLocation":{
            "description":"File location where the CSV to be exported",
            "type":"string",
            "example":"/scratch/lcmhistory"
        },
        "csvFileName":{
            "description":"CSV file name",
            "type":"string",
            "example":"lcmHistory_04122024T10_10_10.csv"
        }
    }
}

Match All

Request to export LCM history data

Show Source

• object allOf LcmHistoryDetails
  Request to retrieve LCM history data

{
    "description":"Request to export LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "destinationHostName":{
            "description":"Destination host target name",
            "type":"string",
            "example":"myhost"
        },
        "destinationHostCredential":{
            "description":"Destination host target credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "csvFileLocation":{
            "description":"File location where the CSV to be exported",
            "type":"string",
            "example":"/scratch/lcmhistory"
        },
        "csvFileName":{
            "description":"CSV file name",
            "type":"string",
            "example":"lcmHistory_04122024T10_10_10.csv"
        }
    }
}

Nested Schema : LcmHistoryDetails

Type: object

Request to retrieve LCM history data

Show Source

• exclusions: array exclusions
  Exclude the given details in response

{
    "description":"Request to retrieve LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryFilter"
        }
    ],
    "properties":{
        "exclusions":{
            "description":"Exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

Match All

Request to retrieve LCM history data

Show Source

• object LcmHistoryFilter
  Filter for LCM history data

{
    "description":"Request to retrieve LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryFilter"
        }
    ],
    "properties":{
        "exclusions":{
            "description":"Exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

Nested Schema : LcmHistoryFilter

Type: object

Filter for LCM history data

Show Source

• status: string
  Allowed Values: [ "SCHEDULED", "RUNNING", "ACTION_REQUIRED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "SKIPPED", "SAVED", "COMPLETED_WITH_ERROR" ]

  status of task

  Example: COMPLETED
• submittedBy: string
  OEM user that submitted the operation

  Example: SYSMAN
• targetIds: array targetIds
  List of target IDs
• targetNames: array targetNames
  List of target names
• targetType: string
  Allowed Values: [ "oracle_database", "oracle_pdb", "cluster", "rac_database", "has" ]

  Target type
• tasks: string
  Allowed Values: [ "UPDATE", "UPGRADE" ]

  List of tasks
• timeStartedGreaterThanOrEqualTo: string
  Since the given time

  Example: 2023-01-30 10:00:00
• timeStartedLesserThanOrEqualTo: string
  Until the given time

  Example: 2023-01-30 10:00:11

{
    "description":"Filter for LCM history data",
    "type":"object",
    "properties":{
        "targetNames":{
            "description":"List of target names",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "Prod DB",
                "HR DB"
            ]
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "oracle_pdb",
                "cluster",
                "rac_database",
                "has"
            ]
        },
        "targetIds":{
            "description":"List of target IDs",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "E5B98897FE871AC1E05380FE4564F682",
                "ADB98897FE871AC1E05380FE4564F555"
            ]
        },
        "tasks":{
            "description":"List of tasks",
            "type":"string",
            "enum":[
                "UPDATE",
                "UPGRADE"
            ]
        },
        "timeStartedGreaterThanOrEqualTo":{
            "description":"Since the given time",
            "type":"string",
            "example":"2023-01-30 10:00:00"
        },
        "timeStartedLesserThanOrEqualTo":{
            "description":"Until the given time",
            "type":"string",
            "example":"2023-01-30 10:00:11"
        },
        "status":{
            "description":"status of task",
            "type":"string",
            "enum":[
                "SCHEDULED",
                "RUNNING",
                "ACTION_REQUIRED",
                "PAUSED",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "SKIPPED",
                "SAVED",
                "COMPLETED_WITH_ERROR"
            ],
            "example":"COMPLETED"
        },
        "submittedBy":{
            "description":"OEM user that submitted the operation",
            "type":"string",
            "example":"SYSMAN"
        }
    }
}

Nested Schema : targetIds

Type: array

List of target IDs

Show Source

• Array of: string

{
    "description":"List of target IDs",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "E5B98897FE871AC1E05380FE4564F682",
        "ADB98897FE871AC1E05380FE4564F555"
    ]
}

Example:

[
    "E5B98897FE871AC1E05380FE4564F682",
    "ADB98897FE871AC1E05380FE4564F555"
]

Nested Schema : targetNames

Type: array

List of target names

Show Source

• Array of: string

{
    "description":"List of target names",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "Prod DB",
        "HR DB"
    ]
}

Example:

[
    "Prod DB",
    "HR DB"
]

Examples

Select an example Filter on Target name and Task list Filter on Target Ids and Time range Filter on Status and Submitted By

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. LCM History exported successfully.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object ExportLcmHistoryReport
  Export LCM history response

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExportLcmHistoryReport"
        }
    ]
}

Nested Schema : ExportLcmHistoryReport

Type: object

Export LCM history response

Show Source

• message: string
  Success message

  Example: CSV file exported successfully to /scratch/lcmhistory/exportlcmhistory.csv
• nextPage: string
  Base 64 encoded next page

  Example: b2Zmc2V0OjC

{
    "description":"Export LCM history response",
    "type":"object",
    "properties":{
        "message":{
            "description":"Success message",
            "type":"string",
            "example":"CSV file exported successfully to /scratch/lcmhistory/exportlcmhistory.csv"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjC"
        }
    }
}

Examples

Select an example Payload

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top