# Integration Command Log API

API for managing integration command logs

**Version:** 1.0.0

## Overview

### Base URLs

- **Production server**: `https://sv.api.repzo.me`

- **Staging server**: `https://staging.sv.api.repzo.me`

### API Categories

- **Integration Command Log**: Operations related to integration command log management

## Authentication

This API uses the following authentication methods:

- **ApiKeyAuth**

## Endpoints

### `/integration-command-log`

#### GET /integration-command-log

**Summary:** Get all integration command log records

**Description:** Retrieve a list of all integration command log records with optional filtering and pagination

**Tags:** Integration Command Log

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `limit` | query | integer | No | Maximum number of records to return |

| `offset` | query | integer | No | Number of records to skip for pagination |

| `sort` | query | string | No | Field to sort by |

| `order` | query | string | No | Sort order (asc or desc) |

| `filter` | query | string | No | Filter conditions in JSON format |

| `search` | query | string | No | Search term for text fields |

##### Responses

**200** - List of integration command log records retrieved successfully

Content-Type: `application/json`

**400** - Bad request

**401** - Unauthorized

**500** - Internal server error

---

#### POST /integration-command-log

**Summary:** Create a new integration command log record

**Description:** Create a new integration command log record with the provided data

**Tags:** Integration Command Log

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Integration command log record created successfully

Content-Type: `application/json`

**400** - Bad request

**401** - Unauthorized

**500** - Internal server error

---

### `/integration-command-log/{id}`

#### GET /integration-command-log/{id}

**Summary:** Get integration command log record by ID

**Description:** Retrieve a specific integration command log record by its ID

**Tags:** Integration Command Log

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Integration command log record ID |

##### Responses

**200** - Integration command log record retrieved successfully

Content-Type: `application/json`

**404** - Integration command log record not found

**401** - Unauthorized

**500** - Internal server error

---

#### PUT /integration-command-log/{id}

**Summary:** Update integration command log record

**Description:** Update an existing integration command log record with new data

**Tags:** Integration Command Log

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Integration command log record ID |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Integration command log record updated successfully

Content-Type: `application/json`

**400** - Bad request

**404** - Integration command log record not found

**401** - Unauthorized

**500** - Internal server error

---

#### DELETE /integration-command-log/{id}

**Summary:** Delete integration command log record

**Description:** Delete an existing integration command log record

**Tags:** Integration Command Log

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Integration command log record ID |

##### Responses

**200** - Integration command log record deleted successfully

Content-Type: `application/json`

**404** - Integration command log record not found

**401** - Unauthorized

**500** - Internal server error

---

## Data Models

### IntegrationCommandLog

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Unique identifier for the integration command log record |

| `integrationId` | string | Yes | Integration identifier |

| `commandType` | string | Yes | Type of command executed |

| `command` | string | Yes | The actual command that was executed |

| `parameters` | object | No | Command parameters |

| `status` | string | Yes | Status of the command execution |

| `startTime` | string | No | Command start time |

| `endTime` | string | No | Command end time |

| `duration` | number | No | Command execution duration in milliseconds |

| `output` | object | No | Command output data |

| `errorLog` | string | No | Error log if command failed |

| `processedRecords` | integer | No | Number of records processed |

| `failedRecords` | integer | No | Number of records that failed processing |

| `metadata` | object | No | Additional metadata |

| `createdAt` | string | No | Record creation timestamp |

| `updatedAt` | string | No | Record last update timestamp |

### IntegrationCommandLogInput

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `integrationId` | string | Yes | Integration identifier |

| `commandType` | string | Yes | Type of command executed |

| `command` | string | Yes | The actual command that was executed |

| `parameters` | object | No | Command parameters |

| `status` | string | Yes | Status of the command execution |

| `startTime` | string | No | Command start time |

| `endTime` | string | No | Command end time |

| `duration` | number | No | Command execution duration in milliseconds |

| `output` | object | No | Command output data |

| `errorLog` | string | No | Error log if command failed |

| `processedRecords` | integer | No | Number of records processed |

| `failedRecords` | integer | No | Number of records that failed processing |

| `metadata` | object | No | Additional metadata |

## TypeScript Usage

See [integration-command-log-examples.md](./integration-command-log-examples.md) for detailed TypeScript usage examples.