Jump to

• Request
• Response

Submit deployment procedure

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures/{deploymentProcedureId}/actions/submit

Submit Deployment Procedures provided in request body. In emcli, it is equivalent to 'submit_procedure'

Request

Path Parameters

• deploymentProcedureId(required): string
  Id of a Procedure.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Inputs for Deployment Procedure submission

Show Source

• automaticRerunDelayInMinutes: number
  Positive values set the delay between automatic rerun attempts,of the DP steps, the units of such delay are minutes.

  Example: 10
• instanceName: string
  Deployment Procedure Instance Name

  Example: hostcommand-testsubmit
• maxAutomaticRerunsCount: number
  It determine the automatic rerun behaviour of the DP steps. Only failed or aborted DP steps are resubmitted or retried; successful DP steps are never rerun, regardless of these options' values

  Example: 5
• notification: object Notification
  Status of the deployment procedure instance for which the end-users can choose to be notified.
• schedule: object Schedule
  This represents a schedule object to schedule blackouts.
• targetLists: array DeploymentProcedureTargetList
  Defining list of procedure targets
• variables: object DeploymentProcedureVariableCollection
  Collections of Procedure Variable

{
    "description":"Inputs for Deployment Procedure submission",
    "type":"object",
    "properties":{
        "instanceName":{
            "type":"string",
            "description":"Deployment Procedure Instance Name",
            "example":"hostcommand-testsubmit"
        },
        "maxAutomaticRerunsCount":{
            "type":"number",
            "description":"It determine the automatic rerun behaviour of the DP steps. Only failed or aborted DP steps are resubmitted or retried; successful DP steps are never rerun, regardless of these options' values",
            "example":"5"
        },
        "automaticRerunDelayInMinutes":{
            "type":"number",
            "description":"Positive values set the delay between automatic rerun attempts,of the DP steps, the units of such delay are minutes.",
            "example":"10"
        },
        "targetLists":{
            "$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

This represents a schedule object to schedule blackouts.

Show Source

• repeat: object Repeat
  Describes repetition of a blackout.
• timeToStart: string
  Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).

  Example: 2023-08-24T14:54-02:00

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Match One Schema

Show Source

• object TimeToEnd
  An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).
• object Duration
  A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

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

Type: object

Describes repetition of a blackout.

Show Source

• timeToEndRepeat: string
  End time of the repetition with timezone. Timestamps are with minute accuracy.

  Example: 2023-08-24T14:54-02:00

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Match One Schema

Show Source

• object DaysOfYear
  List of days of year.
• object DaysOfMonth
  List of days of month in range 1-31 or -1 for last day of the month.
• object DaysOfWeek
  List of days of week.
• object EveryNWeeks
  Repeat every n weeks.
• object EveryNDays
  Repeat every n days.
• object EveryNHours
  Repeat every n hours.
• object EveryNMinutes
  Repeat every n minutes, minimal value is 2.

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Nested Schema : TimeToEnd

Type: object

An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).

Show Source

• timeToEnd(required): string
  An end time

  Example: 2023-08-23T14:54+01:00

{
    "type":"object",
    "required":[
        "timeToEnd"
    ],
    "description":"An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
    "properties":{
        "timeToEnd":{
            "type":"string",
            "description":"An end time",
            "example":"2023-08-23T14:54+01:00"
        }
    }
}

Nested Schema : Duration

Type: object

A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

Show Source

• durationHours: integer
  Duration of the blackout in hours.

  Example: 2
• durationMinutes: integer
  Duration of the blackout in minutes.

  Example: 25

{
    "type":"object",
    "description":"A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.",
    "properties":{
        "durationMinutes":{
            "type":"integer",
            "description":"Duration of the blackout in minutes.",
            "example":"25"
        },
        "durationHours":{
            "type":"integer",
            "description":"Duration of the blackout in hours.",
            "example":"2"
        }
    }
}

Nested Schema : DaysOfYear

Type: object

List of days of year.

Show Source

• daysOfYear: array daysOfYear
  List of days of the year.

{
    "type":"object",
    "description":"List of days of year.",
    "properties":{
        "daysOfYear":{
            "type":"array",
            "description":"List of days of the year.",
            "items":{
                "type":"object",
                "properties":{
                    "month":{
                        "type":"integer",
                        "description":"Month in range of 1-12."
                    },
                    "day":{
                        "type":"integer",
                        "description":"Day in range 1-31 or -1 for last day of the month."
                    }
                }
            }
        }
    }
}

Nested Schema : DaysOfMonth

Type: object

List of days of month in range 1-31 or -1 for last day of the month.

Show Source

