File Service API Documentation
Poll for available files for a specific tenant with pagination
HTTP Method
GET
Endpoint
/api/{tenantId}/files/poll
Parameters
- tenantId: Tenant ID (required)
- page: Page number (optional, default: 0)
- size: Page size (optional, default: 20)
200 Responses
Files retrieved successfully
400 Responses
Invalid Input
500 Responses
Internal Server Error
Pick up a file for a specific tenant by file ID
HTTP Method
GET
Endpoint
/api/{tenantId}/files/poll
Parameters
- tenantId: Tenant ID (required)
- page: Page number (optional, default: 0)
- size: Page size (optional, default: 20)
403 Responses
Access Denied
200 Responses
File Picked Up Successfully
500 Responses
Internal Server Error
404 Responses
File Not Found
Summary
pollFiles:
Poll for available files for a specific tenant with pagination.
pickupFile:
Pick up a file for a specific tenant by file ID.
Tags
File Controller
Components
Schemas:
FileMetadatas
Responses:
Described under the endpoint responses.
Request Bodies:
Described under the request body for the endpoints.
File MetaData Schema
id: integer (int64)
fileName: string
status: string
tenantId: string