Add a Cancel REST API function to existing API

Question

I am working on an existing REST API that has the following APIS for getting the status of certain tasks:

GET /Status              <-- Returns json array of status of all running tasks
GET /Status/{TaskID}     <-- Returns json Status="blah" item of status of task with TaskID

I now need to create a CANCEL API which cancels a specific task.
What is the correct 'RestFul' way to do this?

Is it?

POST /Status/{TaskID}/Cancel

Or?

PUT /Status/{TaskID}/Cancel

Or something different?

Is there a payload for cancellation? – tom redfern Oct 07 '20 at 18:00 — tom redfern, Oct 07 '20 at 18:00

score 2 · Answer 1 · answered Oct 07 '20 at 17:35

2

I would think

DELETE /Task/{TaskID}

answered Oct 07 '20 at 17:35

Julian

33,915
22
119
174

Add a Cancel REST API function to existing API

1 Answers1