Delete a file or folder
POST /v1/workspace/books/{bookId}/delete
Delete one file or folder from the working copy, as it is; Discard brings back what was published. 404 not_found when it is not there. Nothing is published until Save; the agent sees it at once. 409 workspace_busy while Git works in the repository (the agent’s, or a sync): nothing changed, try again. For those who can view the Book; changes for its editors and owner (403 workspace_forbidden).
Authorizations
Parameters
Path Parameters
Request Body required
object
A file or folder (one tree entry).
Responses
200
Success
A change to the working copy: not published until Save.
object
What changed in the working copy, by path: a move’s from and to, a delete’s path, the files an add wrote, a discard put back or removed, or an undo changed.
400
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
401
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
403
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
404
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
409
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
410
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
411
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
413
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
422
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.
503
Rejected; never contains credentials or upstream payloads.
object
object
Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.
Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.
Host_in_use: the host another service holds.
Host_in_use: the id of the service that holds the host.
File_invalid: why the change, or a picture, was refused. Open: path | text | size | skill | skills | count | type.
File_exists from an add: every path of the request where a file is and replace was not set, all at once, so the person can be asked once. publish_conflict: the files someone published changes to the same lines of.
Publish_conflict: who published those changes, by name.