Skip to main content
GET
/
job-config
/
tasks
/
_schema
Get the task jobs schema
import requests

url = "https://{FUSION_HOST}/job-config/tasks/_schema"

response = requests.get(url)

print(response.text)
{
  "type": "object",
  "properties": {},
  "oneOf": [
    {
      "type": "object",
      "title": "Log Cleanup",
      "description": "Use this job when you want to delete old logs.",
      "required": [
        "id",
        "collection",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9_\\-]+$"
        },
        "collection": {
          "type": "string",
          "title": "Logs collection",
          "enum": [
            "system_logs"
          ]
        },
        "days": {
          "type": "integer",
          "title": "Delete logs older than N days",
          "default": 30
        },
        "query": {
          "type": "string",
          "title": "Query to match docs to delete",
          "description": "Default value excludes audit log entries to preserve audit information such as login / logout events.",
          "default": "-logger_class_s:\"com.lucidworks.cloud.gateway.audit\""
        },
        "type": {
          "type": "string",
          "enum": [
            "system-logs-cleanup"
          ],
          "default": "system-logs-cleanup",
          "hints": [
            "readonly"
          ]
        }
      },
      "additionalProperties": false,
      "category": "Other",
      "categoryPriority": 1,
      "unsafe": false
    },
    {
      "type": "object",
      "title": "REST Call",
      "description": "Run arbitrary REST/HTTP/Solr command.",
      "required": [
        "id",
        "callParams",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9_\\-]+$"
        },
        "callParams": {
          "type": "object",
          "title": "Call Parameters",
          "required": [
            "uri",
            "method"
          ],
          "properties": {
            "uri": {
              "type": "string",
              "title": "Endpoint URI"
            },
            "method": {
              "type": "string",
              "title": "Call method",
              "description": "One of GET, POST, PUT, or DELETE.",
              "enum": [
                "get",
                "put",
                "post",
                "delete"
              ]
            },
            "queryParams": {
              "type": "object",
              "title": "Query parameters",
              "properties": {},
              "additionalProperties": {
                "type": "string"
              }
            },
            "headers": {
              "type": "object",
              "title": "Request protocol headers",
              "properties": {},
              "additionalProperties": {
                "type": "string"
              }
            },
            "entity": {
              "type": "string",
              "title": "Request entity (as string)",
              "hints": [
                "code",
                "lengthy"
              ]
            }
          }
        },
        "type": {
          "type": "string",
          "enum": [
            "rest-call"
          ],
          "default": "rest-call",
          "hints": [
            "readonly"
          ]
        }
      },
      "additionalProperties": false,
      "category": "Other",
      "categoryPriority": 1,
      "unsafe": false
    },
    {
      "type": "object",
      "title": "Download Blob",
      "description": "Download and update Blob.",
      "required": [
        "id",
        "url",
        "blobId",
        "type"
      ],
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9_\\-]+$"
        },
        "url": {
          "type": "string",
          "title": "Url to download a Blob from"
        },
        "blobId": {
          "type": "string",
          "title": "Blob id"
        },
        "type": {
          "type": "string",
          "enum": [
            "blob-download"
          ],
          "default": "blob-download",
          "hints": [
            "readonly"
          ]
        }
      },
      "additionalProperties": false,
      "category": "Other",
      "categoryPriority": 1,
      "unsafe": false
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - */*

OK

​
type
enum<string>
Available options:
string,
number,
integer,
boolean,
object,
array,
null,
ref
​
title
string
​
description
string
​
required
string[]
​
properties
object
​
additionalProperties
object
​
minProperties
integer<int32>
​
maxProperties
integer<int32>
​
definitions
object
​
category
string
​
categoryPriority
integer<int32>
​
enum
object[]
​
hints
string[]
​
unsafe
boolean
​
default
object
​
anyOf
object[]
​
propertyGroups
object[]