Jump to

• Request
• Response

Finalize or Abort Push Request

put

/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}/{action}

Use this operation to finalize or abort the push request.

• Set the {action} to DONE to close an open push request and then start training the entity.
• Set the {action} to ABORT to abort the push request. You can't abort a push request if it is training or it has completed.

.

Request

Path Parameters

• action: string
  The action to perform.
• botId: string
  The ID of the skill that contains the entity.
• entityId: string
  The ID of the entity that the push request is for.
• pushRequestId: string
  Perform the action on the push request that has this ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Action successfully completed.

404 Response

The request can't be performed because the specified skill, entity, or push request doesn't exist.

Body ()

Root Schema : RestError

Type: object

Show Source

• detail(optional): string
• o:ecid(optional): string
• o:errorCode(optional): string
• o:errorDetails(optional): array o:errorDetails
• o:errorPath(optional): string
• o:location(optional): object Location
• o:opcRequestId(optional): string
• status(optional): integer(int32)
• title(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

Nested Schema : Location

Type: object

Show Source

• o:colNo(optional): integer(int32)
• o:lineNo(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

412 Response

Can't perform the action because the push request is not INPROGRESS.

Body ()

Root Schema : RestError

Type: object

Show Source

• detail(optional): string
• o:ecid(optional): string
• o:errorCode(optional): string
• o:errorDetails(optional): array o:errorDetails
• o:errorPath(optional): string
• o:location(optional): object Location
• o:opcRequestId(optional): string
• status(optional): integer(int32)
• title(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

Nested Schema : Location

Type: object

Show Source

• o:colNo(optional): integer(int32)
• o:lineNo(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top