About this resource
Representation of a specific version of a File
Properties
| Property | Description | Type |
|---|---|---|
| catalogActions | Gets or sets the collection of the catalog actions. | FileTypeActionCollection |
| createdOn | Gets the creation datetime in UTC time. | datetime |
| engineFormat | Gets or sets the engine format. | string |
| extension | Gets or sets the extension of the file type. | string |
| id | Gets the identifier. | guid |
| isCatalogable | Gets or sets wheather is catalogable. | boolean |
| kind | Gets or sets the kind of the file type. | string |
| labels | Gets or sets the collection of the labels. | LabelCollection |
| mediaEngines | Gets the collection of media engines. | Collection of string items |
| mimeType | Gets or sets the mime type of the file type. | string |
| modifiedOn | Gets the last modification datetime in UTC time. | datetime |
| name | Gets or sets the name of the file type. | string |
| preferredExtension | Gets or sets the preferred extension. | boolean |
| previewFormat | Gets or sets the preview formats. | string |
| previewKeepDimensions | Gets or sets the dimensions the preview has to keep. | boolean |
| previewPlayers | Gets the collection of preview players. | Collection of string items |
| previewRequired | Gets or sets wheather a preview is required. | boolean |
| registeredFieldGroups | A collection of Registered Field Group items. | RegisteredFieldGroupCollection |
| registeredFields | A collection of Registered Field items. | RegisteredFieldCollection |
| supportAssetResize | Gets or sets the permission to resize. | boolean |
| supportAssetWatermark | Gets or sets the permission to add a watermark. | boolean |
| tag | Gets or sets the value for the Tag of this object. The value of this property should be a valid XML. An empty string will be automatically converted to null. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-filetype' and the value 'Tag' to your request. | string |
Relations
| Method | Name | Select-key | Resource type | Description |
|---|---|---|---|---|
| GET | self | Provides a link to this resource. | ||
| GET | icon | select-FileType: icon | Image | Gets the master preview image of this file version. |
| GET | thumbnail | select-FileType: thumbnail | Image | Gets the master thumbnail of this file version. |
| GET | modifiedby | select-FileType: modifiedby | User | Gets or sets the user that last modified this resource. |
| GET | createdby | select-FileType: createdby | User | Gets or sets the user that created this resource. |
Actions
| Method | Action | Description | Response codes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PUT /filetype/{fileTypeId} | edit | Edits an existing file type. |
|
||||||||
| DELETE /filetype/{fileTypeId} | delete | Deletes an existing file type. |
|
Examples
Reading a file type
GET /filetype/8130e27dd7114e018734b652b512e8dc HTTP/1.1
If the file type was not found, the API call will fail with a 404 Not found HTTP status code.
{
"_links": {
"icon": {
"href": "/filetype/8130e27dd7114e018734b652b512e8dc/image/icon",
"select-key": "icon"
},
"thumbnail": {
"href": "/filetype/8130e27dd7114e018734b652b512e8dc/image/thumbnail",
"select-key": "thumbnail"
},
"modifiedby": {
"href": "/user/7410e27dd7114e018734b652b512e8dc",
"select-key": "modifiedby"
},
"createdby": {
"href": "/user/7410e27dd7114e018734b652b512e8dc",
"select-key": "createdby"
},
"self": {
"href": "/filetype/8130e27dd7114e018734b652b512e8dc"
}
},
"id": "8130e27dd7114e018734b652b512e8dc",
"name": "Archive (ZIP)",
"kind": "Zip",
"extension": "ZIP",
"mimeType": "application/octet-stream",
"labels": [
{
"value": "Archive (ZIP)",
"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc"
}
],
"registeredFields": [],
"registeredFieldGroups": [],
"engineFormat": "ZIP",
"catalogActions": [],
"mediaEngines": [],
"previewFormat": "Jpg",
"previewPlayers": [],
"previewRequired": false,
"previewKeepDimensions": false,
"allowResize": false,
"allowWatermark": false,
"preferredExtension": true,
"tag": null,
"modifiedOn": "2017-10-20T05:44:13.487Z",
"createdOn": "2017-10-20T05:44:13.487Z"
}
Editing a file type
PUT /filetype/31072990f5ec458a9145a7f9008c1404
{
"name": "file type name",
"kind": "knd",
"extension": "ext",
"mimeType": "application/json",
"thumbnail": "NmMyM2YwZmM0NTVlNDNjYzkzZTdhODI3MDA4MDQ2ODQ=",
"icon": "ZmIyNjkyYjcwZTQyNGY1Yjg3YjBhODI3MDA4MDU5ZjU=",
"labels": [
{
"languageId": "c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc",
"value": "file type name"
}
],
"isCatalogable": false,
"engineFormat": "ef",
"catalogActions": {
"addOrUpdate": [
{
"name": "ReadXmp",
"isCritical": false
},
{
"name": "ReadMetaData",
"isCritical": true
}
],
"remove": [
{
"name": "ReadExif"
}
]
},
"mediaEngines": {
"addOrUpdate": [
"Xmp"
],
"remove": [
"Exif",
"Text"
]
},
"previewFormat": "None",
"previewRenderWebControls": {
"addOrUpdate": [
"Adam.AudioPreviewPlayer"
],
"remove": [
"Adam.PdfPreviewPlayer"
]
},
"previewRequired": false,
"keepDocumentDimensions": false,
"allowOrderResizeSource": false,
"supportsWatermarking": false,
"registeredFields": {
"remove": [
"c2ed2f3e-a145-44c0-8477-a82400d1f8cd"
]
},
"registeredFieldGroups": {
"remove": [
"40cd3ee8-08e5-4c52-8ec8-50a372e4de1c"
]
},
"preferredExtension": false,
"tag": "<xml>some tag</xml>"
}
Deleting a file type
DELETE /filetype/6750869d69e64b6c86b4a7f900898bb4