Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Significance Query",
"description": "Significance Query API provides endpoints for the Significance Engine",
"version": "1.0"
},
"servers": [
{
"url": "/significancequery"
}
],
"paths": {
"/api/v1/SignificanceResult/{journeyId}/{taskId}": {
"get": {
"tags": [
"SignificanceResult"
],
"summary": "Retrieves the significance result for a given task ID.",
"operationId": "GetSignificanceResultByTaskId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "taskId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "entityId",
"in": "query",
"description": "Optional entity ID to filter properties for a specific entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The significance result is returned in the response body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSignificanceResultByTaskIdDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request is invalid or missing required values.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error. An unexpected error occurred."
},
"401": {
"description": "Unauthorized. The caller lacks the required permissions."
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v1/SignificanceRule": {
"get": {
"tags": [
"SignificanceRule"
],
"summary": "Get a list of all available SignificanceRules",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: SignificanceRuleAccess",
"operationId": "GetSignificanceRules",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. List of SignificanceRules returned in the response body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSignificanceRulesItemDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request object has missing or invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
},
"401": {
"description": "Unauthorized. You are missing the required permissions to execute this action"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v1/SignificanceRule/{id}": {
"get": {
"tags": [
"SignificanceRule"
],
"summary": "Get a SignificanceRule by Id",
"description": "<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: SignificanceRuleAccess, SignificanceTaskAccess",
"operationId": "GetSignificanceRuleById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The SignificanceRule returned in the response body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSignificanceRuleDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request object has missing or invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
},
"401": {
"description": "Unauthorized. You are missing the required permissions to execute this action"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v1/SignificanceRule/getSignificanceRulesByListOfIds": {
"post": {
"tags": [
"SignificanceRule"
],
"summary": "Get a list of the SignificanceRules by a list of Ids",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: SignificanceRuleAccess",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GetSignificanceRulesByListOfIdsRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success. List of SignificanceRules returned in the response body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSignificanceRulesItemDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request object has missing or invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
},
"401": {
"description": "Unauthorized. You are missing the required permissions to execute this action"
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v1/SignificanceRule/simulate-evaluation": {
"post": {
"tags": [
"SignificanceRule"
],
"summary": "Simulates the evaluation of a significance rule",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: SignificanceRuleAccess",
"operationId": "SimulateSignificanceRuleEvaluation",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SimulateSignificanceRuleEvaluationRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success. Significance rule evaluation simulated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimulateSignificanceRuleEvaluationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request object has missing or invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"403": {
"description": "Forbidden. Your client is not authorized to access this endpoint",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"401": {
"description": "Unauthorized. You are missing the required permissions to execute this action"
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AuditEntryDto": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"propertyId": {
"type": "string"
},
"propertyName": {
"type": "string"
},
"fromValue": {
"type": "string",
"nullable": true
},
"toValue": {
"type": "string",
"nullable": true
},
"performedBy": {
"type": "string"
},
"performedAt": {
"type": "string",
"format": "date-time"
},
"explanation": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ConditionDefinitionDto": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"value": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"valueId": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"valueType": {
"type": "string",
"nullable": true
},
"dataSource": {
"type": "string",
"nullable": true
},
"operation": {
"type": "string",
"nullable": true
},
"logicalOperation": {
"type": "string",
"nullable": true
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"nullable": true
},
"valueField": {
"allOf": [
{
"$ref": "#/components/schemas/ValueField"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConditionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"logicalOperation": {
"type": "string",
"nullable": true
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConditionalValueDto": {
"allOf": [
{
"$ref": "#/components/schemas/StringConditionalValueDto"
},
{
"type": "object",
"properties": {
"valueId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ConditionalValueDto`1": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionDto"
},
{
"type": "object",
"properties": {
"value": {
"allOf": [
{
"$ref": "#/components/schemas/T`1"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
]
},
"DiscrepancyClassification": {
"enum": [
"Match",
"Immaterial",
"Material"
],
"type": "string"
},
"EvaluateDiscrepancyRuleDto": {
"type": "object",
"properties": {
"classification": {
"allOf": [
{
"$ref": "#/components/schemas/DiscrepancyClassification"
}
]
}
},
"additionalProperties": false
},
"EvaluateDiscrepancyRuleDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateDiscrepancyRuleDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"EvaluateDiscrepancyRuleRequest": {
"type": "object",
"properties": {
"matchRuleType": {
"allOf": [
{
"$ref": "#/components/schemas/MatchRuleType"
}
]
},
"threshold": {
"type": "number",
"format": "double",
"nullable": true
},
"platformValue": {
"type": "string",
"nullable": true
},
"providerValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EvaluateDiscrepancyRuleRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateDiscrepancyRuleRequest"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FieldReferenceDto": {
"type": "object",
"properties": {
"path": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"GetDiscrepancyRuleSetDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"scopingConditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
}
}
},
"additionalProperties": false
},
"GetDiscrepancyRuleSetDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GetDiscrepancyRuleSetDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetDiscrepancyRuleSetsItemDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"GetDiscrepancyRuleSetsItemDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDiscrepancyRuleSetsItemDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetDiscrepancyRulesItemDto": {
"type": "object",
"properties": {
"ruleId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"context": {
"allOf": [
{
"$ref": "#/components/schemas/SignificanceRuleContext"
}
]
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldReferenceDto"
}
},
"matchRuleType": {
"allOf": [
{
"$ref": "#/components/schemas/MatchRuleType"
}
]
},
"threshold": {
"type": "number",
"format": "double",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"GetDiscrepancyRulesItemDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDiscrepancyRulesItemDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetSignificanceResultByTaskIdDto": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetSignificanceResultByTaskIdProperty"
}
},
"error": {
"type": "string",
"nullable": true
},
"rationale": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ruleContext": {
"allOf": [
{
"$ref": "#/components/schemas/SignificanceRuleContext"
}
],
"nullable": true
},
"auditHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditEntryDto"
},
"nullable": true
},
"ruleName": {
"type": "string",
"nullable": true
},
"ruleId": {
"type": "string",
"nullable": true
},
"autonomyLevel": {
"type": "string",
"nullable": true
},
"agentName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GetSignificanceResultByTaskIdDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GetSignificanceResultByTaskIdDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetSignificanceResultByTaskIdProperty": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nameMetadata": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"beforeValue": {
"type": "string"
},
"afterValue": {
"type": "string"
},
"hasSignificantChange": {
"type": "boolean"
},
"modelEvaluation": {
"type": "string",
"nullable": true
},
"modelExplanation": {
"type": "string"
},
"userEvaluation": {
"type": "string",
"nullable": true
},
"userExplanation": {
"type": "string",
"nullable": true
},
"entityId": {
"type": "string",
"nullable": true
},
"isReviewed": {
"type": "boolean"
},
"reviewedBy": {
"type": "string",
"nullable": true
},
"reviewedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"GetSignificanceRuleDto": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"definition": {
"type": "stri
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-significancequery-v1-0-openapi.json