POST api/SQLStep

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FormDataModel	FormDataModel	None.
Transaction	Transaction	None.
OutputStepSettings	Collection of Object	None.
TransactionDocument	Collection of byte	None.
Settings	Settings	None.
FormSettings	Collection of Object	None.
ConnectionString	string	None.
CurrentUserEmail	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FormDataModel": {
    "UserID": "sample string 1",
    "BranchID": 1,
    "FormName": "sample string 2",
    "FormPath": "sample string 3",
    "JSON": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "FormFiles": [
      {
        "fileExt": "sample string 1",
        "ClientSideID": "sample string 2",
        "Complete": true,
        "name": "sample string 4",
        "value": "sample string 5"
      },
      {
        "fileExt": "sample string 1",
        "ClientSideID": "sample string 2",
        "Complete": true,
        "name": "sample string 4",
        "value": "sample string 5"
      }
    ],
    "CollectionJSON": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "FileUploadTags": [
      "sample string 1",
      "sample string 2"
    ],
    "Html": "sample string 4",
    "TransactionDocumentID": "sample string 5",
    "UniqueTransactionID": "sample string 6",
    "ClientSideID": "sample string 7",
    "ExternalTenantID": 8,
    "EmailWorkFlows": [
      {
        "ToAddresses": [
          "sample string 1",
          "sample string 2"
        ],
        "SubjectLine": "sample string 1",
        "Body": "sample string 2",
        "DocumentsToSend": "sample string 3"
      },
      {
        "ToAddresses": [
          "sample string 1",
          "sample string 2"
        ],
        "SubjectLine": "sample string 1",
        "Body": "sample string 2",
        "DocumentsToSend": "sample string 3"
      }
    ],
    "Synced": true,
    "AttachmentsInBackground": true,
    "NumberOfAttachments": 11
  },
  "Transaction": {
    "_id": "sample string 1",
    "IsTransaction": true,
    "FormName": "sample string 3",
    "FormPath": "sample string 4",
    "TenantID": 5,
    "UserID": "sample string 6",
    "BranchID": 7,
    "TransactionID": "sample string 8",
    "Json": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "DateCreated": "2025-11-24T04:07:58.2129369+02:00",
    "DateModified": "2025-11-24T04:07:58.2129369+02:00",
    "Status": "sample string 11",
    "DownloadReady": true,
    "ClientSideID": "sample string 13",
    "NoView": true,
    "Synced": true,
    "SupportingDocuments": [
      {
        "DocumentID": "sample string 1",
        "TransactionDocumentID": "sample string 2",
        "FileExtension": "sample string 3",
        "TransactionID": "sample string 4",
        "DocumentName": "sample string 5",
        "DownloadReady": true
      },
      {
        "DocumentID": "sample string 1",
        "TransactionDocumentID": "sample string 2",
        "FileExtension": "sample string 3",
        "TransactionID": "sample string 4",
        "DocumentName": "sample string 5",
        "DownloadReady": true
      }
    ]
  },
  "OutputStepSettings": null,
  "TransactionDocument": "QEA=",
  "Settings": {
    "FtpConfig": {
      "Host": "sample string 1",
      "Username": "sample string 2",
      "Password": "sample string 3",
      "PortNumber": 4,
      "RootDirectoryName": "sample string 5",
      "UseSSL": true
    },
    "DefaultUser": {
      "DefaultUsername": "sample string 1",
      "DefaultEmail": "sample string 2",
      "DefaultPassword": "sample string 3",
      "TenantID": 4
    },
    "MongoConfig": {
      "host": "sample string 1",
      "username": "sample string 2",
      "password": "sample string 3",
      "port": 4,
      "UseSsl": true,
      "Collections": {
        "DataCollection": "sample string 1"
      },
      "Database": "sample string 6",
      "localDBMongo": null
    },
    "PdfConfig": {
      "BaseUrl": "sample string 1",
      "ServiceIPAddress": "sample string 2",
      "ServicePort": 3
    },
    "DefaultTenant": {
      "ID": 1,
      "Name": "sample string 2",
      "DefaultRole": "sample string 3",
      "Forms": [
        {
          "Name": "sample string 1",
          "Path": "sample string 2",
          "LogoPath": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Path": "sample string 2",
          "LogoPath": "sample string 3"
        }
      ]
    },
    "DocumentsConfig": {
      "RootPath": "sample string 1",
      "AccountName": "sample string 2",
      "Key": "sample string 3"
    },
    "HostingEnvironMent": null,
    "ApiConfig": {
      "ApiUrl": "sample string 1",
      "PostID": "sample string 2"
    }
  },
  "FormSettings": null,
  "ConnectionString": "sample string 1",
  "CurrentUserEmail": "sample string 2"
}

