Retrieve 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.text){
"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"
}
}
}
}
}
}Retrieve an index stage
Fetch an index stage by type. The response is the index stage schema in JSON format.
GET
/
index-stages
/
schema
/
{type}
Retrieve 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.text){
"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
Basic authAPI key
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The name of the index stage.
Response
200 - application/json
OK
Configuration properties.
Available options:
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I