Get details about a deployment procedure
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures/{deploymentProcedureId}
Get details about a deployment procedure. In emcli, it is equivalent to 'describe_procedure_input'
Request
Path Parameters
-
deploymentProcedureId(required): string
Id of a Procedure.
Query Parameters
-
include: string
if include=procedureInput or include=XmlFormat, information about procedure input/procedure xml is included in the response
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Deployment Procedure returned successfully
Root Schema : DeploymentProcedure
Type:
object
It represents a Procedure
Match All
Show Source
-
object
DeploymentProcedureDetails
This is the representation of a Procedure.
Nested Schema : DeploymentProcedureDetails
Type:
object
This is the representation of a Procedure.
Show Source
-
displayName: string
Display Name of a ProcedureExample:
Copy of TEST_DP
-
id: string
Unique identifier for a ProcedureExample:
B0FBBE587FD201E2E0537013790A7D53
-
links: object
links
Procedure related links
-
name: string
Name of a ProcedureExample:
DP_CC67765EF65F51A5E053E00F4B64D991
-
owner: string
Owner of a ProcedureExample:
SYSMAN
-
parentName: string
Parent procedure of a ProcedureExample:
TEST_DP
-
procedureInput: object
procedureInput
input which given during submit procedure
-
type: string
Type of a ProcedureExample:
UserDefined
-
version: string
Version Number of a ProcedureExample:
Succeeded
-
xmlFormat: string
returns DP xml which can be reused to register.
Nested Schema : links
Type:
object
Procedure related links
Show Source
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : procedureInput
Type:
object
input which given during submit procedure
Match All
Show Source
-
object
DescribeProcedureInput
This is the representation of an input given while submitting deployment procedure.
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Nested Schema : DescribeProcedureInput
Type:
object
This is the representation of an input given while submitting deployment procedure.
Show Source
-
links: object
links
Self link
-
schedule: object
Schedule
Schedule details
-
targets: array
DeploymentProcedureTargetList
Defining list of procedure targets
-
variables: object
DeploymentProcedureVariableCollection
Collections of Procedure Variable
Nested Schema : links
Type:
object
Self link
Show Source
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : Schedule
Type:
object
Schedule details
Show Source
-
isTargetZone: boolean
To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition
-
recurring: string
Frequency at which the operation must be executed repeatedlyExample:
frequency:weekly;days:2,
-
scheduleType: string
Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON.
-
startGracePeriodInMinutes: integer
Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.Example:
60
-
timeToEnd: string
(date-time)
End time
-
timeToStart: string
(date-time)
Start time
Nested Schema : DeploymentProcedureTargetList
Type:
array
Defining list of procedure targets
Show Source
Nested Schema : DeploymentProcedureVariableCollection
Type:
object
Collections of Procedure Variable
Show Source
-
items: array
items
The list of procedure variables
Nested Schema : items
Type:
Show Source
object
-
name: string
name of target typeExample:
host
-
targets: object
DeploymentProcedureTargetCollection
Collections of Procedure Target
Nested Schema : DeploymentProcedureTargetCollection
Type:
object
Collections of Procedure Target
Show Source
-
items: array
items
The list of targets
Nested Schema : items
Type:
array
The list of targets
Show Source
-
Array of:
object DeploymentProcedureTargetSummary
This is the representation of Procedure Target
Nested Schema : DeploymentProcedureTargetSummary
Type:
object
This is the representation of Procedure Target
Match All
Show Source
-
object
DeploymentProcedureTargetDetails
Defining Target for Deployment Procedure
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 NameExample:
host1.oracle.com
-
targetType: string
Target TypeExample:
host
Nested Schema : CredentialReference
Type:
array
This is the representation of credential references.
Show Source
Nested Schema : items
Type:
Show Source
object
-
credentialName: string
Represents credential nameExample:
EMGA
-
credentialType: string
Represents type of the credentialExample:
NAMED
-
owner: string
Represents owner of the credentialExample:
SYSMAN
-
usage: string
Represents credential usageExample:
defaultHostCred
Nested Schema : items
Type:
array
The list of procedure variables
Show Source
-
Array of:
object DeploymentProcedureVariableSummary
This is the representation of Procedure Variable
Nested Schema : DeploymentProcedureVariableSummary
Type:
object
This is the representation of Procedure Variable
Match All
Show Source
-
object
DeploymentProcedureVariableDetails
Defining Variable for Deployment Procedure
Nested Schema : DeploymentProcedureVariableDetails
Type:
object
Defining Variable for Deployment Procedure
Show Source
-
variableName: string
Displays Deployment Procedure varibale nameExample:
userId
-
variableValue: string
Displays Deployment Procedure varibale valueExample:
10001
400 Response
Bad Request. The payload is null or missing some parameters
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
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
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
403 Response
Forbidden. The user is forbidden to perform the requested operation
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
404 Response
Not Found. The requested REST API URL is not found.
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
500 Response
Internal Server Error. Exception in execution of REST API.
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
503 Response
Service Unavailable. The server is unable to process the request.
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