POST api/datalists

Creates a DataList entity and returns the new id.

Request Information

URI Parameters

None.

Body Parameters

The data list model to create with.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required String length: inclusive between 0 and 80
CreationDate	date	Required
CreatorUserId	globally unique identifier	None.
DataRetentionPeriod	integer	None.
AvailableStatusesIds	Collection of globally unique identifier	None.
FlushOnUse	boolean	None.
FolderId	globally unique identifier	None.
SchemaId	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.
Recipients	Collection of RecipientDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "6e82d90f-9e5a-406a-9040-674b2d89966f",
  "Name": "sample string 2",
  "CreationDate": "2026-01-09T14:29:35.6617872+00:00",
  "CreatorUserId": "5cf5a4aa-5616-4c56-9a64-ced3784fbfe3",
  "DataRetentionPeriod": 5,
  "AvailableStatusesIds": [
    "65945d8b-27d4-487c-b439-c5258f2349bf",
    "f928fd88-5311-4b14-a9dd-513c53603fe4"
  ],
  "FlushOnUse": true,
  "FolderId": "2d9e717f-54ab-4015-a760-d17e7cf06e43",
  "SchemaId": "2e91e33f-efe4-4fb7-83db-2e2258af718a",
  "ViewPermissionGroupId": "34bda4d3-90bd-4bed-97d1-5fa98c2f1c23",
  "EditPermissionGroupId": "2ebda0d6-aae9-4b40-a396-bd08a0642954",
  "DeletePermissionGroupId": "17165f4d-3f7a-4478-9fa9-666720b2dd19",
  "CanEdit": true,
  "CanDelete": true,
  "Recipients": [
    {
      "Id": "6b411360-dc54-4c3d-b7a8-4a6bed8488d8",
      "TenantId": "74a8bb89-3cec-4300-b2a2-604a2e5935f4",
      "ExternalId": "sample string 3",
      "CreationDate": "2026-01-09T14:29:35.6617872+00:00"
    },
    {
      "Id": "6b411360-dc54-4c3d-b7a8-4a6bed8488d8",
      "TenantId": "74a8bb89-3cec-4300-b2a2-604a2e5935f4",
      "ExternalId": "sample string 3",
      "CreationDate": "2026-01-09T14:29:35.6617872+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<DataListDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DataManagement.Models">
  <AvailableStatusesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>65945d8b-27d4-487c-b439-c5258f2349bf</d2p1:guid>
    <d2p1:guid>f928fd88-5311-4b14-a9dd-513c53603fe4</d2p1:guid>
  </AvailableStatusesIds>
  <CanDelete>true</CanDelete>
  <CanEdit>true</CanEdit>
  <CreationDate>2026-01-09T14:29:35.6617872+00:00</CreationDate>
  <CreatorUserId>5cf5a4aa-5616-4c56-9a64-ced3784fbfe3</CreatorUserId>
  <DataRetentionPeriod>5</DataRetentionPeriod>
  <DeletePermissionGroupId>17165f4d-3f7a-4478-9fa9-666720b2dd19</DeletePermissionGroupId>
  <EditPermissionGroupId>2ebda0d6-aae9-4b40-a396-bd08a0642954</EditPermissionGroupId>
  <FlushOnUse>true</FlushOnUse>
  <FolderId>2d9e717f-54ab-4015-a760-d17e7cf06e43</FolderId>
  <Id>6e82d90f-9e5a-406a-9040-674b2d89966f</Id>
  <Name>sample string 2</Name>
  <Recipients>
    <RecipientDto>
      <CreationDate>2026-01-09T14:29:35.6617872+00:00</CreationDate>
      <ExternalId>sample string 3</ExternalId>
      <Id>6b411360-dc54-4c3d-b7a8-4a6bed8488d8</Id>
      <TenantId>74a8bb89-3cec-4300-b2a2-604a2e5935f4</TenantId>
    </RecipientDto>
    <RecipientDto>
      <CreationDate>2026-01-09T14:29:35.6617872+00:00</CreationDate>
      <ExternalId>sample string 3</ExternalId>
      <Id>6b411360-dc54-4c3d-b7a8-4a6bed8488d8</Id>
      <TenantId>74a8bb89-3cec-4300-b2a2-604a2e5935f4</TenantId>
    </RecipientDto>
  </Recipients>
  <SchemaId>2e91e33f-efe4-4fb7-83db-2e2258af718a</SchemaId>
  <ViewPermissionGroupId>34bda4d3-90bd-4bed-97d1-5fa98c2f1c23</ViewPermissionGroupId>
</DataListDto>

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.