Jump to

• Request
• Response

Delete Push Request

delete

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

Deletes the given push request if it doesn't have a status of TRAINING.

Request

Path Parameters

• botId(required): string
  The ID of the skill that contains the entity.
• entityId(required): string
  The ID of the entity that the push request is for.
• pushRequestId(required): string
  The ID of the push request to delete.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• */*

204 Response

Push request deleted.

404 Response

The push request doesn't exist for the skill or entity.

Body ()

Root Schema : RestError

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "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

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Context

Type: object

Show Source

• elementName: string
• elementType: string
  Allowed Values: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  Allowed Values: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

412 Response

Can't delete the push request because it has a TRAINING status.

Body ()

Root Schema : RestError

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "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

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Context

Type: object

Show Source

• elementName: string
• elementType: string
  Allowed Values: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  Allowed Values: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

Back to Top