Stage Information
Stages are used to define the search terms when pulling articles. They are also saved in a Channel Definition so that they can be used either in FTS Apollo(TM) through the front end or through the Channel Definition Endpoint, pulled so they can be use for looking up articles. A stage can be one or more terms which taken together constitute an OR search (or ANY) which means that the results for that term plus the results for the other terms in the search are added together, constituting an ANY OF THESE box when you look at the channel definition. There are two types of stages. The first type is the inclusive ANY OF THESE stages which adds articles that match to the results. The second type is the NONE OF THESE stage which excludes anything in that stage from the results.
ANY OF THESE Stage
{
"not": false,
"entities": ["...List of terms"]
}
NONE OF THESE Stage
{
"not": true,
"entities": ["...List of terms"]
}
The list of terms are contained in the entities field.
Entity Term
The first and most common term is an Entity Term. This can be any Entity set up in the system. You will need to know the Entity ID of the entity you want to use. In addition, an Entity term can include relevance levels (low, medium and high).
Example Entity Term
{
"type": "entity",
"value": 1582,
"options": {
"relevance": "high"
}
}
Metadata Term
A Metadata Term is used when you want to filter using specific Metadata types in the term. Available Types;
| Type | Name | Description |
|---|---|---|
| Issuing Agency | issuingAgencies | Issuing Agency for a Regulatory Publication |
| Jurisdiction | jurisdictions | The Jurisdiction associated with a Regulatory Publication |
| Document Type | docTypes | The document type of a document |
| Firm Reference | firmReferences | The firm (company) directly associated with a document either as a publisher or in reference to that firm. |
{
"type": "issuingAgencies",
"value": 7877606,
"options": {}
}