{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Business Metrics Command", "description": "**Business Metrics Command API**:


Business Metrics Command API provides endpoints in order to manage and configure all related models and their versions.

", "version": "1.0.0" }, "servers": [ { "url": "/businessmetricscommand" } ], "paths": { "/api/assumptions": { "put": { "tags": [ "Assumptions" ], "summary": "Save or update ROI assumptions for the current tenant", "description": "

Required permissions:
Following permissions are required: ValueStoryEdit", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Upsert assumptions request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpsertTenantAssumptionsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpsertTenantAssumptionsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpsertTenantAssumptionsRequestDtoServiceRequest" } ] } } }, "required": true }, "responses": { "204": { "description": "Success. Assumptions were saved" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } }, "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" } ] } } } } } } }, "/api/journeysummary": { "post": { "tags": [ "JourneySummary" ], "summary": "Create a Journey Summary", "description": "", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Create Journey Summary request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TriggerJourneySummaryRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TriggerJourneySummaryRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TriggerJourneySummaryRequestDtoServiceRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TriggerJourneySummaryResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TriggerJourneySummaryResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TriggerJourneySummaryResponseDtoServiceResponse" } } } }, "202": { "description": "Success. Journey Summary request was accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } }, "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" } ] } } } } } } }, "/api/journeysummary/triggerscheduledsummaries": { "post": { "tags": [ "JourneySummary" ], "summary": "Trigger the creation of a Journey Summary for all currently scheduled journeys", "description": "", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "responses": { "202": { "description": "Success. Trigger scheduled summaries request was accepted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } }, "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" } ] } } } } } } }, "/api/qafindings": { "patch": { "tags": [ "QaFindings" ], "summary": "Update a QA finding's status (and optionally severity) for the current tenant", "description": "

Required permissions:
Following permissions are required: ValueStoryEdit", "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" }, { "name": "X-CORRELATION-ID", "in": "header", "description": "The UiD of the correlation id", "schema": { "type": "string" }, "example": "fee5b5f5-b220-4fef-ba38-bf802b98d74d" } ], "requestBody": { "description": "Update QA finding status request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateQaFindingStatusRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateQaFindingStatusRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateQaFindingStatusRequestDtoServiceRequest" } ] } } }, "required": true }, "responses": { "204": { "description": "Success. The finding was updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not found. No finding exists with the given Id for this tenant", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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" } ] } } } }, "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": { "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "TriggerJourneySummaryRequestDto": { "type": "object", "properties": { "journeyIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TriggerJourneySummaryRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TriggerJourneySummaryRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "TriggerJourneySummaryResponseDto": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "journeyIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TriggerJourneySummaryResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TriggerJourneySummaryResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateQaFindingStatusRequestDto": { "type": "object", "properties": { "findingId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateQaFindingStatusRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateQaFindingStatusRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "UpsertTenantAssumptionsRequestDto": { "type": "object", "properties": { "hourlyRate": { "type": "number", "format": "double" }, "docMinutes": { "type": "integer", "format": "int32" }, "screenMinutes": { "type": "integer", "format": "int32" }, "autoMinutes": { "type": "integer", "format": "int32" }, "reportMinutes": { "type": "integer", "format": "int32" }, "sourceMinutes": { "type": "integer", "format": "int32" }, "policyMinutes": { "type": "integer", "format": "int32" }, "productiveHoursPerMonth": { "type": "integer", "format": "int32" }, "signalMinutes": { "type": "integer", "format": "int32" }, "alertHighScoreThreshold": { "type": "integer", "format": "int32" }, "alertMediumScoreThreshold": { "type": "integer", "format": "int32" }, "onboardingSlaTargetPercent": { "type": "number", "format": "double", "nullable": true }, "periodicReviewSlaTargetPercent": { "type": "number", "format": "double", "nullable": true }, "maintenanceSlaTargetPercent": { "type": "number", "format": "double", "nullable": true }, "annualSubscriptionCost": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "UpsertTenantAssumptionsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpsertTenantAssumptionsRequestDto" } ], "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }