POST api/datafiles

Creates a DataFile entity and returns the new id.

Request Information

URI Parameters

None.

Body Parameters

The data file model to create with.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required String length: inclusive between 0 and 80
Path	string	String length: inclusive between 0 and 512
UserId	globally unique identifier	None.
IsInLibrary	boolean	None.
CreationDate	date	None.
SchemaId	globally unique identifier	Required
FileData	Collection of byte	None.
OriginalRecordCount	integer	None.
PostSuppressionRecordCount	integer	None.
ByteCount	integer	None.
TenantId	globally unique identifier	None.
FolderId	globally unique identifier	None.
ViewPermissionGroupId	globally unique identifier	None.
EditPermissionGroupId	globally unique identifier	None.
DeletePermissionGroupId	globally unique identifier	None.
CanEdit	boolean	None.
CanDelete	boolean	None.
ExpiryDate	date	None.
PublishDate	date	None.
IsPurchaseData	boolean	None.
DataSource	string	String length: inclusive between 0 and 512
MaxUseCount	integer	None.
IsSelectable	boolean	None.
DataListId	globally unique identifier	None.
DataFileExtension	string	None.
ReasonForSuppression	string	String length: inclusive between 0 and 512
DataFileProperties	Collection of DataFilePropertyDto	None.
Recipients	Collection of RecipientDto	None.
AuditLogs	Collection of DataFileAuditLogDto	None.

Request Formats

application/json, text/json

Sample:

