Get Cfs REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:44:49 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:44:49

GET api.ashx/v2/cfs/{fileStore}/{filepath}/{filename}

GET a CFS file

Scopes

Centralized File Storage (CFS) › Read Files cfs.files.readonly

Request Parameters

Name	Type	Description	Required
Filename	string	Filename	Required
FilePath	string	File Path	Required
FileStore	string	File Store	Required
Height	int?	Used when requesting a resized image	Optional
Width	int?	Used when requesting a resized image	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/cfs/{fileStore}/{filepath}/{filename}',
	data: { 
		'fileStore': 'filestore',
		'filepath': 'filepath',
		'filename': 'filename'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "File": {
    "ContentLength": 0,
    "FileName": "filename",
    "Path": "path",
    "FileStoreKey": "filestorekey"
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

GET api.ashx/v2/cfs/resized/{width}x{height}/{fileStore}/{filepath}/{filename}

GET a resized CFS image