Jump to

• Request
• Response

Update deployment procedure input

put

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures

Used to update inputs of configuration deployment proedure.It is equivalent to update_procedure_input in emcli.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

This is the representation of input of a deployment procedure.

Match All

This is the representation of input of a deployment procedure.

Show Source

• object DeploymentProcedureSaveInputDetails
  This is the representation of an input given while submitting deployment procedure.

{
    "description":"This is the representation of input of a deployment procedure.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureSaveInputDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureSaveInputDetails

Type: object

This is the representation of an input given while submitting deployment procedure.

Show Source

• configurationName: string
  Represents deployment procedure configuration name

  Example: CONFIGDP
• notification: object Notification
  Status of the deployment procedure instance for which the end-users can choose to be notified.
• schedule: object Schedule
  Schedule details
• targetList: array DeploymentProcedureTargetList
  Defining list of procedure targets
• variables: object DeploymentProcedureVariableCollection
  Collections of Procedure Variable

{
    "description":"This is the representation of an input given while submitting deployment procedure.",
    "type":"object",
    "properties":{
        "configurationName":{
            "type":"string",
            "description":"Represents deployment procedure configuration name",
            "example":"CONFIGDP"
        },
        "targetList":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        "variables":{
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "notification":{
            "$ref":"#/components/schemas/Notification"
        }
    }
}

Nested Schema : Notification

Type: object

Status of the deployment procedure instance for which the end-users can choose to be notified.

Show Source

• value: string
  The status of the procedure.All available status are scheduled, running, action required, succeeded, problems, suspended

{
    "description":"Status of the deployment procedure instance for which the end-users can choose to be notified.",
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"The status of the procedure.All available status are scheduled, running, action required, succeeded, problems, suspended",
            "items":{
                "enum":[
                    "scheduled",
                    "running",
                    "action required",
                    "succeeded",
                    "problems",
                    "suspended"
                ]
            }
        }
    }
}

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 repeatedly

  Example: 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

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"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"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"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
        }
    }
}

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

Back to Top

Response

200 Response

Deployment Procedure input details updated successfully.

Headers

• Location:

400 Response

Bad Request.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

401 Response

Unauthorized.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

403 Response

Forbidden.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

404 Response

Not Found.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

500 Response

Internal Server Error.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

503 Response

Service Unavailable

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

Back to Top