API docs by Redocly

Patch Action API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing patch actions

Patch Action

Operations related to patch action management

Get all patch action records

Retrieve a list of all patch action 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 patch action

Create a new patch action with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the patch action

description
string

Description of what the patch action does

targetEntity
required
string

The entity type this patch targets

object

Conditions that must be met for the patch to apply

required
Array of objects
batchSize
integer [ 1 .. 1000 ]
Default: 100

Number of records to process in each batch

status
string
Default: "draft"
Enum: "draft" "ready" "running" "completed" "failed" "cancelled"

Status of the patch action

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Update Product Prices",
  • "description": "string",
  • "targetEntity": "product",
  • "conditions": { },
  • "patches": [
    ],
  • "batchSize": 100,
  • "status": "draft",
  • "metadata": { }
}

Response samples

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

Get patch action by ID

Retrieve a specific patch action by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Responses

Response samples

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

Update patch action

Update an existing patch action with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Request Body schema: application/json
name
required
string

Name of the patch action

description
string

Description of what the patch action does

targetEntity
required
string

The entity type this patch targets

object

Conditions that must be met for the patch to apply

required
Array of objects
batchSize
integer [ 1 .. 1000 ]
Default: 100

Number of records to process in each batch

status
string
Default: "draft"
Enum: "draft" "ready" "running" "completed" "failed" "cancelled"

Status of the patch action

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Update Product Prices",
  • "description": "string",
  • "targetEntity": "product",
  • "conditions": { },
  • "patches": [
    ],
  • "batchSize": 100,
  • "status": "draft",
  • "metadata": { }
}

Response samples

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

Delete patch action

Delete an existing patch action

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Patch action deleted successfully"
}

Execute patch action

Execute a specific patch action by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Patch action ID

Responses

Response samples

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