text/html

Sample:

{"FormDataModel":{"UserID":"sample string 1","BranchID":1,"FormName":"sample string 2","FormPath":"sample string 3","JSON":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}],"FormFiles":[{"fileExt":"sample string 1","ClientSideID":"sample string 2","Complete":true,"name":"sample string 4","value":"sample string 5"},{"fileExt":"sample string 1","ClientSideID":"sample string 2","Complete":true,"name":"sample string 4","value":"sample string 5"}],"CollectionJSON":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}],"FileUploadTags":["sample string 1","sample string 2"],"Html":"sample string 4","TransactionDocumentID":"sample string 5","UniqueTransactionID":"sample string 6","ClientSideID":"sample string 7","ExternalTenantID":8,"EmailWorkFlows":[{"ToAddresses":["sample string 1","sample string 2"],"SubjectLine":"sample string 1","Body":"sample string 2","DocumentsToSend":"sample string 3"},{"ToAddresses":["sample string 1","sample string 2"],"SubjectLine":"sample string 1","Body":"sample string 2","DocumentsToSend":"sample string 3"}],"Synced":true,"AttachmentsInBackground":true,"NumberOfAttachments":11},"Transaction":{"_id":"sample string 1","IsTransaction":true,"FormName":"sample string 3","FormPath":"sample string 4","TenantID":5,"UserID":"sample string 6","BranchID":7,"TransactionID":"sample string 8","Json":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}],"DateCreated":"2025-11-24T04:07:58.2129369+02:00","DateModified":"2025-11-24T04:07:58.2129369+02:00","Status":"sample string 11","DownloadReady":true,"ClientSideID":"sample string 13","NoView":true,"Synced":true,"SupportingDocuments":[{"DocumentID":"sample string 1","TransactionDocumentID":"sample string 2","FileExtension":"sample string 3","TransactionID":"sample string 4","DocumentName":"sample string 5","DownloadReady":true},{"DocumentID":"sample string 1","TransactionDocumentID":"sample string 2","FileExtension":"sample string 3","TransactionID":"sample string 4","DocumentName":"sample string 5","DownloadReady":true}]},"OutputStepSettings":null,"TransactionDocument":"QEA=","Settings":{"FtpConfig":{"Host":"sample string 1","Username":"sample string 2","Password":"sample string 3","PortNumber":4,"RootDirectoryName":"sample string 5","UseSSL":true},"DefaultUser":{"DefaultUsername":"sample string 1","DefaultEmail":"sample string 2","DefaultPassword":"sample string 3","TenantID":4},"MongoConfig":{"host":"sample string 1","username":"sample string 2","password":"sample string 3","port":4,"UseSsl":true,"Collections":{"DataCollection":"sample string 1"},"Database":"sample string 6","localDBMongo":null},"PdfConfig":{"BaseUrl":"sample string 1","ServiceIPAddress":"sample string 2","ServicePort":3},"DefaultTenant":{"ID":1,"Name":"sample string 2","DefaultRole":"sample string 3","Forms":[{"Name":"sample string 1","Path":"sample string 2","LogoPath":"sample string 3"},{"Name":"sample string 1","Path":"sample string 2","LogoPath":"sample string 3"}]},"DocumentsConfig":{"RootPath":"sample string 1","AccountName":"sample string 2","Key":"sample string 3"},"HostingEnvironMent":null,"ApiConfig":{"ApiUrl":"sample string 1","PostID":"sample string 2"}},"FormSettings":null,"ConnectionString":"sample string 1","CurrentUserEmail":"sample string 2"}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SQLOutputRequest'.

Response Information

Resource Description

None.