REST Interface for Federated BPM Resources - Task Instance Resource - DELETE Method

Use this method to delete a task instance.

Sample Method Invocation

DELETE /rest/bpm/federated/htm/v1/task/{tkiid}?systemID={string}

Parameters

Required Federation Parameter
NameValue TypeDescription
systemID string ID of the BPEL runtime system hosting the resource.

Request Content

None.

Response Content

None.

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "description": "Message text of the exception."
            },
            "errorMessageParameters": {"type": ["string"], "optional": true,
               "description": "Message text parameters of the exception."
            },
            "programmersDetails": {"type": "object", "optional": true,
               "description": "Additional, exception details, for example, a stack trace."
            },
            "status": {"type": "string", "optional": true,
               "description": "Status of the request."
            },
            "exceptionType": {"type": "string", "optional": true,
               "description": "Type of the exception."
            }      
         }
      ], 
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description": "Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Additional, exception details, for example, a stack trace."
      },
      "status": {"type": "string", "optional": true,
         "description": "Status of the request."
      },
      "exceptionType": {"type": "string", "optional": true,
         "description": "Type of the exception."
      }      
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - task deleted.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
409 ConflictA conflict exists with the current state of the resource.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.
503 Service UnavailableThe federated request could not be delivered to individual federation targets.
504 Gateway TimeoutThe federated response has partial content due to missing individual responses.

Available Since

7.5

Parent Topic: Task Instance Resource