Jump to

• Request
• Response

Get details about a deployment procedure instance

get

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

Get deployment procedure instance details. We can obatain 'get_instance_data' and 'get_instance_status' using above api.

Request

Path Parameters

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

Query Parameters

• exclude: string
  if exclude=executionId or owner, information about executionId or owner is excluded from the response
• include: string
  If include=total information about total number of returned records will be included in the response

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Instance returned successfully

Body ()

Root Schema : DeploymentProcedureInstance

Type: object

It represents a Procedure Instance

Match All

Show Source

• object DeploymentProcedureInstanceDetails
  This is the representation of an Instance.

{
    "description":"It represents a Procedure Instance",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureInstanceDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureInstanceDetails

Type: object

This is the representation of an Instance.

Show Source

• executionId: string
  Execution Id of an Instance

  Example: CC67DA5B8AD02268E053E00F4B64265F
• id: string
  Unique identifier for an Instance

  Example: B0FBBE587FD201E2E0537013790A7D03
• instanceData: object instanceData
  Data which used while submitting deployment procedure
• links: object links
  Instance related links
• name: string
  Name of an Instance

  Example: HOST_COMMAND
• owner: string
  Owner of an Instance

  Example: SYSMAN
• procedureType: string
  Type of a Procedure

  Example: UserDefined
• status: string
  Status of an Instance

  Example: Succeeded
• statusDetails: object statusDetails
  status details of a deployment procedure instance

{
    "description":"This is the representation of an Instance.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for an Instance",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "name":{
            "type":"string",
            "description":"Name of an Instance",
            "example":"HOST_COMMAND"
        },
        "procedureType":{
            "type":"string",
            "description":"Type of a Procedure",
            "example":"UserDefined"
        },
        "executionId":{
            "type":"string",
            "description":"Execution Id of an Instance",
            "example":"CC67DA5B8AD02268E053E00F4B64265F"
        },
        "status":{
            "type":"string",
            "description":"Status of an Instance",
            "example":"Succeeded"
        },
        "owner":{
            "type":"string",
            "description":"Owner of an Instance",
            "example":"SYSMAN"
        },
        "instanceData":{
            "type":"object",
            "description":"Data which used while submitting deployment procedure",
            "allOf":[
                {
                    "$ref":"#/components/schemas/InstanceData"
                }
            ]
        },
        "statusDetails":{
            "type":"object",
            "description":"status details of a deployment procedure instance",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeploymentProcedureInstanceStatusDetails"
                }
            ]
        },
        "links":{
            "type":"object",
            "description":"Instance related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : instanceData

Type: object

Data which used while submitting deployment procedure

Match All

Show Source

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

{
    "type":"object",
    "description":"Data which used while submitting deployment procedure",
    "allOf":[
        {
            "$ref":"#/components/schemas/InstanceData"
        }
    ]
}

Nested Schema : links

Type: object

Instance related links

Show Source

• self: object Link
  Represents a link(could be self, previous or next)

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

Nested Schema : statusDetails

Type: object

status details of a deployment procedure instance

Match All

Show Source

• object DeploymentProcedureInstanceStatusDetails
  This is the representation of procedure instance status in details.

{
    "type":"object",
    "description":"status details of a deployment procedure instance",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureInstanceStatusDetails"
        }
    ]
}

Nested Schema : InstanceData

Type: object

This is the representation of instance submission data.

Match All

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

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

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
        }
    }
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : DeploymentProcedureInstanceStatusDetails

Type: object

This is the representation of procedure instance status in details.

Show Source

• createdBy: string
  Owner of an Instance

  Example: SYSMAN
• dataId: string
  Represents data guid

  Example: CC186E3706C349BBE053E00F4B64AB8F
• elapsedTime: string
  elapsed time of an instance

  Example: 8 seconds
• errorHandling: string
  Represents error handling
• procedureId: string
  Unique identifier for a procedure

  Example: CC01BDC5DA734370E053E00F4B64B23D
• status: string
  Status of an Instance

  Example: FAILED
• stepDetails: array stepDetails
  Represtents step details

