102 lines
2.2 KiB
Markdown
102 lines
2.2 KiB
Markdown
---
|
|
name: uploads-routes
|
|
description: Handle 9 OpenAPI operation(s) under /uploads for the uploads route group.
|
|
---
|
|
|
|
# uploads API Routes
|
|
|
|
Handle 9 OpenAPI operation(s) under /uploads for the uploads route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### uploads_list
|
|
|
|
- Operation ID: `uploads_list`
|
|
- Route: `GET /uploads`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `campaignId` in `query`
|
|
|
|
### upload_create
|
|
|
|
- Operation ID: `upload_create`
|
|
- Route: `POST /uploads`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Body: JSON request body accepted.
|
|
|
|
### upload_retrieve
|
|
|
|
- Operation ID: `upload_retrieve`
|
|
- Route: `GET /uploads/{upl_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
|
|
### upload_update
|
|
|
|
- Operation ID: `upload_update`
|
|
- Route: `PATCH /uploads/{upl_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### upload_delete
|
|
|
|
- Operation ID: `upload_delete`
|
|
- Route: `DELETE /uploads/{upl_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
|
|
### upload_file
|
|
|
|
- Operation ID: `upload_file`
|
|
- Route: `POST /uploads/{upl_id}/file`
|
|
- Mode: WRITE
|
|
- Summary: Upload file
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### upload_export_create
|
|
|
|
- Operation ID: `upload_export_create`
|
|
- Route: `POST /uploads/{upl_id}/exports`
|
|
- Mode: WRITE
|
|
- Summary: Create Export
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### report_retrieve
|
|
|
|
- Operation ID: `report_retrieve`
|
|
- Route: `GET /uploads/{upl_id}/report`
|
|
- Mode: READ
|
|
- Summary: Retrieve Line Item Report
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
- `status` in `query`
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
|
|
### export_retrieve
|
|
|
|
- Operation ID: `export_retrieve`
|
|
- Route: `GET /uploads/{upl_id}/exports/{ex_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve Export
|
|
- Parameters:
|
|
- `upl_id` in `path` required
|
|
- `ex_id` in `path` required
|