{
  "openapi": "3.0.4",
  "info": {
    "title": "Fenergo Nebula ConfigBaseline Command",
    "description": "**ConfigBaseline Command API**:<br/><br/><br/> ConfigBaseline Command API is part of FenX eco-system to manage configuration baseline.<br/><br/><br/> **ConfigBaseline Command API provides**:<br/><ul><li>The ability to create Baselines Reference.</li></ul>",
    "version": "1.7.2"
  },
  "servers": [
    {
      "url": "/configbaselinecommand"
    }
  ],
  "paths": {
    "/api/baselines-reference": {
      "post": {
        "tags": [
          "BaselineReference"
        ],
        "summary": "Create baselines reference for journey instance",
        "description": "\nCreates a new baselines reference for journey instance.<br /><br /><b>Required permissions:</b><br />Following permissions are required: ConfigBaselineEdit",
        "operationId": "CreateBaselinesReference",
        "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": "Create baselines reference request",
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CreateBaselinesReferenceDtoServiceRequest"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Success. Baselines reference created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BaselinesReferenceCreatedDtoServiceResponse"
                }
              }
            }
          },
          "404": {
            "description": "Resource not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectServiceResponse"
                },
                "example": {
                  "data": { },
                  "messages": [
                    {
                      "message": "Resource not found. There are no baselines that can be used in a Baselines Reference.",
                      "type": "Error",
                      "errorCode": "Error Code"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request. The request has missing/invalid values",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
                }
              }
            }
          },
          "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": {
      "BaselinesReferenceCreatedDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Baselines reference identifier",
            "format": "uuid",
            "example": "ef1a9f87-e951-40d8-900a-cde68eef33b2"
          }
        },
        "additionalProperties": false,
        "description": "Response DTO representing information about created baselines reference"
      },
      "BaselinesReferenceCreatedDtoServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BaselinesReferenceCreatedDto"
              }
            ],
            "description": "Response DTO representing information about created baselines reference",
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CreateBaselinesReferenceDto": {
        "required": [
          "journeyInstanceId"
        ],
        "type": "object",
        "properties": {
          "journeyInstanceId": {
            "minLength": 1,
            "type": "string",
            "description": "Journey instance identifier",
            "format": "uuid",
            "example": "26197110-20ab-406f-b780-33ebb5a9da11"
          },
          "entityId": {
            "type": "string",
            "description": "Entity identifier",
            "format": "uuid",
            "nullable": true,
            "example": "26197110-20ab-406f-b780-33ebb5a9da11"
          }
        },
        "additionalProperties": false,
        "description": "Request DTO representing baselines reference to create"
      },
      "CreateBaselinesReferenceDtoServiceRequest": {
        "type": "object",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateBaselinesReferenceDto"
              }
            ],
            "description": "Request DTO representing baselines reference to create",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ObjectServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": { }
      },
      "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
      },
      "ValidationErrorModel": {
        "type": "object",
        "properties": {
          "propertyName": {
            "type": "string",
            "nullable": true
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "attemptedValue": {
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ValidationErrorModelListServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValidationErrorModel"
            },
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false,
        "example": {
          "data": [
            {
              "propertyName": "data",
              "errorMessage": "Data is required",
              "attemptedValue": "",
              "errorCode": "NotNullValidator"
            }
          ],
          "messages": [
            {
              "message": "Data is required",
              "type": "Error",
              "errorCode": "Error Code"
            }
          ]
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "description": "Please insert JWT with Bearer into field",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": [ ]
    }
  ]
}