Integration Command Log API (1.0.0)

Download OpenAPI specification:Download

API for managing integration command logs

Integration Command Log

Operations related to integration command log management

Get all integration command log records

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

Authorizations:
ApiKeyAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new integration command log record

Create a new integration command log record with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "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": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get integration command log record by ID

Retrieve a specific integration command log record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration command log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update integration command log record

Update an existing integration command log record with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration command log record ID

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "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": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete integration command log record

Delete an existing integration command log record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration command log record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Integration command log record deleted successfully"
}