PUT api/schemas/{id}

Updates a schema entity.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the schema to update.	globally unique identifier	Required

Body Parameters

The schema model to update with.

SchemaDto

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": "851e83ec-2760-4f68-a1ee-6994677fb190",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "TenantId": "0bce81df-d66e-4564-8a8e-4c5cef0f4add",
  "CreatorId": "9cd08f06-29a5-4127-80f4-9336bdcee0d2",
  "CreationDate": "2026-01-09T14:32:05.145905+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": "84cf2312-6846-4387-9064-6fb25d6eea02",
      "CreationDateUtc": "2026-01-09T14:32:05.145905+00:00",
      "SchemaId": "9f81dbca-47cf-4bf7-a2fe-96c9b4d74a31",
      "Name": "sample string 4"
    },
    {
      "Id": "84cf2312-6846-4387-9064-6fb25d6eea02",
      "CreationDateUtc": "2026-01-09T14:32:05.145905+00:00",
      "SchemaId": "9f81dbca-47cf-4bf7-a2fe-96c9b4d74a31",
      "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-09T14:32:05.145905+00:00</CreationDate>
  <CreatorId>9cd08f06-29a5-4127-80f4-9336bdcee0d2</CreatorId>
  <DataRetentionPeriod>11</DataRetentionPeriod>
  <DataValidationSchema>sample string 10</DataValidationSchema>
  <Description>sample string 3</Description>
  <DownloadableColumns>
    <DownloadableColumnDto>
      <CreationDateUtc>2026-01-09T14:32:05.145905+00:00</CreationDateUtc>
      <Id>84cf2312-6846-4387-9064-6fb25d6eea02</Id>
      <Name>sample string 4</Name>
      <SchemaId>9f81dbca-47cf-4bf7-a2fe-96c9b4d74a31</SchemaId>
    </DownloadableColumnDto>
    <DownloadableColumnDto>
      <CreationDateUtc>2026-01-09T14:32:05.145905+00:00</CreationDateUtc>
      <Id>84cf2312-6846-4387-9064-6fb25d6eea02</Id>
      <Name>sample string 4</Name>
      <SchemaId>9f81dbca-47cf-4bf7-a2fe-96c9b4d74a31</SchemaId>
    </DownloadableColumnDto>
  </DownloadableColumns>
  <FileExtension>sample string 7</FileExtension>
  <Id>851e83ec-2760-4f68-a1ee-6994677fb190</Id>
  <IsDownloadable>true</IsDownloadable>
  <MaxUseCount>13</MaxUseCount>
  <Name>sample string 2</Name>
  <SampleFileData>QEA=</SampleFileData>
  <SampleFilePath>sample string 9</SampleFilePath>
  <TenantId>0bce81df-d66e-4564-8a8e-4c5cef0f4add</TenantId>
</SchemaDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.