{
    "description":"This is the representation of procedure instance status in details.",
    "type":"object",
    "properties":{
        "procedureId":{
            "type":"string",
            "description":"Unique identifier for a procedure",
            "example":"CC01BDC5DA734370E053E00F4B64B23D"
        },
        "createdBy":{
            "type":"string",
            "description":"Owner of an Instance",
            "example":"SYSMAN"
        },
        "status":{
            "type":"string",
            "description":"Status of an Instance",
            "example":"FAILED"
        },
        "elapsedTime":{
            "type":"string",
            "description":"elapsed time of an instance",
            "example":"8 seconds"
        },
        "errorHandling":{
            "type":"string",
            "description":"Represents error handling"
        },
        "dataId":{
            "type":"string",
            "description":"Represents data guid",
            "example":"CC186E3706C349BBE053E00F4B64AB8F"
        },
        "stepDetails":{
            "type":"array",
            "description":"Represtents step details",
            "items":{
                "$ref":"#/components/schemas/Phase"
            }
        }
    }
}

Nested Schema : stepDetails

Type: array

Represtents step details

Show Source

• Array of: object Phase
  Represents information of a phase and its steps

{
    "type":"array",
    "description":"Represtents step details",
    "items":{
        "$ref":"#/components/schemas/Phase"
    }
}

Nested Schema : Phase

Type: object

Represents information of a phase and its steps

Show Source

• steps: array steps
  Represents step

{
    "description":"Represents information of a phase and its steps",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhaseStepDetails"
        }
    ],
    "properties":{
        "steps":{
            "type":"array",
            "description":"Represents step",
            "items":{
                "$ref":"#/components/schemas/StepDetails"
            }
        }
    }
}

Match All

Show Source

• object PhaseStepDetails
  This is the representation of Phase Step.

{
    "description":"Represents information of a phase and its steps",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhaseStepDetails"
        }
    ],
    "properties":{
        "steps":{
            "type":"array",
            "description":"Represents step",
            "items":{
                "$ref":"#/components/schemas/StepDetails"
            }
        }
    }
}

Nested Schema : steps

Type: array

Represents step

Show Source

• Array of: object StepDetails
  This is the representation of Step.

{
    "type":"array",
    "description":"Represents step",
    "items":{
        "$ref":"#/components/schemas/StepDetails"
    }
}

Nested Schema : PhaseStepDetails

Type: object

This is the representation of Phase Step.

Show Source

• stepDetails: array stepDetails
  Represents step details
• steps: object StepDetails
  This is the representation of Step.

{
    "description":"This is the representation of Phase Step.",
    "type":"object",
    "properties":{
        "steps":{
            "$ref":"#/components/schemas/StepDetails"
        },
        "stepDetails":{
            "type":"array",
            "description":"Represents step details",
            "items":{
                "$ref":"#/components/schemas/StepDetails"
            }
        }
    }
}

Nested Schema : StepDetails

Type: object

This is the representation of Step.

Show Source

• errorMode: string
  Represents mode of error

  Example: stop
• id: string
  Represents step id

  Example: s1
• isEnabled: boolean
  Represents step whether it is enabled or not

  Example: true
• parentId: string
  Represents parent guid.

  Example: default_phase
• stateDetails: object StateDetails
  This is the representation of State.
• stepType: string
  Represents type of the step

  Example: Host Command Step
• timeCompleted: string
  Represents completion time of the step

  Example: 2021-09-16 07:05:48.0
• timeStarted: string
  Represents start time of the strp

  Example: 2021-09-16 07:05:44.0
• timeUpdated: string
  Represents last updated time of the step

  Example: 2021-09-16 07:05:48.0
• typeStep: string
  Represents step type

  Example: Step

{
    "description":"This is the representation of Step.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Represents step id",
            "example":"s1"
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Represents step whether it is enabled or not",
            "example":true
        },
        "stepType":{
            "type":"string",
            "description":"Represents type of the step",
            "example":"Host Command Step"
        },
        "errorMode":{
            "type":"string",
            "description":"Represents mode of error",
            "example":"stop"
        },
        "parentId":{
            "type":"string",
            "description":"Represents parent guid.",
            "example":"default_phase"
        },
        "typeStep":{
            "type":"string",
            "description":"Represents step type",
            "example":"Step"
        },
        "timeStarted":{
            "type":"string",
            "description":"Represents start time of the strp",
            "example":"2021-09-16 07:05:44.0"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Represents last updated time of the step",
            "example":"2021-09-16 07:05:48.0"
        },
        "timeCompleted":{
            "type":"string",
            "description":"Represents completion time of the step",
            "example":"2021-09-16 07:05:48.0"
        },
        "stateDetails":{
            "$ref":"#/components/schemas/StateDetails"
        }
    }
}

Nested Schema : StateDetails

Type: object

This is the representation of State.

Show Source

• id: string
  Represents state id

  Example: CC1871802C4343A3E053E00F4B640973
