Start task

POST

/api/v1/tasks/start

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://127.0.0.1:58259/api/v1/tasks/start");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"taskId\": \"example\", \"taskType\": \"REFRESH_LIBRARY_METADATA\", \"triggeredByCron\": true, \"options\": \"example\" }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://127.0.0.1:58259/api/v1/tasks/start"),
    Content = new StringContent("{ \"taskId\": \"example\", \"taskType\": \"REFRESH_LIBRARY_METADATA\", \"triggeredByCron\": true, \"options\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "http://127.0.0.1:58259/api/v1/tasks/start"

  payload := strings.NewReader("{ \"taskId\": \"example\", \"taskType\": \"REFRESH_LIBRARY_METADATA\", \"triggeredByCron\": true, \"options\": \"example\" }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://127.0.0.1:58259/api/v1/tasks/start"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"taskId\": \"example\", \"taskType\": \"REFRESH_LIBRARY_METADATA\", \"triggeredByCron\": true, \"options\": \"example\" }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"taskId\": \"example\", \"taskType\": \"REFRESH_LIBRARY_METADATA\", \"triggeredByCron\": true, \"options\": \"example\" }");
Request request = new Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/tasks/start")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'http://127.0.0.1:58259/api/v1/tasks/start',
  headers: {'Content-Type': 'application/json'},
  data: {
    taskId: 'example',
    taskType: 'REFRESH_LIBRARY_METADATA',
    triggeredByCron: true,
    options: 'example'
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'http://127.0.0.1:58259/api/v1/tasks/start';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"taskId":"example","taskType":"REFRESH_LIBRARY_METADATA","triggeredByCron":true,"options":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"taskId\": \"example\", \"taskType\": \"REFRESH_LIBRARY_METADATA\", \"triggeredByCron\": true, \"options\": \"example\" }")
val request = Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/tasks/start")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "http://127.0.0.1:58259/api/v1/tasks/start";

    let payload = json!({
        "taskId": "example",
        "taskType": "REFRESH_LIBRARY_METADATA",
        "triggeredByCron": true,
        "options": "example"
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url http://127.0.0.1:58259/api/v1/tasks/start \
  --header 'Content-Type: application/json' \
  --data '{ "taskId": "example", "taskType": "REFRESH_LIBRARY_METADATA", "triggeredByCron": true, "options": "example" }'

wget --quiet \
  --method POST \
  --header 'Content-Type: application/json' \
  --body-data '{ "taskId": "example", "taskType": "REFRESH_LIBRARY_METADATA", "triggeredByCron": true, "options": "example" }' \
  --output-document \
  - http://127.0.0.1:58259/api/v1/tasks/start

Start a task immediately with the provided task request payload.

Request Body^required

application/json

object

taskId

string

taskType

string

Allowed values: REFRESH_LIBRARY_METADATA UPDATE_BOOK_RECOMMENDATIONS CLEANUP_DELETED_BOOKS SYNC_LIBRARY_FILES BOOKDROP_PERIODIC_SCANNING CLEANUP_TEMP_METADATA REFRESH_METADATA_MANUAL

triggeredByCron

boolean

options

Responses

200

*/*

object

taskId

string

taskType

string

Allowed values: REFRESH_LIBRARY_METADATA UPDATE_BOOK_RECOMMENDATIONS CLEANUP_DELETED_BOOKS SYNC_LIBRARY_FILES BOOKDROP_PERIODIC_SCANNING CLEANUP_TEMP_METADATA REFRESH_METADATA_MANUAL

status

string

Allowed values: ACCEPTED IN_PROGRESS COMPLETED FAILED CANCELLED

Start task

Request Body required

Responses

200

Request Body^required