⏰ Task Management

Scheduled task and cron job management endpoints. 6 endpoints available.

🎯 Quick Stats

Total Endpoints: 6
Base URL: https://api.market.decenctype.com
Authentication: Bearer Token / API Key

📊 Methods

🔍 GET: 3 endpoints
📝 POST: 1 endpoints
✏️ PUT: 2 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

Method	Endpoint	Description
🔍 `GET`	`/task/cron`	No description
📝 `POST`	`/task`	Create a new task
🔍 `GET`	`/task`	Get all tasks
🔍 `GET`	`/task/{taskId}`	No description
✏️ `PUT`	`/task/{taskId}/suspend`	No description
✏️ `PUT`	`/task/{taskId}/resume`	No description

📖 Detailed Documentation

GET /task/cron

GET/task/cron

Full URL

https://api.market.decenctype.com/task/cron

🔐 Authentication: Required (see authentication section above)

Operation ID: listCronJobs

Response Status:

✅ 200: Success

📝 Example Request

curl -X GET "https://api.market.decenctype.com/task/cron" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Create a new task

POST/task

Full URL

https://api.market.decenctype.com/task

Description: Create a new task

Operation ID: createTask

Response Status:

✅ 201: Task created successfully

📋 Response Examples

response.json

1{
2  "id": 1,
3  "name": "daily-task",
4  "description": "This is a daily task",
5  "cron": "0 0 * * *",
6  "active": true,
7  "payload": {
8    "key": "value"
9  },
10  "maxRetries": 3,
11  "retryDelay": 30000
12}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/task" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

Get all tasks

GET/task

Full URL

https://api.market.decenctype.com/task

📋 Query Parameters

Parameter	Type	Required	Description
`current`	`number`	✅	No description
`pageSize`	`number`	✅	No description

Description: Get all tasks

Operation ID: getAllTasks

Response Status:

✅ 200: List of tasks

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "id": 1,
5      "name": "示例任务",
6      "description": "这是一个示例任务描述",
7      "cron": "0 0 0 * * *",
8      "active": true,
9      "createdAt": "2023-06-29T00:00:00.000Z"
10    }
11  ],
12  "total": 100,
13  "current": 1,
14  "pageSize": 10
15}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/task" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

GET /task/{taskId}

GET/task/{taskId}

Full URL

https://api.market.decenctype.com/task/{taskId}

🎯 Path Parameters

taskId (number) - ✅ Required: No description

Operation ID: findOne

Response Status:

✅ 200: Success

📋 Response Examples

response.json

1{
2  "id": 1,
3  "name": "daily-task",
4  "description": "This is a daily task",
5  "cron": "0 0 * * *",
6  "active": true,
7  "payload": {
8    "key": "value"
9  },
10  "maxRetries": 3,
11  "retryDelay": 30000
12}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/task/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

PUT /task/{taskId}/suspend

PUT/task/{taskId}/suspend

Full URL

https://api.market.decenctype.com/task/{taskId}/suspend

🎯 Path Parameters

taskId (number) - ✅ Required: No description

Operation ID: suspend

Response Status:

✅ 200: Success

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/task/example-id/suspend" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

PUT /task/{taskId}/resume

PUT/task/{taskId}/resume

Full URL

https://api.market.decenctype.com/task/{taskId}/resume

🎯 Path Parameters

taskId (number) - ✅ Required: No description

Operation ID: resume

Response Status:

✅ 200: Success

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/task/example-id/resume" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

⏰ Task Management

🎯 Quick Stats

📊 Methods

🔑 Bearer Token (Recommended)

🔧 API Key

On this page