Source Folder

Description

The Source Folder resource defines the interface for a source folder. This resource is used to read, update and delete a source folder. The default source folder is the folder without a name. If a folder isn't specified when a source is attached, the source will be put in the default folder.

Operations

GET - Get a user-defined collection.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
udcid path The id of the user-defined collection.
Status Codes
  • 200  -  Upon a successful read.
  • 404  -  If the requested collection is not found.

POST - Update a user-defined collection.

Produces - Specify a returned data format using the Accept header.
Consumes - Specify the incoming data format using the Content-Type header.
Parameters
Name Type Description
udcid path The id of the user-defined collection.
body request-body The updated collection.
Status Codes
  • 204  -  The update was successful.
  • 400  -  If the requested collection name is invalid.
  • 404  -  If the requested collection is not found.

DELETE - Delete a user-defined collection.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
udcid path The id of the user-defined collection.
Status Codes
  • 204  -  The delete was successful.
  • 400  -  If the requested collection is not empty.
  • 404  -  If the requested collection is not found.

Example Requests

Delete Source Folder How to delete a source folder.
Read Source Folder How to read a source folder.
Update Source Folder How to update a source folder.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.