Jump to

• Request
• Response

Get deployment procedure execution

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedureInstances/{deploymentProcedureInstanceId}/executions/{executionId}

Get deployment procedure execution.

Request

Path Parameters

• deploymentProcedureInstanceId(required): string
  Id of an Instance.
• executionId(required): string
  Id of an Execution.

Query Parameters

• include: string
  if include=runtimeData, information about runtime data is included in the response

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Execution returned successfully

Body ()

Root Schema : Execution

Type: object

It represents an execution

Match All

It represents an execution

Show Source

• object ExecutionDetails
  It represents an execution.

{
    "description":"It represents an execution",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExecutionDetails"
        }
    ]
}

Nested Schema : ExecutionDetails

Type: object

It represents an execution.

Show Source

• id: string
  Unique identifier for an execution

  Example: CDAAE80FDD3D7987E053E00F4B64DEBB
• links: object links
  the Execution related links
• name: string
  Name of of an instance

  Example: hostcmd-executiontest
• runtimeData: object runtimeData
  Execution run time data
• status: string
  Represents status of an execution

  Example: COMPLETED

{
    "description":"It represents an execution.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for an execution",
            "example":"CDAAE80FDD3D7987E053E00F4B64DEBB"
        },
        "name":{
            "type":"string",
            "description":"Name of of an instance",
            "example":"hostcmd-executiontest"
        },
        "status":{
            "type":"string",
            "description":"Represents status of an execution",
            "example":"COMPLETED"
        },
        "runtimeData":{
            "type":"object",
            "description":"Execution run time data",
            "allOf":[
                {
                    "$ref":"#/components/schemas/InstanceData"
                }
            ]
        },
        "links":{
            "type":"object",
            "description":"the Execution related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : links

Type: object

the Execution related links

Show Source

• self: object Link
  A link

{
    "type":"object",
    "description":"the Execution related links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : runtimeData

Type: object

Execution run time data

Match All

Execution run time data

Show Source

• object allOf InstanceData
  This is the representation of instance submission data.

{
    "type":"object",
    "description":"Execution run time data",
    "allOf":[
        {
            "$ref":"#/components/schemas/InstanceData"
        }
    ]
}

Nested Schema : Link

Type: object

A link

Show Source

• href(required): string
  URL for link

{
    "description":"A link",
    "type":"object",
    "required":[
        "href"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for link"
        }
    }
}

Nested Schema : InstanceData

Type: object

This is the representation of instance submission data.

Match All

This is the representation of instance submission data.

This is the representation of instance submission data.

Show Source

• array DeploymentProcedureTargetList
  Defining list of procedure targets
• object DeploymentProcedureVariableCollection
  Collections of Procedure Variable

{
    "description":"This is the representation of instance submission data.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        }
    ]
}

Nested Schema : DeploymentProcedureTargetList

Type: array

Defining list of procedure targets

Show Source

• Array of: object items

{
    "description":"Defining list of procedure targets",
    "type":"array",
    "items":{
        "properties":{
            "name":{
                "type":"string",
                "description":"name of target type",
                "example":"host"
            },
            "targets":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
            }
        }
    }
}

Nested Schema : DeploymentProcedureVariableCollection

Type: object

Collections of Procedure Variable

Show Source

• items: array items
  The list of procedure variables

{
    "description":"Collections of Procedure Variable",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of procedure variables",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  name of target type

  Example: host
• targets: object DeploymentProcedureTargetCollection
  Collections of Procedure Target

{
    "properties":{
        "name":{
            "type":"string",
            "description":"name of target type",
            "example":"host"
        },
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
        }
    }
}

Nested Schema : DeploymentProcedureTargetCollection

Type: object

Collections of Procedure Target

Show Source

• items: array items
  The list of targets

{
    "description":"Collections of Procedure Target",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of targets",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

The list of targets

Show Source

• Array of: object DeploymentProcedureTargetSummary
  This is the representation of Procedure Target

{
    "type":"array",
    "description":"The list of targets",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
    }
}

Nested Schema : DeploymentProcedureTargetSummary

Type: object

This is the representation of Procedure Target

Match All

This is the representation of Procedure Target

Show Source

• object DeploymentProcedureTargetDetails
  Defining Target for Deployment Procedure

{
    "description":"This is the representation of Procedure Target",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureTargetDetails

Type: object

Defining Target for Deployment Procedure

Show Source

• credentialReferences: array CredentialReference
  This is the representation of credential references.
• targetName: string
  Target Name

  Example: host1.oracle.com
• targetType: string
  Target Type

  Example: host

{
    "description":"Defining Target for Deployment Procedure",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target Name",
            "example":"host1.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Target Type",
            "example":"host"
        },
        "credentialReferences":{
            "$ref":"#/components/schemas/CredentialReference"
        }
    }
}

Nested Schema : CredentialReference

Type: array

This is the representation of credential references.

Show Source

• Array of: object items

{
    "description":"This is the representation of credential references.",
    "type":"array",
    "items":{
        "properties":{
            "usage":{
                "type":"string",
                "description":"Represents credential usage",
                "example":"defaultHostCred"
            },
            "credentialType":{
                "type":"string",
                "description":"Represents type of the credential",
                "example":"NAMED"
            },
            "owner":{
                "type":"string",
                "description":"Represents owner of the credential",
                "example":"SYSMAN"
            },
            "credentialName":{
                "type":"string",
                "description":"Represents credential name",
                "example":"EMGA"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• credentialName: string
  Represents credential name

  Example: EMGA
• credentialType: string
  Represents type of the credential

  Example: NAMED
• owner: string
  Represents owner of the credential

  Example: SYSMAN
• usage: string
  Represents credential usage

  Example: defaultHostCred

{
    "properties":{
        "usage":{
            "type":"string",
            "description":"Represents credential usage",
            "example":"defaultHostCred"
        },
        "credentialType":{
            "type":"string",
            "description":"Represents type of the credential",
            "example":"NAMED"
        },
        "owner":{
            "type":"string",
            "description":"Represents owner of the credential",
            "example":"SYSMAN"
        },
        "credentialName":{
            "type":"string",
            "description":"Represents credential name",
            "example":"EMGA"
        }
    }
}

Nested Schema : items

Type: array

The list of procedure variables

Show Source

• Array of: object DeploymentProcedureVariableSummary
  This is the representation of Procedure Variable

{
    "type":"array",
    "description":"The list of procedure variables",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
    }
}

Nested Schema : DeploymentProcedureVariableSummary

Type: object

This is the representation of Procedure Variable

Match All

This is the representation of Procedure Variable

Show Source

• object DeploymentProcedureVariableDetails
  Defining Variable for Deployment Procedure

{
    "description":"This is the representation of Procedure Variable",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureVariableDetails

Type: object

Defining Variable for Deployment Procedure

Show Source

• variableName: string
  Displays Deployment Procedure varibale name

  Example: userId
• variableValue: string
  Displays Deployment Procedure varibale value

  Example: 10001

{
    "description":"Defining Variable for Deployment Procedure",
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale name",
            "example":"userId"
        },
        "variableValue":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale value",
            "example":10001
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

401 Response

Client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

404 Response

Resource not found or not authorized for access

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

503 Response

Indicates that a required service is not available

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

Back to Top