Submitting a form with an file attachment

In this example, we demonstrate how to submit a form that includes a file attachment using the OneEntry API.

✅ Purpose of the scenario:

• Get form configuration from OneEntry Platform
• The user fills out a form (e.g. response, feedback).
• Attaches a file (image, resume, document).
• The data and file are stored together in FormData
• Submit the collected data to an OneEntry API.

✅ What you need:

• A valid PROJECT_URL and APP_TOKEN for authentication with the OneEntry API.
• Form in OneEntry with a field of type "File" (type file)
• Form marker (eg resume_form)

📌 Important:

• These examples do not include error handling.
• You can manage errors using a try-catch block or by employing a construction like await Promise.catch((error) => error).

Scenario

1. Import defineOneEntry from SDK and define url and token

Example:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Creating an API client with defineOneEntry() function

Example:

const { Forms, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Get form by marker from OneEntry

Example:

const fileForm = await Forms.getFormByMarker('file');

Result:

{
  "id": 8,
  "attributeSetId": 11,
  "type": "data",
  "localizeInfos": {
    "title": "File",
    "titleForSite": "",
    "successMessage": "Successful data processing",
    "unsuccessMessage": "Unsuccessful data processing",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 0,
  "position": 1,
  "identifier": "file",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "file",
      "marker": "file",
      "isLogin": null,
      "isSignUp": null,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "File"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "image",
      "marker": "image",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Image"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "groupOfImages",
      "marker": "images_group",
      "isLogin": null,
      "isSignUp": null,
      "position": 3,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Images group"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ],
  "moduleFormConfigs": [
    {
      "id": 3,
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "viewOnlyUserData": false,
      "commentOnlyUserData": false,
      "entityIdentifiers": [
        {
          "id": "services",
          "isNested": false
        }
      ]
    }
  ]
}

4. Get additional settings for the form submission

Example:

const moduleFormConfig = fileForm?.moduleFormConfigs?.[0];

5. Uploading a file with form input=file

Send

Data:

// JS
let selectedFiles = null;

// handleFileChange
const handleFileChange = (e: any) => {
  selectedFiles = e.target.files;
};

// handleSubmit
const handleSubmit = async (e, file) => {
  e.preventDefault();

  // 4. Get additional settings for the form submission
  const moduleFormConfig = fileForm?.moduleFormConfigs?.[0];

  // 5. Preparing form data
  const formData = [
    {
      marker: 'file',
      type: 'file',
      value: file,
      fileQuery: {
        type: 'page',
        entity: 'editor',
        id: 4965,
      },
    },
  ];

  // 6. Submitting a form with FormData.postFormsData()
  const postFormResp = await FormData.postFormsData({
    formIdentifier: 'file',
    formData: formData,
    formModuleConfigId: moduleFormConfig?.id || 0,
    moduleEntityIdentifier: moduleFormConfig?.entityIdentifiers?.[0]?.id || '',
    replayTo: null,
    status: 'sent',
  });
};

Example:

// HTML
<form
  onSubmit={(e) => handleSubmit(e, selectedFiles)}
  className="flex flex-col gap-3 p-10 border rounded-3xl"
>
  <input
    type="file"
    onChange={handleFileChange}
    className="bg-white text-slate-800 p-3 rounded-2xl"
  />
  <button
    type="submit"
    className="bg-white text-slate-800 p-3 rounded-2xl"
  >
    Send
  </button>
</form>

Result:

{
  "formData": {
    "formIdentifier": "file",
    "time": "2025-11-10T06:30:56.488Z",
    "formData": [
      {
        "marker": "file",
        "type": "file",
        "value": [
          {
            "filename": "files/project/page/4965/editor/4f82c7e0-b1c5-4144-b7dc-202e3b50d357.json",
            "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/page/4965/editor/4f82c7e0-b1c5-4144-b7dc-202e3b50d357.json",
            "size": 259391
          }
        ]
      }
    ],
    "entityIdentifier": "services",
    "fingerprint": "UQ_rrofe2",
    "isUserAdmin": false,
    "formModuleId": 3,
    "userIdentifier": null,
    "parentId": null,
    "id": 119
  },
  "actionMessage": "Successful data processing"
}

Final example

// 1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Creating an API client 
const { Forms, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Get form by marker from OneEntry
const fileForm = await Forms.getFormByMarker('file');

// 3.1 Uploading a file with form input=file
// JS
const selectedFiles = [];
const handleFileChange = (e) => {
  selectedFiles = e.target.files;
};

// handleSubmit
const handleSubmit = async (e, file) => {
  e.preventDefault();

  // 4. Get additional settings for the form submission
  const moduleFormConfig = fileForm?.moduleFormConfigs?.[0];

  // 5. Preparing form data
  const formData = [
    {
      marker: 'file',
      type: 'file',
      value: file,
      fileQuery: {
        type: 'page',
        entity: 'editor',
        id: 4965,
      },
    },
  ];

  // 6. Submitting a form with FormData.postFormsData()
  const postFormResp = await FormData.postFormsData({
    formIdentifier: 'file',
    formData: formData,
    formModuleConfigId: moduleFormConfig?.id || 0,
    moduleEntityIdentifier: moduleFormConfig?.entityIdentifiers?.[0]?.id || '',
    replayTo: null,
    status: 'sent',
  });
};

// HTML
<form
  onSubmit={(e) => handleSubmit(e, selectedFiles)}
  className="flex flex-col gap-3 p-10 border rounded-3xl"
>
  <input
    type="file"
    onChange={handleFileChange}
    className="bg-white text-slate-800 p-3 rounded-2xl"
  />
  <button
    type="submit"
    className="bg-white text-slate-800 p-3 rounded-2xl"
  >
    Send
  </button>
</form>