Jump to

• Request
• Response

Get failed steps arguments in order to retry

post

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

Get retry arguments of the failed DP steps by using instanceId of the latest deployment procedure execution if execution id is not specified or if execution id is specified, then retry arguments of passed execution id are displayed.

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 stateId and executionId

Show Source

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

  Example: CC1871802C4343A3E053E00F4B640972
• stateId: string
  State Id of the step.

  Example: CC1871802C4343A3E053E00F4B640973

{
    "description":"Includes stateId and executionId",
    "type":"object",
    "properties":{
        "stateId":{
            "type":"string",
            "description":"State Id of the step.",
            "example":"CC1871802C4343A3E053E00F4B640973"
        },
        "executionId":{
            "type":"string",
            "description":"Represents executionId of a deployment procedure instance.",
            "example":"CC1871802C4343A3E053E00F4B640972"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retry arguments of the failed step returned successfully.

Body ()

Root Schema : DeploymentProcedureInstanceGetRetryArguments

Type: array

Represents retry arguments of failed steps found in DP.

Show Source

• Array of: object items

{
    "description":"Represents retry arguments of failed steps found in DP.",
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"string",
                "description":"Unique identifier for a state",
                "example":"CDAAE80FDD3D7987E053E00F4B64DEBB"
            },
            "status":{
                "type":"string",
                "description":"Status of the step",
                "example":"Failed"
            },
            "target":{
                "type":"string",
                "description":"Name of the target",
                "example":"ABC.us.oracle.com"
            },
            "lastUpdated":{
                "type":"string",
                "description":"last updated time"
            },
            "retryArguments":{
                "type":"string",
                "description":"arguments which needs to be retried",
                "example":"command:q;timeoutForExec:0"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id: string
  Unique identifier for a state

  Example: CDAAE80FDD3D7987E053E00F4B64DEBB
• lastUpdated: string
  last updated time
• retryArguments: string
  arguments which needs to be retried

  Example: command:q;timeoutForExec:0
• status: string
  Status of the step

  Example: Failed
• target: string
  Name of the target

  Example: ABC.us.oracle.com

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a state",
            "example":"CDAAE80FDD3D7987E053E00F4B64DEBB"
        },
        "status":{
            "type":"string",
            "description":"Status of the step",
            "example":"Failed"
        },
        "target":{
            "type":"string",
            "description":"Name of the target",
            "example":"ABC.us.oracle.com"
        },
        "lastUpdated":{
            "type":"string",
            "description":"last updated time"
        },
        "retryArguments":{
            "type":"string",
            "description":"arguments which needs to be retried",
            "example":"command:q;timeoutForExec:0"
        }
    }
}

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