Data Source Management
Collection Management
Create Collection Endpoint POST /v1/api/dm/collection/create
| Resource URL | /v1/api/dm/collection/create |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Description
Create a new collection.
Request Body
| Parameter | Description | Required | Type | Default Value |
|---|---|---|---|---|
| collection | Collection name | Yes | String | N/A |
| description | Collection description | Yes | String | N/A |
Example Request
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Get All Collections Endpoint GET /v1/api/dm/collection/get_all_collections
| Resource URL | /v1/api/dm/collection/get_all_collections |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Description
Get all collections.
Example Request
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Successful Response |
Get Collection By Id Endpoint GET /v1/api/dm/collection/collection_id/{collection_id}
| Resource URL | /v1/api/dm/collection/collection_id/{collection_id} |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Description
Get a collection by its ID.
Parameters
| Parameter | Description | Required | Type | Default Value |
|---|---|---|---|---|
| collection_id | Collection ID | Yes | String | N/A |
Example Request
Example Response
Update Collection Endpoint PUT /v1/api/dm/collection/{collection_id}
| Resource URL | /v1/api/dm/collection/{collection_id} |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Description
Update an existing collection by its ID.
Parameters
| Parameter | Description | Required | Type | Default Value |
|---|---|---|---|---|
| collection_id | Collection ID | Yes | String | N/A |
Request Body
| Parameter | Description | Required | Type | Default Value |
|---|---|---|---|---|
| collection_id | Collection ID | Yes | String | N/A |
| description | Collection description | Yes | String | N/A |
Example Request
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |
Delete Collection Endpoint DELETE /v1/api/dm/collection/{collection_id}
| Resource URL | /v1/api/dm/collection/{collection_id} |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | No |
| HTTPS | Yes |
Description
Delete a collection by its ID.
Parameters
| Parameter | Description | Required | Type | Default Value |
|---|---|---|---|---|
| collection_id | Collection ID | Yes | String | N/A |
Example Request
Example Response
HTTP Responses
| HTTP Code | Message |
|---|---|
| 200 | Successful Response |
| 422 | Validation Error |