{
  "AuditLogs": [
    {
      "Id": "a2583747-0fc7-420c-a93f-510ef7fe678e",
      "DataFileId": "cac2d4d3-ef19-44ee-8303-abf382c61695",
      "CreationDateUtc": "2026-01-08T11:40:00.1103392+00:00",
      "ActionType": 0,
      "ChangedByUserId": "c956d3b8-2071-4aad-b8b5-7ed54e7a035a",
      "Description": "sample string 5"
    },
    {
      "Id": "a2583747-0fc7-420c-a93f-510ef7fe678e",
      "DataFileId": "cac2d4d3-ef19-44ee-8303-abf382c61695",
      "CreationDateUtc": "2026-01-08T11:40:00.1103392+00:00",
      "ActionType": 0,
      "ChangedByUserId": "c956d3b8-2071-4aad-b8b5-7ed54e7a035a",
      "Description": "sample string 5"
    }
  ],
  "Id": "b5552579-c0c9-4ff9-8d27-72b1801a05ca",
  "Name": "sample string 2",
  "Path": "sample string 3",
  "UserId": "40ef0b14-aee2-49e9-abe2-22db83f92126",
  "IsInLibrary": true,
  "CreationDate": "2026-01-08T11:40:00.1103392+00:00",
  "SchemaId": "68aaab01-bab2-4397-b1c6-c1d921cf76de",
  "FileData": "QEA=",
  "OriginalRecordCount": 8,
  "PostSuppressionRecordCount": 9,
  "ByteCount": 10,
  "TenantId": "e6d97e0a-d723-4b51-9e44-aa483eeb799e",
  "FolderId": "1e6eecfc-4c73-477d-9cc3-1c19343b5ba2",
  "ViewPermissionGroupId": "51317bba-cc90-4ab4-9077-39fb48d136df",
  "EditPermissionGroupId": "8a2babc7-e5d8-488b-9d57-fcc27cb29efa",
  "DeletePermissionGroupId": "3e995554-33ac-4873-881d-1b6f8b802c5a",
  "CanEdit": true,
  "CanDelete": true,
  "ExpiryDate": "2026-01-08T11:40:00.1103392+00:00",
  "PublishDate": "2026-01-08T11:40:00.1103392+00:00",
  "IsPurchaseData": true,
  "DataSource": "sample string 14",
  "MaxUseCount": 15,
  "IsSelectable": true,
  "DataListId": "d98fdea1-9d5d-468c-93e0-b03679983cc8",
  "DataFileExtension": "sample string 17",
  "ReasonForSuppression": "sample string 18",
  "DataFileProperties": [
    {
      "Id": "62bc48a6-2592-47e3-b4ac-7ae3a199a153",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-08T11:40:00.1103392+00:00",
      "DataFileId": "2f809c32-63be-480e-90f5-f4798e1602fd"
    },
    {
      "Id": "62bc48a6-2592-47e3-b4ac-7ae3a199a153",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "CreationDate": "2026-01-08T11:40:00.1103392+00:00",
      "DataFileId": "2f809c32-63be-480e-90f5-f4798e1602fd"
    }
  ],
  "Recipients": [
    {
      "Id": "72c4ad87-247c-4e7d-800a-3fa5dc79979c",
      "TenantId": "bd2804b3-8bb2-4271-a2f6-ef8b25f82032",
      "ExternalId": "sample string 3",
      "CreationDate": "2026-01-08T11:40:00.1103392+00:00"
    },
    {
      "Id": "72c4ad87-247c-4e7d-800a-3fa5dc79979c",
      "TenantId": "bd2804b3-8bb2-4271-a2f6-ef8b25f82032",
      "ExternalId": "sample string 3",
      "CreationDate": "2026-01-08T11:40:00.1103392+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<DataFileDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DataManagement.Models">
  <AuditLogs>
    <DataFileAuditLogDto>
      <ActionType>Create</ActionType>
      <ChangedByUserId>c956d3b8-2071-4aad-b8b5-7ed54e7a035a</ChangedByUserId>
      <CreationDateUtc>2026-01-08T11:40:00.1103392+00:00</CreationDateUtc>
      <DataFileId>cac2d4d3-ef19-44ee-8303-abf382c61695</DataFileId>
      <Description>sample string 5</Description>
      <Id>a2583747-0fc7-420c-a93f-510ef7fe678e</Id>
    </DataFileAuditLogDto>
    <DataFileAuditLogDto>
      <ActionType>Create</ActionType>
      <ChangedByUserId>c956d3b8-2071-4aad-b8b5-7ed54e7a035a</ChangedByUserId>
      <CreationDateUtc>2026-01-08T11:40:00.1103392+00:00</CreationDateUtc>
      <DataFileId>cac2d4d3-ef19-44ee-8303-abf382c61695</DataFileId>
      <Description>sample string 5</Description>
      <Id>a2583747-0fc7-420c-a93f-510ef7fe678e</Id>
    </DataFileAuditLogDto>
  </AuditLogs>
  <ByteCount>10</ByteCount>
  <CanDelete>true</CanDelete>
  <CanEdit>true</CanEdit>
  <CreationDate>2026-01-08T11:40:00.1103392+00:00</CreationDate>
  <DataFileExtension>sample string 17</DataFileExtension>
  <DataFileProperties>
    <DataFilePropertyDto>
      <CreationDate>2026-01-08T11:40:00.1103392+00:00</CreationDate>
      <DataFileId>2f809c32-63be-480e-90f5-f4798e1602fd</DataFileId>
      <Id>62bc48a6-2592-47e3-b4ac-7ae3a199a153</Id>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </DataFilePropertyDto>
    <DataFilePropertyDto>
      <CreationDate>2026-01-08T11:40:00.1103392+00:00</CreationDate>
      <DataFileId>2f809c32-63be-480e-90f5-f4798e1602fd</DataFileId>
      <Id>62bc48a6-2592-47e3-b4ac-7ae3a199a153</Id>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </DataFilePropertyDto>
  </DataFileProperties>
  <DataListId>d98fdea1-9d5d-468c-93e0-b03679983cc8</DataListId>
  <DataSource>sample string 14</DataSource>
  <DeletePermissionGroupId>3e995554-33ac-4873-881d-1b6f8b802c5a</DeletePermissionGroupId>
  <EditPermissionGroupId>8a2babc7-e5d8-488b-9d57-fcc27cb29efa</EditPermissionGroupId>
  <ExpiryDate>2026-01-08T11:40:00.1103392+00:00</ExpiryDate>
  <FileData>QEA=</FileData>
  <FolderId>1e6eecfc-4c73-477d-9cc3-1c19343b5ba2</FolderId>
  <Id>b5552579-c0c9-4ff9-8d27-72b1801a05ca</Id>
  <IsInLibrary>true</IsInLibrary>
  <IsPurchaseData>true</IsPurchaseData>
  <IsSelectable>true</IsSelectable>
  <MaxUseCount>15</MaxUseCount>
  <Name>sample string 2</Name>
  <OriginalRecordCount>8</OriginalRecordCount>
  <Path>sample string 3</Path>
  <PostSuppressionRecordCount>9</PostSuppressionRecordCount>
  <PublishDate>2026-01-08T11:40:00.1103392+00:00</PublishDate>
  <ReasonForSuppression>sample string 18</ReasonForSuppression>
  <Recipients>
    <RecipientDto>
      <CreationDate>2026-01-08T11:40:00.1103392+00:00</CreationDate>
      <ExternalId>sample string 3</ExternalId>
      <Id>72c4ad87-247c-4e7d-800a-3fa5dc79979c</Id>
      <TenantId>bd2804b3-8bb2-4271-a2f6-ef8b25f82032</TenantId>
    </RecipientDto>
    <RecipientDto>
      <CreationDate>2026-01-08T11:40:00.1103392+00:00</CreationDate>
      <ExternalId>sample string 3</ExternalId>
      <Id>72c4ad87-247c-4e7d-800a-3fa5dc79979c</Id>
      <TenantId>bd2804b3-8bb2-4271-a2f6-ef8b25f82032</TenantId>
    </RecipientDto>
  </Recipients>
  <SchemaId>68aaab01-bab2-4397-b1c6-c1d921cf76de</SchemaId>
  <TenantId>e6d97e0a-d723-4b51-9e44-aa483eeb799e</TenantId>
  <UserId>40ef0b14-aee2-49e9-abe2-22db83f92126</UserId>
  <ViewPermissionGroupId>51317bba-cc90-4ab4-9077-39fb48d136df</ViewPermissionGroupId>
</DataFileDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.