{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Reporting Query",
"description": "Reporting Query API is part of FenX eco-system to manage Reporting. All the operations require valid access token obtained from Identity service.",
"version": "1.0.0"
},
"servers": [
{
"url": "/reportingquery"
}
],
"paths": {
"/api/entity-report/entity-created-report": {
"post": {
"tags": [
"EntityReport"
],
"summary": "Get entities created report",
"description": "\n\r\n Returns the list of entities created within a specified date range.\nLimit: 10000 entities, for more, please use the /file API\r\n
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetEntityCreatedReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Entity report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityCreatedDtoDateRangeReportResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/entity-report/entity-created-report/file": {
"post": {
"tags": [
"EntityReport"
],
"summary": "Get entities created file report",
"description": "\nReturns the link to the file, with a list of entities created within a specified date range
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetEntityCreatedFileReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Entity report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/entity-report/entity-updated-report": {
"post": {
"tags": [
"EntityReport"
],
"summary": "Get entities updated report",
"description": "\n\r\n Returns the list of entities updated within a specified date range.\nLimit: 10000 entities, for more, please use the /file API\r\n
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetEntityUpdatedReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Entity report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityUpdatedDtoDateRangeReportResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/entity-report/entity-updated-report/file": {
"post": {
"tags": [
"EntityReport"
],
"summary": "Get entities updated file report",
"description": "\nReturns the link to the file, with a list of entities updated within a specified date range
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetEntityUpdatedFileReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Entity report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-report/journey-started-report": {
"post": {
"tags": [
"JourneyReport"
],
"summary": "Get report for journey started property",
"description": "\n\r\n Returns the list of journeys started within a specified date range.\nLimit: 10000 journeys, for more, please use the /file API\r\n
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetJourneyStartedReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Journey report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyStartedDtoDateRangeReportResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-report/journey-started-report/file": {
"post": {
"tags": [
"JourneyReport"
],
"summary": "Get file report for journey started property",
"description": "\nReturns the link to the file, with a list of journeys started within a specified date range
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetJourneyStartedFileReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Journey report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-report/journey-completed-report": {
"post": {
"tags": [
"JourneyReport"
],
"summary": "Get report for journey completed property",
"description": "\n\r\n Returns the list of journeys completed within a specified date range.\nLimit: 10000 journeys, for more, please use the /file API\r\n
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetJourneyCompletedReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Journey report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyCompletedDtoDateRangeReportResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-report/journey-completed-report/file": {
"post": {
"tags": [
"JourneyReport"
],
"summary": "Get file report for journey completed property",
"description": "\nReturns the link to the file, with a list of journeys completed within a specified date range
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetJourneyCompletedFileReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Journey report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-report/journey-updated-report": {
"post": {
"tags": [
"JourneyReport"
],
"summary": "Get report for journey updated property",
"description": "\n\r\n Returns the list of journeys updated within a specified date range.\nLimit: 10000 journeys, for more, please use the /file API\r\n
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetJourneyUpdatedReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Journey report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyUpdatedDtoDateRangeReportResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
},
"/api/journey-report/journey-updated-report/file": {
"post": {
"tags": [
"JourneyReport"
],
"summary": "Get file report for journey updated property",
"description": "\nReturns the link to the file, with a list of journeys updated within a specified date range
Required permissions:
Following permissions are required: ReportingAccess",
"operationId": "GetJourneyUpdatedFileReport",
"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": "Start and end date",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileRequestServiceRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success. Journey report for specified criteria is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DateRangeReportFileResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"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"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"DateRangeReportFileRequest": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "Start Date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"endDate": {
"type": "string",
"description": "End Date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"fileFormat": {
"$ref": "#/components/schemas/FileFormat"
}
},
"additionalProperties": false,
"description": "Request representing file report"
},
"DateRangeReportFileRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DateRangeReportFileRequest"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"DateRangeReportFileResponse": {
"type": "object",
"properties": {
"reportFileUrl": {
"type": "string",
"description": "Report File URL",
"nullable": true,
"example": "https://google.com/report.csv"
},
"count": {
"type": "integer",
"description": "Count",
"format": "int32",
"example": 23
},
"expirationDate": {
"type": "string",
"description": "Link expiration date",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
}
},
"additionalProperties": false,
"description": "Response representing file report"
},
"DateRangeReportFileResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DateRangeReportFileResponse"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"DateRangeReportRequest": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "Start Date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"endDate": {
"type": "string",
"description": "End Date",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
}
},
"additionalProperties": false,
"description": "Request representing report"
},
"DateRangeReportRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DateRangeReportRequest"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"EntityCreatedDto": {
"type": "object",
"properties": {
"createdDate": {
"type": "string",
"description": "Date the entity was created",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"legalEntityId": {
"type": "string",
"description": "Unique identifier of the entity",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"legalEntityName": {
"type": "string",
"description": "Name of the entity",
"nullable": true,
"example": "Example Entity"
},
"legalEntityType": {
"type": "string",
"description": "Type of the entity",
"nullable": true,
"example": "Company"
},
"currentLegalEntityStatus": {
"type": "string",
"description": "Current status of the entity",
"nullable": true,
"example": "Client"
},
"businessRelatedAccessLayers": {
"type": "string",
"description": "Business related access layers",
"nullable": true,
"example": "Enterprise"
},
"geographicAccessLayers": {
"type": "string",
"description": "Geographic access layers",
"nullable": true,
"example": "Global"
}
},
"additionalProperties": false
},
"EntityCreatedDtoDateRangeReportResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Count of items returned",
"format": "int32",
"readOnly": true,
"example": 22
},
"datasetSizeAccepted": {
"type": "boolean",
"description": "Boolean flag indicating if returned dataset size is appropriate",
"readOnly": true,
"example": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityCreatedDto"
},
"description": "List of !:TDto",
"nullable": true
}
},
"additionalProperties": false
},
"EntityCreatedDtoDateRangeReportResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityCreatedDtoDateRangeReportResponse"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"EntityUpdatedDto": {
"type": "object",
"properties": {
"updatedTime": {
"type": "string",
"description": "Date the entity was updated",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"eventType": {
"type": "string",
"description": "Name of the event that caused the entity to be updated",
"nullable": true,
"example": "Example Entity"
},
"entityCreatedDate": {
"type": "string",
"description": "Date the entity was created",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"legalEntityId": {
"type": "string",
"description": "Unique identifier of the entity",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"legalEntityName": {
"type": "string",
"description": "Name of the entity",
"nullable": true,
"example": "Example Entity"
},
"legalEntityType": {
"type": "string",
"description": "Type of the entity",
"nullable": true,
"example": "Company"
},
"currentLegalEntityStatus": {
"type": "string",
"description": "Current status of the entity",
"nullable": true,
"example": "Client"
},
"entityDraftId": {
"type": "string",
"description": "Unique identifier of the entity draft",
"format": "uuid",
"nullable": true,
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"businessRelatedAccessLayers": {
"type": "string",
"description": "Business related access layers",
"nullable": true,
"example": "Enterprise"
},
"geographicAccessLayers": {
"type": "string",
"description": "Geographic access layers",
"nullable": true,
"example": "Global"
}
},
"additionalProperties": false
},
"EntityUpdatedDtoDateRangeReportResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Count of items returned",
"format": "int32",
"readOnly": true,
"example": 22
},
"datasetSizeAccepted": {
"type": "boolean",
"description": "Boolean flag indicating if returned dataset size is appropriate",
"readOnly": true,
"example": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityUpdatedDto"
},
"description": "List of !:TDto",
"nullable": true
}
},
"additionalProperties": false
},
"EntityUpdatedDtoDateRangeReportResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityUpdatedDtoDateRangeReportResponse"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"FileFormat": {
"enum": [
"csv",
"json"
],
"type": "string"
},
"JourneyCompletedDto": {
"type": "object",
"properties": {
"completedTime": {
"type": "string",
"description": "Completed Time",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"startedTime": {
"type": "string",
"description": "Started Time",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"duration": {
"type": "integer",
"description": "Duration (in seconds)",
"format": "int32",
"example": 234
},
"journeyId": {
"type": "string",
"description": "Journey Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"journeyType": {
"type": "string",
"description": "Journey Type",
"nullable": true,
"example": "Client Onboarding"
},
"journeySchemaId": {
"type": "string",
"description": "Journey Schema Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"legalEntityId": {
"type": "string",
"description": "Legal Entity Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"businessRelatedAccessLayers": {
"type": "string",
"description": "Business Access Layers",
"nullable": true
},
"geographicAccessLayers": {
"type": "string",
"description": "Geographic Access Layers",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing completed journey"
},
"JourneyCompletedDtoDateRangeReportResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Count of items returned",
"format": "int32",
"readOnly": true,
"example": 22
},
"datasetSizeAccepted": {
"type": "boolean",
"description": "Boolean flag indicating if returned dataset size is appropriate",
"readOnly": true,
"example": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyCompletedDto"
},
"description": "List of !:TDto",
"nullable": true
}
},
"additionalProperties": false
},
"JourneyCompletedDtoDateRangeReportResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JourneyCompletedDtoDateRangeReportResponse"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneyStartedDto": {
"type": "object",
"properties": {
"startedTime": {
"type": "string",
"description": "Started Time",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"journeyId": {
"type": "string",
"description": "Journey Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"journeyType": {
"type": "string",
"description": "Journey Type",
"nullable": true,
"example": "Client Onboarding"
},
"currentJourneyStatus": {
"type": "string",
"description": "Journey Status - Example Values: In Progress | Completed | Cancelled",
"nullable": true,
"example": "Client Onboarding"
},
"journeySchemaId": {
"type": "string",
"description": "Journey Schema Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"legalEntityId": {
"type": "string",
"description": "Legal Entity Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"businessRelatedAccessLayers": {
"type": "string",
"description": "Business Access Layers",
"nullable": true
},
"geographicAccessLayers": {
"type": "string",
"description": "Geographic Access Layers",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing started journey"
},
"JourneyStartedDtoDateRangeReportResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Count of items returned",
"format": "int32",
"readOnly": true,
"example": 22
},
"datasetSizeAccepted": {
"type": "boolean",
"description": "Boolean flag indicating if returned dataset size is appropriate",
"readOnly": true,
"example": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyStartedDto"
},
"description": "List of !:TDto",
"nullable": true
}
},
"additionalProperties": false
},
"JourneyStartedDtoDateRangeReportResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JourneyStartedDtoDateRangeReportResponse"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"JourneyUpdatedDto": {
"type": "object",
"properties": {
"updatedTime": {
"type": "string",
"description": "Updated Time",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"eventType": {
"type": "string",
"description": "Event Type",
"nullable": true,
"example": "TaskCompleted"
},
"startedTime": {
"type": "string",
"description": "Started Time",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"journeyId": {
"type": "string",
"description": "Journey Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"journeyType": {
"type": "string",
"description": "Journey Type",
"nullable": true,
"example": "Client Onboarding"
},
"currentJourneyStatus": {
"type": "string",
"description": "Journey Status - Example Values: In Progress | Completed | Cancelled",
"nullable": true,
"example": "Client Onboarding"
},
"journeySchemaId": {
"type": "string",
"description": "Journey Schema Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"legalEntityId": {
"type": "string",
"description": "Legal Entity Id",
"format": "uuid",
"example": "8d631fde-505e-4101-a7cd-83ab6c054a5a"
},
"businessRelatedAccessLayers": {
"type": "string",
"description": "Business Access Layers",
"nullable": true
},
"geographicAccessLayers": {
"type": "string",
"description": "Geographic Access Layers",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing updated journey"
},
"JourneyUpdatedDtoDateRangeReportResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Count of items returned",
"format": "int32",
"readOnly": true,
"example": 22
},
"datasetSizeAccepted": {
"type": "boolean",
"description": "Boolean flag indicating if returned dataset size is appropriate",
"readOnly": true,
"example": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyUpdatedDto"
},
"description": "List of !:TDto",
"nullable": true
}
},
"additionalProperties": false
},
"JourneyUpdatedDtoDateRangeReportResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JourneyUpdatedDtoDateRangeReportResponse"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The message",
"nullable": true,
"example": "Success"
},
"type": {
"type": "string",
"description": "Type of the message\r\nOne of Info, Warning, Error, Forbidden",
"nullable": true,
"example": "Info"
},
"errorCode": {
"type": "string",
"description": "Error Code",
"nullable": true,
"example": "INTERNAL_SERVER_ERROR"
}
},
"additionalProperties": false,
"description": "The message associated to the service response"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}