• daysOfMonth: array daysOfMonth
  List of days of the month (1 based).

{
    "type":"object",
    "description":"List of days of month in range 1-31 or -1 for last day of the month.",
    "properties":{
        "daysOfMonth":{
            "type":"array",
            "description":"List of days of the month (1 based).",
            "items":{
                "type":"integer"
            },
            "example":[
                "1",
                "15"
            ]
        }
    }
}

Nested Schema : DaysOfWeek

Type: object

List of days of week.

Show Source

• daysOfWeek: array daysOfWeek
  List of days of week (localized short names).

{
    "type":"object",
    "description":"List of days of week.",
    "properties":{
        "daysOfWeek":{
            "type":"array",
            "description":"List of days of week (localized short names).",
            "items":{
                "type":"string",
                "enum":[
                    "MO",
                    "TU",
                    "WE",
                    "TH",
                    "FR",
                    "SA",
                    "SU"
                ]
            },
            "example":[
                "MO",
                "TH"
            ]
        }
    }
}

Nested Schema : EveryNWeeks

Type: object

Repeat every n weeks.

Show Source

• everyNWeeks: integer
  Repeat interval in weeks.

  Example: 2

{
    "type":"object",
    "description":"Repeat every n weeks.",
    "properties":{
        "everyNWeeks":{
            "type":"integer",
            "description":"Repeat interval in weeks.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNDays

Type: object

Repeat every n days.

Show Source

• everyNDays: integer
  Repeat interval in days, minimal value is 1.

  Example: 5

{
    "type":"object",
    "description":"Repeat every n days.",
    "properties":{
        "everyNDays":{
            "type":"integer",
            "description":"Repeat interval in days, minimal value is 1.",
            "example":"5"
        }
    }
}

Nested Schema : EveryNHours

Type: object

Repeat every n hours.

Show Source

• everyNHours: integer
  Repeat interval in hours.

  Example: 2

{
    "type":"object",
    "description":"Repeat every n hours.",
    "properties":{
        "everyNHours":{
            "type":"integer",
            "description":"Repeat interval in hours.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNMinutes

Type: object

Repeat every n minutes, minimal value is 2.

Show Source

• everyNMinutes: integer
  Repeat interval in minutes.

  Example: 45

{
    "type":"object",
    "description":"Repeat every n minutes, minimal value is 2.",
    "properties":{
        "everyNMinutes":{
            "type":"integer",
            "description":"Repeat interval in minutes.",
            "example":"45"
        }
    }
}

Nested Schema : daysOfYear

Type: array

List of days of the year.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"List of days of the year.",
    "items":{
        "type":"object",
        "properties":{
            "month":{
                "type":"integer",
                "description":"Month in range of 1-12."
            },
            "day":{
                "type":"integer",
                "description":"Day in range 1-31 or -1 for last day of the month."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• day: integer
  Day in range 1-31 or -1 for last day of the month.
• month: integer
  Month in range of 1-12.

{
    "type":"object",
    "properties":{
        "month":{
            "type":"integer",
            "description":"Month in range of 1-12."
        },
        "day":{
            "type":"integer",
            "description":"Day in range 1-31 or -1 for last day of the month."
        }
    }
}

Nested Schema : daysOfMonth

Type: array

List of days of the month (1 based).

Show Source

• Array of: integer

{
    "type":"array",
    "description":"List of days of the month (1 based).",
    "items":{
        "type":"integer"
    },
    "example":[
        "1",
        "15"
    ]
}

Example:

[
    "1",
    "15"
]

Nested Schema : daysOfWeek

Type: array

List of days of week (localized short names).

Show Source

• Array of: string
  Allowed Values: [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ]

{
    "type":"array",
    "description":"List of days of week (localized short names).",
    "items":{
        "type":"string",
        "enum":[
            "MO",
            "TU",
            "WE",
            "TH",
            "FR",
            "SA",
            "SU"
        ]
    },
    "example":[
        "MO",
        "TH"
    ]
}

Example:

[
    "MO",
    "TH"
]

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

Supported Media Types

• application/json

202 Response

A request to submit the deployment procedure was accepted

Headers

• Location:
  URL to get the status of submit Procedure action.

Body ()

Root Schema : schema

Type: object

Show Source

• code: string
  code

  Example: 202
• message: string
  Rest Api message for submit procedure.

  Example: A request to submit the deployment procedure was accepted

{
    "type":"object",
    "properties":{
        "code":{
            "description":"code",
            "type":"string",
            "example":"202"
        },
        "message":{
            "description":"Rest Api message for submit procedure.",
            "type":"string",
            "example":"A request to submit the deployment procedure was accepted"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top