Jump to

• Request
• Response

Ignore failed steps of the deployment procedure instance

post

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

Ignore failed steps of deployment procedure instance latest execution if execution Id is not specified and if execution id is specified, then particular execution id steps will be ignored.In emcli, it is equivalent to 'ignore_instance'

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

It includes state id and execution id.

Show Source

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

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

  Example: CC1871802C4343A3E053E00F4B640973,CC1871802C4343A3E053E00F4B640963

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

Back to Top

Response

Supported Media Types

• application/json

202 Response

A request to ignore the failed steps was accepted.

Headers

• Location:
  URL to get the status of ignore failed step action.

Body ()

Root Schema : schema

Type: object

Show Source

• code: string
  code

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

  Example: A request to ignore the failed steps was accepted

{
    "type":"object",
    "properties":{
        "code":{
            "description":"code",
            "type":"string",
            "example":"202"
        },
        "message":{
            "description":"Rest Api message for ignore instance.",
            "type":"string",
            "example":"A request to ignore the failed steps was accepted"
        }
    }
}

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

403 Response

Forbidden. The user is forbidden 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