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.

DataListDto
NameDescriptionTypeAdditional 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": "75d5dfb9-a3c5-4d5a-b891-57f59950ab53",
  "Name": "sample string 2",
  "CreationDate": "2026-01-07T07:22:59.1771652+00:00",
  "CreatorUserId": "39e1e655-1b41-4efa-919a-2373ebd369f1",
  "DataRetentionPeriod": 5,
  "AvailableStatusesIds": [
    "67bd14d3-b392-43b4-85a6-5290f9ab1a8c",
    "1a504d8e-2408-438a-9fed-83d625042d0e"
  ],
  "FlushOnUse": true,
  "FolderId": "a8bc79d2-91ef-4051-991c-0ecd512f410d",
  "SchemaId": "1c20752e-65e7-4e82-85de-38a5d97bf4f5",
  "ViewPermissionGroupId": "e9e9a559-5122-4080-9ef2-75c895938e9f",
  "EditPermissionGroupId": "52ab2ef8-019c-4f09-a0d4-55342264ee2f",
  "DeletePermissionGroupId": "38e14b74-f350-460d-8457-55ce8cd89b68",
  "CanEdit": true,
  "CanDelete": true,
  "Recipients": [
    {
      "Id": "70e2686d-4de2-400b-858c-f94a719b40ba",
      "TenantId": "bf83618b-ef74-48a7-a23e-3ba805f2f703",
      "ExternalId": "sample string 3",
      "CreationDate": "2026-01-07T07:22:59.1771652+00:00"
    },
    {
      "Id": "70e2686d-4de2-400b-858c-f94a719b40ba",
      "TenantId": "bf83618b-ef74-48a7-a23e-3ba805f2f703",
      "ExternalId": "sample string 3",
      "CreationDate": "2026-01-07T07:22:59.1771652+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>67bd14d3-b392-43b4-85a6-5290f9ab1a8c</d2p1:guid>
    <d2p1:guid>1a504d8e-2408-438a-9fed-83d625042d0e</d2p1:guid>
  </AvailableStatusesIds>
  <CanDelete>true</CanDelete>
  <CanEdit>true</CanEdit>
  <CreationDate>2026-01-07T07:22:59.1771652+00:00</CreationDate>
  <CreatorUserId>39e1e655-1b41-4efa-919a-2373ebd369f1</CreatorUserId>
  <DataRetentionPeriod>5</DataRetentionPeriod>
  <DeletePermissionGroupId>38e14b74-f350-460d-8457-55ce8cd89b68</DeletePermissionGroupId>
  <EditPermissionGroupId>52ab2ef8-019c-4f09-a0d4-55342264ee2f</EditPermissionGroupId>
  <FlushOnUse>true</FlushOnUse>
  <FolderId>a8bc79d2-91ef-4051-991c-0ecd512f410d</FolderId>
  <Id>75d5dfb9-a3c5-4d5a-b891-57f59950ab53</Id>
  <Name>sample string 2</Name>
  <Recipients>
    <RecipientDto>
      <CreationDate>2026-01-07T07:22:59.1771652+00:00</CreationDate>
      <ExternalId>sample string 3</ExternalId>
      <Id>70e2686d-4de2-400b-858c-f94a719b40ba</Id>
      <TenantId>bf83618b-ef74-48a7-a23e-3ba805f2f703</TenantId>
    </RecipientDto>
    <RecipientDto>
      <CreationDate>2026-01-07T07:22:59.1771652+00:00</CreationDate>
      <ExternalId>sample string 3</ExternalId>
      <Id>70e2686d-4de2-400b-858c-f94a719b40ba</Id>
      <TenantId>bf83618b-ef74-48a7-a23e-3ba805f2f703</TenantId>
    </RecipientDto>
  </Recipients>
  <SchemaId>1c20752e-65e7-4e82-85de-38a5d97bf4f5</SchemaId>
  <ViewPermissionGroupId>e9e9a559-5122-4080-9ef2-75c895938e9f</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.