{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula BulkLoad Query", "description": "**BulkLoad Query API**:


BulkLoad Query API provides endpoints in order to retrieve all related models and their versions.


**BulkLoad Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/bulkloadquery" } ], "paths": { "/api/jobs": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetAllJobs", "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDtoArrayServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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/jobs/active": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetAllActiveJobs", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDtoArrayServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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" } ] } } } } } } }, "/api/jobs/{id}": { "get": { "tags": [ "BulkLoad" ], "summary": "Get Bulk Load Job by id", "description": "\nThis method gets the a specific bulk load job\r\n\nThe tenant id is mandatory and should be included as the header X-TENANT-ID

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetJob", "parameters": [ { "name": "id", "in": "path", "description": "Id of an existing migration", "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": "An instance of the Fenergo.Nebula.BulkLoad.Query.Application.Dto.JobDto class representing the migration metadata with the specified \r\n id, if found; otherwise, `null`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/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", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server error" }, "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" } ] } } } }, "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/jobs/{jobId}/input-template-signed-url": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetInputTemplateSignedUrl", "parameters": [ { "name": "jobId", "in": "path", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlQueryDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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" } ] } } } } } } }, "/api/jobs/{jobId}/error-file-signed-url": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetErrorFileSignedUrl", "parameters": [ { "name": "jobId", "in": "path", "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": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlQueryDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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" } ] } } } } } } }, "/api/jobs/{jobId}/data-source-upload-signed-url/{type}": { "get": { "tags": [ "BulkLoad" ], "description": "This endpoint is obsolete and was terminated on 2023-11-23. This endpoint will discontinued at 2023-11-23, please refer to the command endpoint 'jobs/{jobId}/data-source-upload-signed-url/{type}' instead


Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetDataSourceUploadSignedUrl", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUrlQueryDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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" } ] } } } } }, "deprecated": true } }, "/api/jobs/{jobId}/ingestion-report-signed-url": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetIngestionReportSignedUrl", "parameters": [ { "name": "jobId", "in": "path", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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" } ] } } } } } } }, "/api/jobs/{jobId}/ingestion-report": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetIngestionReport", "parameters": [ { "name": "jobId", "in": "path", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestionReportDtoArrayServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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" } ] } } } } } } }, "/api/jobs/{jobId}/upserts": { "get": { "tags": [ "BulkLoad" ], "description": "

Required permissions:
Following permissions are required: BulkLoadAccess", "operationId": "GetUpserts", "parameters": [ { "name": "jobId", "in": "path", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUpsertsResultServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/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", "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": { "EntityDataPolicyReference": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jurisdiction": { "type": "string", "nullable": true }, "sourceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "versionId": { "type": "string", "format": "uuid", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetUpsertsResult": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Upsert" }, "nullable": true } }, "additionalProperties": false }, "GetUpsertsResultServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetUpsertsResult" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "IngestionReportDto": { "type": "object", "properties": { "table": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid", "nullable": true }, "associationId": { "type": "string", "format": "uuid", "nullable": true }, "productId": { "type": "string", "format": "uuid", "nullable": true }, "journeyIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "IngestionReportDtoArrayServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IngestionReportDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "InputFile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jobId": { "type": "string", "format": "uuid" }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "nullable": true } }, "additionalProperties": false }, "Job": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "uploadedFileName": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/JobType" } ] }, "entityCreateJourneyType": { "type": "string", "nullable": true }, "entityUpdateJourneyType": { "type": "string", "nullable": true }, "stateMachineExecutionArn": { "type": "string", "nullable": true }, "currentStateExecutionId": { "type": "string", "format": "uuid", "nullable": true }, "requirementSetId": { "type": "string", "format": "uuid", "nullable": true }, "currentStateExecution": { "allOf": [ { "$ref": "#/components/schemas/StateExecution" } ], "nullable": true }, "requirementSet": { "allOf": [ { "$ref": "#/components/schemas/RequirementSet" } ], "nullable": true }, "stateExecutions": { "type": "array", "items": { "$ref": "#/components/schemas/StateExecution" }, "nullable": true }, "upserts": { "type": "array", "items": { "$ref": "#/components/schemas/Upsert" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/JobError" }, "nullable": true }, "preSignedUrlExecutions": { "type": "array", "items": { "$ref": "#/components/schemas/PreSignedUrlExecution" }, "nullable": true } }, "additionalProperties": false }, "JobDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "sourcePolicyId": { "type": "string", "format": "uuid" }, "sourceProductPolicyId": { "type": "string", "format": "uuid", "nullable": true }, "uploadedBy": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "stateKey": { "type": "string", "nullable": true }, "stateExecutionStatusKey": { "type": "string", "nullable": true }, "sourcePolicyName": { "type": "string", "nullable": true }, "sourceProductPolicyName": { "type": "string", "nullable": true }, "uploadedFileName": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/JobType" } ] }, "entityCreateJourneyType": { "type": "string", "nullable": true }, "entityUpdateJourneyType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JobDtoArrayServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "JobDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JobDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "JobError": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "message": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "jobId": { "type": "string", "format": "uuid" }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "nullable": true } }, "additionalProperties": false }, "JobType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "NebulaDomain": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PreSignedUrlExecution": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdDate": { "type": "string", "format": "date-time" }, "consumedDate": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "preSignedUrl": { "type": "string", "nullable": true }, "fileType": { "allOf": [ { "$ref": "#/components/schemas/PreSignedUrlFileType" } ] }, "isExpired": { "type": "boolean" }, "jobId": { "type": "string", "format": "uuid" }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "nullable": true } }, "additionalProperties": false }, "PreSignedUrlFileType": { "enum": [ 1 ], "type": "integer", "format": "int32" }, "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": { } }, "ProductPolicyReference": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jurisdiction": { "type": "string", "nullable": true }, "sourceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "versionId": { "type": "string", "format": "uuid", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RequirementSet": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jobId": { "type": "string", "format": "uuid" }, "inputFileId": { "type": "string", "format": "uuid", "nullable": true }, "entityDataPolicyReferenceId": { "type": "string", "format": "uuid" }, "productPolicyReferenceId": { "type": "string", "format": "uuid", "nullable": true }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "nullable": true }, "inputFile": { "allOf": [ { "$ref": "#/components/schemas/InputFile" } ], "nullable": true }, "entityDataPolicyReference": { "allOf": [ { "$ref": "#/components/schemas/EntityDataPolicyReference" } ], "nullable": true }, "productPolicyReference": { "allOf": [ { "$ref": "#/components/schemas/ProductPolicyReference" } ], "nullable": true } }, "additionalProperties": false }, "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 }, "SignedUrlQueryDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SignedUrlQueryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SignedUrlQueryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StateExecution": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "stateKey": { "type": "string", "nullable": true }, "statusKey": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "stopDate": { "type": "string", "format": "date-time", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time" }, "jobId": { "type": "string", "format": "uuid" }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "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 }, "Upsert": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "referenceId": { "type": "string", "nullable": true }, "domain": { "allOf": [ { "$ref": "#/components/schemas/NebulaDomain" } ] }, "tableName": { "type": "string", "nullable": true }, "tags": { "type": "string", "nullable": true }, "payload": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "fenxId": { "type": "string", "format": "uuid", "nullable": true }, "stateKey": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time" }, "journeyIds": { "type": "string", "nullable": true }, "rootEntityId": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true }, "rootUpsertId": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true }, "jobId": { "type": "string", "format": "uuid" }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UpsertError" }, "nullable": true } }, "additionalProperties": false }, "UpsertError": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "message": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "jobId": { "type": "string", "format": "uuid" }, "job": { "allOf": [ { "$ref": "#/components/schemas/Job" } ], "nullable": true }, "upsertId": { "type": "string", "format": "uuid" }, "upsert": { "allOf": [ { "$ref": "#/components/schemas/Upsert" } ], "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }