POST api/schemas

Creates a schema entity.

Request Information

URI Parameters

None.

Body Parameters

The schema model to create with.

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required String length: inclusive between 0 and 50
Description	string	None.
TenantId	globally unique identifier	Required
CreatorId	globally unique identifier	Required
CreationDate	date	Required
FileExtension	string	Required String length: inclusive between 0 and 10
ByteCount	integer	None.
SampleFilePath	string	String length: inclusive between 0 and 512
SampleFileData	Collection of byte	None.
DataValidationSchema	string	None.
DataRetentionPeriod	integer	Range: inclusive between 0 and 365
IsDownloadable	boolean	None.
MaxUseCount	integer	None.
AllowSuppressions	boolean	None.
DownloadableColumns	Collection of DownloadableColumnDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "310a40b6-c787-4c21-a847-aba072a02326",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "TenantId": "68b00fb6-f497-4a52-b387-3a90afec1a20",
  "CreatorId": "12baa253-c17f-4b07-a43a-4b07adf1db22",
  "CreationDate": "2026-01-10T12:29:38.1723423+00:00",
  "FileExtension": "sample string 7",
  "ByteCount": 8,
  "SampleFilePath": "sample string 9",
  "SampleFileData": "QEA=",
  "DataValidationSchema": "sample string 10",
  "DataRetentionPeriod": 11,
  "IsDownloadable": true,
  "MaxUseCount": 13,
  "AllowSuppressions": true,
  "DownloadableColumns": [
    {
      "Id": "70cdbf1d-6df1-402c-ac6a-28d62a9203ce",
      "CreationDateUtc": "2026-01-10T12:29:38.1723423+00:00",
      "SchemaId": "54bf6cb7-934d-4e42-b125-48453574d6b1",
      "Name": "sample string 4"
    },
    {
      "Id": "70cdbf1d-6df1-402c-ac6a-28d62a9203ce",
      "CreationDateUtc": "2026-01-10T12:29:38.1723423+00:00",
      "SchemaId": "54bf6cb7-934d-4e42-b125-48453574d6b1",
      "Name": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<SchemaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.DataManagement.Models">
  <AllowSuppressions>true</AllowSuppressions>
  <ByteCount>8</ByteCount>
  <CreationDate>2026-01-10T12:29:38.1723423+00:00</CreationDate>
  <CreatorId>12baa253-c17f-4b07-a43a-4b07adf1db22</CreatorId>
  <DataRetentionPeriod>11</DataRetentionPeriod>
  <DataValidationSchema>sample string 10</DataValidationSchema>
  <Description>sample string 3</Description>
  <DownloadableColumns>
    <DownloadableColumnDto>
      <CreationDateUtc>2026-01-10T12:29:38.1723423+00:00</CreationDateUtc>
      <Id>70cdbf1d-6df1-402c-ac6a-28d62a9203ce</Id>
      <Name>sample string 4</Name>
      <SchemaId>54bf6cb7-934d-4e42-b125-48453574d6b1</SchemaId>
    </DownloadableColumnDto>
    <DownloadableColumnDto>
      <CreationDateUtc>2026-01-10T12:29:38.1723423+00:00</CreationDateUtc>
      <Id>70cdbf1d-6df1-402c-ac6a-28d62a9203ce</Id>
      <Name>sample string 4</Name>
      <SchemaId>54bf6cb7-934d-4e42-b125-48453574d6b1</SchemaId>
    </DownloadableColumnDto>
  </DownloadableColumns>
  <FileExtension>sample string 7</FileExtension>
  <Id>310a40b6-c787-4c21-a847-aba072a02326</Id>
  <IsDownloadable>true</IsDownloadable>
  <MaxUseCount>13</MaxUseCount>
  <Name>sample string 2</Name>
  <SampleFileData>QEA=</SampleFileData>
  <SampleFilePath>sample string 9</SampleFilePath>
  <TenantId>68b00fb6-f497-4a52-b387-3a90afec1a20</TenantId>
</SchemaDto>

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.