---
# System prepended metadata

title: Plan Export API

---

# Plan Export API

## Add PLan Endpoint
```HTTP
POST /api/PlanExportJobScheduler/AddPLan HTTP1.1
host: localhost
content-type: application/json
{
  "planId": 1,
  "planName": null,
  "mode": "Daily",
  "day": null,
  "hour": "23",
}
```

### Body
| Fields   | Type               | Default | Values                 |
| -------- | :----------------: | :-----: | :--------------------: |
| planId   | `int` or `null`    | --      | --                     |
| planName | `string` or `null` | --      | --                     |
| mode     | `enum` or `null`   | `Daily` | `Daily`, `Monthly`     |
| day      | `int` or `null`    | `1`     | min: `1` and max: `28` |
| hour     | `int` or `null`    | `0`     | min: `0` and max: `23` |

### Response
```json
{
  "data": true,
  "errors": [
    {
      "code": "",
      "description": ""
    }
  ]
}
```

## Delete PLan Endpoint
```HTTP
DELETE /api/PlanExportJobScheduler/DeletePLan/?planName=Plan1 HTTP1.1
host: localhost
```

### Query Parameters
| Parameters | Type     | Default | Values                 |
| ---------- | :------: | :-----: | :--------------------: |
| planName   | `string` | --      | --                     |

### Response
```json
{
  "data": true,
  "errors": [
    {
      "code": "",
      "description": ""
    }
  ]
}
```

## Plan Logs Endpoint
```HTTP
GET /api/PlanExportJobScheduler/PlanLogs/?planName=Plan1 HTTP1.1
host: localhost
```
```HTTP
GET /api/PlanExportJobScheduler/PlanLogs/?planId=1 HTTP1.1
host: localhost
```

### Query Parameters
| Parameters | Type               | Default | Values                 |
| ---------- | :----------------: | :-----: | :--------------------: |
| planId     | `int` or `null`    | --      | --                     |
| planName   | `string` or `null` | --      | --                     |

### Response
```json
{
  "data": "All logs as string on multiple line",
  "errors": [
    {
      "code": "",
      "description": ""
    }
  ]
}
```

## List Plan Endpoint
```HTTP
GET /api/PlanExportJobScheduler/ListPlans/?offset=0&status=Suscess HTTP1.1
host: localhost
```

### Query Parameters
| Parameters |  Type              | Default | Values                                                   |
| ---------- | :----------------: | :-----: | :------------------------------------------------------: |
| `offset`   | `int` or `null`    | `0`     | --                                                       |
| `status`   | `enum` or `null`   | `All`   | `All`, `Success`, `Failed`, <br> `Scheduled`, `Enqueued` |

### Response
```json
{
  "data": [
    {
      "planId": 1,
      "planName": "Plan 1",
      "mode": "Daily",
      "day": null,
      "hour": "1",
      "status": "Success"
    }
  ],
  "errors": [
    {
      "code": "",
      "description": ""
    }
  ]
}
```