Download OpenAPI specification:Download
API for managing integration command logs
Retrieve a list of all integration command log records with optional filtering and pagination
| limit | integer [ 1 .. 100 ] Default: 50 Maximum number of records to return |
| offset | integer >= 0 Default: 0 Number of records to skip for pagination |
| sort | string Field to sort by |
| order | string Default: "desc" Enum: "asc" "desc" Sort order (asc or desc) |
| filter | string Filter conditions in JSON format |
| search | string Search term for text fields |
{- "success": true,
- "data": [
- {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "commandType": "sync",
- "command": "sync-products",
- "parameters": { },
- "status": "completed",
- "startTime": "2023-01-15T08:00:00Z",
- "endTime": "2023-01-15T08:05:00Z",
- "duration": 300000,
- "output": { },
- "errorLog": "string",
- "processedRecords": 0,
- "failedRecords": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
], - "total": 0
}Create a new integration command log record with the provided data
| integrationId required | string Integration identifier |
| commandType required | string Enum: "sync" "import" "export" "validate" "transform" Type of command executed |
| command required | string The actual command that was executed |
object Command parameters | |
| status required | string Enum: "pending" "running" "completed" "failed" "cancelled" Status of the command execution |
| startTime | string <date-time> Command start time |
| endTime | string <date-time> Command end time |
| duration | number Command execution duration in milliseconds |
object Command output data | |
| errorLog | string Error log if command failed |
| processedRecords | integer >= 0 Number of records processed |
| failedRecords | integer >= 0 Number of records that failed processing |
object Additional metadata |
{- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "commandType": "sync",
- "command": "sync-products",
- "parameters": { },
- "status": "completed",
- "startTime": "2023-01-15T08:00:00Z",
- "endTime": "2023-01-15T08:05:00Z",
- "duration": 300000,
- "output": { },
- "errorLog": "string",
- "processedRecords": 0,
- "failedRecords": 0,
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "commandType": "sync",
- "command": "sync-products",
- "parameters": { },
- "status": "completed",
- "startTime": "2023-01-15T08:00:00Z",
- "endTime": "2023-01-15T08:05:00Z",
- "duration": 300000,
- "output": { },
- "errorLog": "string",
- "processedRecords": 0,
- "failedRecords": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Retrieve a specific integration command log record by its ID
| id required | string Integration command log record ID |
{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "commandType": "sync",
- "command": "sync-products",
- "parameters": { },
- "status": "completed",
- "startTime": "2023-01-15T08:00:00Z",
- "endTime": "2023-01-15T08:05:00Z",
- "duration": 300000,
- "output": { },
- "errorLog": "string",
- "processedRecords": 0,
- "failedRecords": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Update an existing integration command log record with new data
| id required | string Integration command log record ID |
| integrationId required | string Integration identifier |
| commandType required | string Enum: "sync" "import" "export" "validate" "transform" Type of command executed |
| command required | string The actual command that was executed |
object Command parameters | |
| status required | string Enum: "pending" "running" "completed" "failed" "cancelled" Status of the command execution |
| startTime | string <date-time> Command start time |
| endTime | string <date-time> Command end time |
| duration | number Command execution duration in milliseconds |
object Command output data | |
| errorLog | string Error log if command failed |
| processedRecords | integer >= 0 Number of records processed |
| failedRecords | integer >= 0 Number of records that failed processing |
object Additional metadata |
{- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "commandType": "sync",
- "command": "sync-products",
- "parameters": { },
- "status": "completed",
- "startTime": "2023-01-15T08:00:00Z",
- "endTime": "2023-01-15T08:05:00Z",
- "duration": 300000,
- "output": { },
- "errorLog": "string",
- "processedRecords": 0,
- "failedRecords": 0,
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "commandType": "sync",
- "command": "sync-products",
- "parameters": { },
- "status": "completed",
- "startTime": "2023-01-15T08:00:00Z",
- "endTime": "2023-01-15T08:05:00Z",
- "duration": 300000,
- "output": { },
- "errorLog": "string",
- "processedRecords": 0,
- "failedRecords": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Delete an existing integration command log record
| id required | string Integration command log record ID |
{- "success": true,
- "message": "Integration command log record deleted successfully"
}