Jump to

• Request
• Response

Retry deployment procedure instance

post

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

Retry failed latest execution if execution Id is not specified and if execution id is specified, then particular execution id will be retried. Retry failed instance or failed step or Execution.It is equivalent to retry_instance in emcli.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Includes state id and execution id.

Show Source

• executionId: string
  Represents executionId of a deployment procedure instance.

  Example: CC1871802C4343A3E053E00F4B640972
• stateId: string
  single or multiple values seperated by comma.

  Example: CC1871802C4343A3E053E00F4B640973,CC1871802C4343A3E053E00F4B640988

{
    "description":"Includes state id and execution id.",
    "type":"object",
    "properties":{
        "executionId":{
            "type":"string",
            "description":"Represents executionId of a deployment procedure instance.",
            "example":"CC1871802C4343A3E053E00F4B640972"
        },
        "stateId":{
            "type":"string",
            "description":"single or multiple values seperated by comma.",
            "example":"CC1871802C4343A3E053E00F4B640973,CC1871802C4343A3E053E00F4B640988"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

A request to retry the deployment procedure execution was accepted.

Headers

• Location:
  URL to get the status of retry execution action .

Body ()

Root Schema : schema

Type: object

Show Source

• code: string
  code

  Example: 202
• message: string
  Rest Api message for retry instance.

  Example: A request to retry the deployment procedure execution was accepted

{
    "type":"object",
    "properties":{
        "code":{
            "description":"code",
            "type":"string",
            "example":"202"
        },
        "message":{
            "description":"Rest Api message for retry instance.",
            "type":"string",
            "example":"A request to retry the deployment procedure execution 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