POST api/Format

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RegistryName	string	None.
FormatId	string	None.
Category	string	None.
Name	string	None.
Description	string	None.
Dependency	string	None.
Version	integer	None.
PronomIds	Collection of string	None.
FilesGroup	Collection of FileDetails	None.
OrganizationUse	string	None.
ConfidentialLevel	string	None.
ServiceLevel	string	None.
ExternalLinks	Collection of ExternalLink	None.
OutputExtension	string	None.
Strategies	Collection of string	None.
AccessFormat	AccessFormat	None.
PreservationFormat	Collection of PreservationFormat	None.
Uuid	string	None.
OrganizationUuid	string	None.
CreatedBy	string	None.
ModifiedBy	string	None.
Hidden	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "RegistryName": "sample string 1",
  "FormatId": "sample string 2",
  "Category": "sample string 3",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Dependency": "sample string 6",
  "Version": 7,
  "PronomIds": [
    "sample string 1",
    "sample string 2"
  ],
  "Obsolete": true,
  "FilesGroup": [
    {
      "MimeType": "sample string 1",
      "Extension": "sample string 2"
    },
    {
      "MimeType": "sample string 1",
      "Extension": "sample string 2"
    }
  ],
  "OrganizationUse": "sample string 10",
  "ConfidentialLevel": "sample string 11",
  "ServiceLevel": "sample string 12",
  "ExternalLinks": [
    {
      "Repeating": "sample string 1",
      "Title": "sample string 2",
      "Link": "sample string 3"
    },
    {
      "Repeating": "sample string 1",
      "Title": "sample string 2",
      "Link": "sample string 3"
    }
  ],
  "OutputExtension": "sample string 13",
  "Strategies": [
    "sample string 1",
    "sample string 2"
  ],
  "AccessFormat": {
    "FormatUuid": "sample string 1",
    "Format": "sample string 2",
    "Path": "sample string 3",
    "Notes": "sample string 4"
  },
  "PreservationFormat": [
    {
      "Repeating": "sample string 1",
      "FormatUuid": "sample string 2",
      "Format": "sample string 3",
      "Path": "sample string 4",
      "Notes": "sample string 5",
      "Status": "sample string 6",
      "SelectedOn": "2025-11-04T06:04:06.5692252-05:00",
      "SupercededOn": "2025-11-04T06:04:06.5692252-05:00",
      "Reason": "sample string 9"
    },
    {
      "Repeating": "sample string 1",
      "FormatUuid": "sample string 2",
      "Format": "sample string 3",
      "Path": "sample string 4",
      "Notes": "sample string 5",
      "Status": "sample string 6",
      "SelectedOn": "2025-11-04T06:04:06.5692252-05:00",
      "SupercededOn": "2025-11-04T06:04:06.5692252-05:00",
      "Reason": "sample string 9"
    }
  ],
  "ReadOnly": true,
  "Uuid": "sample string 15",
  "OrganizationUuid": "sample string 16",
  "CreatedOn": "2025-11-04T06:04:06.5692252-05:00",
  "CreatedBy": "sample string 19",
  "ModifiedOn": "2025-11-04T06:04:06.5692252-05:00",
  "ModifiedBy": "sample string 22",
  "Hidden": true
}

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.