openapi: 3.2.0 info: title: Fenergo Bulk Load API version: '1.0' description: 'Operations tagged BulkLoad across 3 of this provider''s published API definitions: fenergo-bulkloadcommand-v1-0-openapi.json, fenergo-bulkloadcommand-v2-0-openapi.json, fenergo-bulkloadquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /bulkloadcommand - url: /bulkloadquery security: - Bearer: [] tags: - name: Bulk Load paths: /api/jobs: post: tags: - Bulk Load summary: Create the bulk load job description: 'The method creates the bulk load job. Required permissions: Following permissions are required: BulkLoadAccess' operationId: CreateJob 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: The request must contain the data to create the bulk load job. content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateJobRequestServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/CreateJobRequestServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateJobRequestServiceRequest' responses: '202': description: The created bulk load job was successful. content: text/plain: schema: $ref: '#/components/schemas/StringServiceResponse' application/json: schema: $ref: '#/components/schemas/StringServiceResponse' text/json: schema: $ref: '#/components/schemas/StringServiceResponse' '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' '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 get: tags: - Bulk Load 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 summary: Get all jobs x-summary-source: derived servers: - url: /bulkloadcommand /api/jobs/{id}/cancellation: post: tags: - Bulk Load summary: Cancel the bulk load job description: 'The method cancels the bulk load job. Required permissions: Following permissions are required: BulkLoadAccess' operationId: CancelJob parameters: - name: id in: path description: The Bulk Load Job id to be cancelled 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: '202': description: The created bulk load job was successful. content: text/plain: schema: $ref: '#/components/schemas/StringServiceResponse' application/json: schema: $ref: '#/components/schemas/StringServiceResponse' text/json: schema: $ref: '#/components/schemas/StringServiceResponse' '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' '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 servers: - url: /bulkloadcommand /api/jobs/{id}: post: tags: - Bulk Load summary: Update the bulk load job description: 'The method update the bulk load job. Required permissions: Following permissions are required: BulkLoadAccess' operationId: UpdateJob parameters: - name: id in: path description: The Bulk Load Job id to be update 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 requestBody: description: The request must contain the data to update the bulk load job. content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateJobRequestServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateJobRequestServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateJobRequestServiceRequest' responses: '202': description: The update of uploaded by bulk load job was successful. content: text/plain: schema: $ref: '#/components/schemas/StringServiceResponse' application/json: schema: $ref: '#/components/schemas/StringServiceResponse' text/json: schema: $ref: '#/components/schemas/StringServiceResponse' '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' '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 get: tags: - Bulk Load summary: Get Bulk Load Job by id description: 'This method gets the a specific bulk load job The 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 \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 servers: - url: /bulkloadcommand /api/jobs/{id}/uploadedBy: post: tags: - Bulk Load summary: Set the UploadedBy in the job description: 'The method update the UploadedBy property in the job. Required permissions: Following permissions are required: BulkLoadAccess' operationId: SetJobUploadedBy parameters: - name: id in: path description: The Job id to set the UploadedBy 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: '202': description: The update of set by bulk load job was successful. content: text/plain: schema: $ref: '#/components/schemas/StringServiceResponse' application/json: schema: $ref: '#/components/schemas/StringServiceResponse' text/json: schema: $ref: '#/components/schemas/StringServiceResponse' '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' '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 servers: - url: /bulkloadcommand /api/jobs/{jobId}/data-source-upload-signed-url/{type}: put: tags: - Bulk Load description: 'Required permissions: Following permissions are required: BulkLoadAccess' operationId: GenerateDataSourceUploadSignedUrl 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: text/plain: schema: $ref: '#/components/schemas/SignedUrlCommandDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/SignedUrlCommandDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/SignedUrlCommandDtoServiceResponse' '400': description: Bad Request 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 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 summary: Generate data source upload signed url x-summary-source: derived get: tags: - Bulk Load 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 summary: Get data source upload signed url x-summary-source: derived servers: - url: /bulkloadcommand /api/v2/jobs: post: tags: - Bulk Load summary: Create the bulk load job description: 'The method creates the bulk load job. Required permissions: Following permissions are required: BulkLoadAccess' operationId: CreateJobV2 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: The request must contain the data to create the bulk load job. content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateJobRequestServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/CreateJobRequestServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateJobRequestServiceRequest' responses: '202': description: The created bulk load job was successful. content: text/plain: schema: $ref: '#/components/schemas/StringServiceResponse' application/json: schema: $ref: '#/components/schemas/StringServiceResponse' text/json: schema: $ref: '#/components/schemas/StringServiceResponse' '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' '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 servers: - url: /bulkloadcommand /api/jobs/active: get: tags: - Bulk Load 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 summary: Get all active jobs x-summary-source: derived servers: - url: /bulkloadquery /api/jobs/{jobId}/input-template-signed-url: get: tags: - Bulk Load 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 summary: Get input template signed url x-summary-source: derived servers: - url: /bulkloadquery /api/jobs/{jobId}/error-file-signed-url: get: tags: - Bulk Load 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 summary: Get error file signed url x-summary-source: derived servers: - url: /bulkloadquery /api/jobs/{jobId}/ingestion-report-signed-url: get: tags: - Bulk Load 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 summary: Get ingestion report signed url x-summary-source: derived servers: - url: /bulkloadquery /api/jobs/{jobId}/ingestion-report: get: tags: - Bulk Load 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 summary: Get ingestion report x-summary-source: derived servers: - url: /bulkloadquery /api/jobs/{jobId}/upserts: get: tags: - Bulk Load 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 summary: Get upserts x-summary-source: derived servers: - url: /bulkloadquery components: schemas: UpdateJobRequestServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateJobRequest' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SignedUrlCommandDto: type: object properties: url: type: - string - 'null' additionalProperties: false CreateJobRequest: required: - name - sourcePolicyId type: object properties: name: minLength: 1 type: string description: Name of create the bulk load job example: Global sourcePolicyId: minLength: 1 type: string description: SourcePolicyId to create the bulk load job example: Global type: type: - string - 'null' description: TThe type of the job example: Agency additionalProperties: false UpdateJobRequest: type: object properties: uploadedFileName: type: - string - 'null' description: Uploaded file name example: data.xlsx additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false CreateJobRequestServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateJobRequest' additionalProperties: false SignedUrlCommandDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SignedUrlCommandDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateJobRequest_2: required: - name - sourceEntityDataPolicyId type: object properties: name: minLength: 1 type: string description: Name of create the bulk load job example: Global sourceEntityDataPolicyId: type: string description: SourceEntityDataPolicyId is the EntityData policy to create the bulk load job format: uuid example: Global sourceProductPolicyId: type: - string - 'null' description: SourceProductPolicyId is the Product policy to create the bulk load job format: uuid example: Global type: type: - string - 'null' description: The type of the request example: Agency entityCreateJourneyType: type: - string - 'null' description: Journey type used during the creation of entities entityUpdateJourneyType: type: - string - 'null' description: Journey type used during the update of entities additionalProperties: false EntityDataPolicyReference: type: object properties: id: type: string format: uuid jurisdiction: type: - string - 'null' sourceId: type: string format: uuid name: type: - string - 'null' versionId: type: - string - 'null' format: uuid versionNumber: type: integer format: int32 additionalProperties: false JobType: enum: - 0 - 1 type: integer format: int32 NebulaDomain: enum: - 1 - 2 - 3 - 4 type: integer format: int32 UpsertError: type: object properties: id: type: string format: uuid message: type: - string - 'null' createdDate: type: string format: date-time jobId: type: string format: uuid job: allOf: - $ref: '#/components/schemas/Job' upsertId: type: string format: uuid upsert: allOf: - $ref: '#/components/schemas/Upsert' additionalProperties: false JobDtoArrayServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/JobDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false JobDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JobDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false JobDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' createdDate: type: string format: date-time completedDate: type: - string - 'null' format: date-time sourcePolicyId: type: string format: uuid sourceProductPolicyId: type: - string - 'null' format: uuid uploadedBy: type: - string - 'null' createdBy: type: - string - 'null' stateKey: type: - string - 'null' stateExecutionStatusKey: type: - string - 'null' sourcePolicyName: type: - string - 'null' sourceProductPolicyName: type: - string - 'null' uploadedFileName: type: - string - 'null' type: allOf: - $ref: '#/components/schemas/JobType' entityCreateJourneyType: type: - string - 'null' entityUpdateJourneyType: type: - string - 'null' additionalProperties: false SignedUrlQueryDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SignedUrlQueryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Upsert: type: object properties: id: type: string format: uuid referenceId: type: - string - 'null' domain: allOf: - $ref: '#/components/schemas/NebulaDomain' tableName: type: - string - 'null' tags: type: - string - 'null' payload: type: - string - 'null' createdDate: type: string format: date-time fenxId: type: - string - 'null' format: uuid stateKey: type: - string - 'null' updatedDate: type: string format: date-time journeyIds: type: - string - 'null' rootEntityId: type: - string - 'null' format: uuid deprecated: true rootUpsertId: type: - string - 'null' format: uuid deprecated: true jobId: type: string format: uuid job: allOf: - $ref: '#/components/schemas/Job' errors: type: - array - 'null' items: $ref: '#/components/schemas/UpsertError' additionalProperties: false StateExecution: type: object properties: id: type: string format: uuid stateKey: type: - string - 'null' statusKey: type: - string - 'null' startDate: type: string format: date-time stopDate: type: - string - 'null' format: date-time createdDate: type: string format: date-time updatedDate: type: string format: date-time jobId: type: string format: uuid job: allOf: - $ref: '#/components/schemas/Job' additionalProperties: false IngestionReportDtoArrayServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/IngestionReportDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PreSignedUrlFileType: enum: - 1 type: integer format: int32 Job: type: object properties: id: type: string format: uuid name: type: - string - 'null' createdDate: type: string format: date-time completedDate: type: - string - 'null' format: date-time updatedBy: type: - string - 'null' createdBy: type: - string - 'null' uploadedFileName: type: - string - 'null' type: allOf: - $ref: '#/components/schemas/JobType' entityCreateJourneyType: type: - string - 'null' entityUpdateJourneyType: type: - string - 'null' stateMachineExecutionArn: type: - string - 'null' currentStateExecutionId: type: - string - 'null' format: uuid requirementSetId: type: - string - 'null' format: uuid currentStateExecution: allOf: - $ref: '#/components/schemas/StateExecution' requirementSet: allOf: - $ref: '#/components/schemas/RequirementSet' stateExecutions: type: - array - 'null' items: $ref: '#/components/schemas/StateExecution' upserts: type: - array - 'null' items: $ref: '#/components/schemas/Upsert' errors: type: - array - 'null' items: $ref: '#/components/schemas/JobError' preSignedUrlExecutions: type: - array - 'null' items: $ref: '#/components/schemas/PreSignedUrlExecution' additionalProperties: false RequirementSet: type: object properties: id: type: string format: uuid jobId: type: string format: uuid inputFileId: type: - string - 'null' format: uuid entityDataPolicyReferenceId: type: string format: uuid productPolicyReferenceId: type: - string - 'null' format: uuid job: allOf: - $ref: '#/components/schemas/Job' inputFile: allOf: - $ref: '#/components/schemas/InputFile' entityDataPolicyReference: allOf: - $ref: '#/components/schemas/EntityDataPolicyReference' productPolicyReference: allOf: - $ref: '#/components/schemas/ProductPolicyReference' additionalProperties: false GetUpsertsResultServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetUpsertsResult' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false InputFile: type: object properties: id: type: string format: uuid jobId: type: string format: uuid job: allOf: - $ref: '#/components/schemas/Job' additionalProperties: false ProductPolicyReference: type: object properties: id: type: string format: uuid jurisdiction: type: - string - 'null' sourceId: type: string format: uuid name: type: - string - 'null' versionId: type: - string - 'null' format: uuid versionNumber: type: integer format: int32 additionalProperties: false JobError: type: object properties: id: type: string format: uuid message: type: - string - 'null' createdDate: type: string format: date-time jobId: type: string format: uuid job: allOf: - $ref: '#/components/schemas/Job' additionalProperties: false PreSignedUrlExecution: type: object properties: id: type: string format: uuid createdDate: type: string format: date-time consumedDate: type: - string - 'null' format: date-time createdBy: type: - string - 'null' preSignedUrl: type: - string - 'null' fileType: allOf: - $ref: '#/components/schemas/PreSignedUrlFileType' isExpired: type: boolean jobId: type: string format: uuid job: allOf: - $ref: '#/components/schemas/Job' additionalProperties: false IngestionReportDto: type: object properties: table: type: - string - 'null' referenceId: type: - string - 'null' entityId: type: - string - 'null' format: uuid associationId: type: - string - 'null' format: uuid productId: type: - string - 'null' format: uuid journeyIds: type: - array - 'null' items: type: string additionalProperties: false GetUpsertsResult: type: object properties: count: type: integer format: int32 readOnly: true items: type: - array - 'null' items: $ref: '#/components/schemas/Upsert' additionalProperties: false SignedUrlQueryDto: type: object properties: url: type: - string - 'null' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-bulkloadcommand-v1-0-openapi.json - fenergo-bulkloadcommand-v2-0-openapi.json - fenergo-bulkloadquery-v1-0-openapi.json