Skip to main content
GET
/
index-stages
/
schema
/
{type}
Get an index stage
import requests

url = "https://{FUSION HOST}/api/index-stages/schema/{type}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.json())
{
  "type": "object",
  "title": "Regex Field Extraction",
  "description": "This stage allows you to extract entities using regular expressions",
  "properties": {
    "rules": {
      "type": "array",
      "title": "Regex Rules",
      "items": {
        "type": "object",
        "required": [
          "pattern"
        ],
        "properties": {
          "source": {
            "type": "array",
            "title": "Source Fields",
            "items": {
              "type": "string"
            }
          },
          "target": {
            "type": "string",
            "title": "Target Field"
          },
          "pattern": {
            "type": "string",
            "title": "Regex Pattern",
            "format": "regex"
          },
          "annotateAs": {
            "type": "string",
            "title": "Annotation Name"
          }
        }
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

type
string
required

The name of the index stage type.

Response

200 - application/json

OK

Configuration properties.

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
maxProperties
integer
definitions
object
category
string
categoryPriority
integer
hints
string[]
unsafe
boolean
default
object
oneOf
object[]
propertyGroups
object[]