{
  "openapi": "3.0.1",
  "info": {
    "title": "Fenergo Nebula BulkLoad Command",
    "description": "**BulkLoad Command API**:<br/><br/><br/> BulkLoad Command API provides endpoints that allow to load multiple entities into the system with a single action.<br/><br/><br/> **BulkLoad Command API provides**:<br/><ul><li> The ability to create, update and delete BulkLoad Jobs.</li></ul>",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "/bulkloadcommand"
    }
  ],
  "paths": {
    "/api/v2/jobs": {
      "post": {
        "tags": [
          "BulkLoad"
        ],
        "summary": "Create the bulk load job",
        "description": "\nThe method creates the bulk load job.<br /><br /><b>Required permissions:</b><br />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"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CreateJobRequest": {
        "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",
            "description": "SourceProductPolicyId is the Product policy to create the bulk load job",
            "format": "uuid",
            "nullable": true,
            "example": "Global"
          },
          "type": {
            "type": "string",
            "description": "The type of the request",
            "nullable": true,
            "example": "Agency"
          },
          "entityCreateJourneyType": {
            "type": "string",
            "description": "Journey type used during the creation of entities",
            "nullable": true
          },
          "entityUpdateJourneyType": {
            "type": "string",
            "description": "Journey type used during the update of entities",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CreateJobRequestServiceRequest": {
        "type": "object",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateJobRequest"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ObjectServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "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
      },
      "StringServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "description": "Please insert JWT with Bearer into field",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": [ ]
    }
  ]
}