• jobDetails: object JobDetails
  This is the representation of Job
• parentId: string
  Represents parent guid

  Example: CC1871802C4243A3E053E00F4B640973
• phaseDetails: object PhaseDetails
  This is the representation of phase
• status: string
  Represents state status

  Example: FAILED
• timeCompleted: string
  Represents completion time of the state

  Example: 2021-09-16 07:05:48.0
• timeStarted: string
  Represents start time of the state

  Example: 2021-09-16 07:05:44.0
• timeUpdated: string
  Represents last updated time of the state

  Example: 2021-09-16 07:05:48.0

{
    "description":"This is the representation of State.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Represents state id",
            "example":"CC1871802C4343A3E053E00F4B640973"
        },
        "status":{
            "type":"string",
            "description":"Represents state status",
            "example":"FAILED"
        },
        "parentId":{
            "type":"string",
            "description":"Represents parent guid",
            "example":"CC1871802C4243A3E053E00F4B640973"
        },
        "timeStarted":{
            "type":"string",
            "description":"Represents start time of the state",
            "example":"2021-09-16 07:05:44.0"
        },
        "timeUpdated":{
            "type":"string",
            "description":"Represents last updated time of the state",
            "example":"2021-09-16 07:05:48.0"
        },
        "timeCompleted":{
            "type":"string",
            "description":"Represents completion time of the state",
            "example":"2021-09-16 07:05:48.0"
        },
        "jobDetails":{
            "$ref":"#/components/schemas/JobDetails"
        },
        "phaseDetails":{
            "$ref":"#/components/schemas/PhaseDetails"
        }
    }
}

Nested Schema : JobDetails

Type: object

This is the representation of Job

Show Source

• jobDetails: object JobStep
  This is the representation of job step
• jobExecutionId: string
  Represents job execution id

  Example: CC1871802C4643A3E053E00F4B640973
• jobId: string
  Represents job id

  Example: CC1871802C4443A3E053E00F4B640973
• jobName: string
  Represents job name

  Example: S1_CC1871802C4343A3E053E00F4B640973
• jobStatus: string
  Represents job status

  Example: Aborted
• jobType: string
  Represents job type

  Example: HostCommand
• timeStarted: string
  Represents job start time

  Example: 2021-09-16 07:05:46 GMT

{
    "description":"This is the representation of Job",
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Represents job id",
            "example":"CC1871802C4443A3E053E00F4B640973"
        },
        "jobExecutionId":{
            "type":"string",
            "description":"Represents job execution id",
            "example":"CC1871802C4643A3E053E00F4B640973"
        },
        "jobName":{
            "type":"string",
            "description":"Represents job name",
            "example":"S1_CC1871802C4343A3E053E00F4B640973"
        },
        "jobType":{
            "type":"string",
            "description":"Represents job type",
            "example":"HostCommand"
        },
        "jobStatus":{
            "type":"string",
            "description":"Represents job status",
            "example":"Aborted"
        },
        "timeStarted":{
            "type":"string",
            "description":"Represents job start time",
            "example":"2021-09-16 07:05:46 GMT"
        },
        "jobDetails":{
            "$ref":"#/components/schemas/JobStep"
        }
    }
}

Nested Schema : PhaseDetails

Type: object

This is the representation of phase

Show Source

• targetName: string
  Represents target name

  Example: host1.us.oracle.com
• targetType: string
  Represents target type

  Example: host

{
    "description":"This is the representation of phase",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Represents target name",
            "example":"host1.us.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Represents target type",
            "example":"host"
        }
    }
}

Nested Schema : JobStep

Type: object

This is the representation of job step

Show Source

• command: string
  Represents job command

  Example: remoteOp
• name: string
  Represents job name

  Example: SS_RemoteOp
• output: string
  Represents job output
• status: string
  Represent job status

  Example: Aborted

{
    "description":"This is the representation of job step",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Represents job name",
            "example":"SS_RemoteOp"
        },
        "command":{
            "type":"string",
            "description":"Represents job command",
            "example":"remoteOp"
        },
        "status":{
            "type":"string",
            "description":"Represent job status",
            "example":"Aborted"
        },
        "output":{
            "type":"string",
            "description":"Represents job output"
        }
    }
}

Nested Schema : stepDetails

Type: array

Represents step details

Show Source

• Array of: object StepDetails
  This is the representation of Step.

{
    "type":"array",
    "description":"Represents step details",
    "items":{
        "$ref":"#/components/schemas/StepDetails"
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

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"
        }
    }
}

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"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

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