Jump to

• Request
• Response

Get Lifecycle Maintenance History

post

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

Gets the database maintenance history for update (patching) and upgrade operations.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• limit: number
  Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)

  Example: 10
• page: string
  Base 64 encoded page

  Example: b2Zmc2V0OjA
• sort: string
  Field along with an optional sort direction. The supported attributes of sorting are targetName, targetType, timeStarted, timeEnded, status, task.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.

  Example: targetName:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "sort":{
            "description":"Field along with an optional sort direction. The supported attributes of sorting are targetName, targetType, timeStarted, timeEnded, status, task.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.",
            "type":"string",
            "example":"targetName:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        }
    }
}

Match All

Show Source

• object allOf LcmHistoryDetails
  Request to retrieve LCM history data

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "sort":{
            "description":"Field along with an optional sort direction. The supported attributes of sorting are targetName, targetType, timeStarted, timeEnded, status, task.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.",
            "type":"string",
            "example":"targetName:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        }
    }
}

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

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 names and Task list Filter on Target Ids and Time range Filter on Task list and Submitted By Filter on Status

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. LCM History retrieved successfully.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object LcmHistoryCollection
  List of LCM history data

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

Nested Schema : LcmHistoryCollection

Type: object

List of LCM history data

Show Source

• count: integer
  Count of LCM history records in the current fetch
• currentPage: string
  Base 64 encoded current page

  Example: b2Zmc2V0OjA
• items(required): array items
  List of LCM history
• nextPage: string
  Base 64 encoded next page

  Example: b2Zmc2V0OjC
• previousPage: string
  Base 64 encoded previous page

  Example: b2Zmc2V0OjB
• timeStartedGreaterThanOrEqualTo: string
  Since the given time of start

  Example: 2022-08-13 04:36:54
• timeStartedLessThanOrEqualTo: string
  Until the given time of start

  Example: 2022-08-13 04:36:54
• total: integer
  Total count of LCM history records

{
    "type":"object",
    "description":"List of LCM history data",
    "required":[
        "items"
    ],
    "properties":{
        "total":{
            "description":"Total count of LCM history records",
            "type":"integer"
        },
        "count":{
            "description":"Count of LCM history records in the current fetch",
            "type":"integer"
        },
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjB"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjC"
        },
        "timeStartedGreaterThanOrEqualTo":{
            "description":"Since the given time of start",
            "type":"string",
            "example":"2022-08-13 04:36:54"
        },
        "timeStartedLessThanOrEqualTo":{
            "description":"Until the given time of start",
            "type":"string",
            "example":"2022-08-13 04:36:54"
        },
        "items":{
            "description":"List of LCM history",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LcmHistorySummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of LCM history

Show Source

• Array of: object LcmHistorySummary
  LCM history summary

{
    "description":"List of LCM history",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LcmHistorySummary"
    }
}

Nested Schema : LcmHistorySummary

Type: object

LCM history summary

Show Source

• additionalProperties: object additionalProperties
  Additional properties of this task
• 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
• targetDisplayName: string
  Target display name

  Example: Prod DB
• targetId: string
  Target Id

  Example: 39D9DA5C367AE68C9087A71B2C46FEAE
• targetName: string
  Target name

  Example: Prod DB
• targetType: string
  Target type

  Example: oracle_database
• task: string
  Allowed Values: [ "UPDATE", "UPGRADE" ]

  Database management task

  Example: UPDATE
• timeEnded: string (date-time)
  End time of the task
• timeStarted: string (date-time)
  Start time of the task

{
    "description":"LCM history summary",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Target name",
            "type":"string",
            "example":"Prod DB"
        },
        "targetDisplayName":{
            "description":"Target display name",
            "type":"string",
            "example":"Prod DB"
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        },
        "targetId":{
            "description":"Target Id",
            "type":"string",
            "example":"39D9DA5C367AE68C9087A71B2C46FEAE"
        },
        "task":{
            "description":"Database management task",
            "type":"string",
            "enum":[
                "UPDATE",
                "UPGRADE"
            ],
            "example":"UPDATE"
        },
        "status":{
            "description":"status of task",
            "type":"string",
            "enum":[
                "SCHEDULED",
                "RUNNING",
                "ACTION_REQUIRED",
                "PAUSED",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "SKIPPED",
                "SAVED",
                "COMPLETED_WITH_ERROR"
            ],
            "example":"COMPLETED"
        },
        "timeStarted":{
            "description":"Start time of the task",
            "type":"string",
            "format":"date-time"
        },
        "timeEnded":{
            "description":"End time of the task",
            "type":"string",
            "format":"date-time"
        },
        "submittedBy":{
            "description":"OEM user that submitted the operation",
            "type":"string",
            "example":"SYSMAN"
        },
        "additionalProperties":{
            "description":"Additional properties of this task",
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/AdditionalProperties"
            }
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional properties of this task

Show Source

• Array of: object AdditionalProperties
  Additional properties of task

{
    "description":"Additional properties of this task",
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/AdditionalProperties"
    }
}

Nested Schema : AdditionalProperties

Type: object

Additional properties of task

Show Source

• patchIds: array patchIds
  List of patch Ids

{
    "description":"Additional properties of task",
    "type":"object",
    "properties":{
        "patchIds":{
            "description":"List of patch Ids",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":"2951426, 2950410"
        }
    }
}

Nested Schema : patchIds

Type: array

List of patch Ids

Show Source

• Array of: string

{
    "description":"List of patch Ids",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":"2951426, 2950410"
}

Example:

2951426, 2950410

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

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top