Documentation / API / Operations on Files

GET and COUNT operations available on files.

Files Operations

GET

URL

POST https://your-secured-store-url:443/api/v1/files/get

Filters

Filter Type
id Array of GUID
name Array of String (max 255 chars)
extension Array of String (max 255 chars)
size_min Integer (max 11 digits)
size_max Integer (max 11 digits)
createdon_min DateTime
createdon_max DateTime

Request

Retrieve all the items (max 1000)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        }
    }

Retrieve specific items by ID

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id' : ['05e58b5c-d043-4a38-a16e-7957336047d0','18aaa336-ff76-49a0-bd28-124d07d1602a']
        }
    }

Most complete request (just to give you the format of each parameter)

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    },
    'filters' : {
	    'id' : ['1d89ffa3-6098-49af-90b4-8fa6aa15af67','40d9e788-b556-4733-8cf9-fe53dabf75c6'],
	    'name' : ['bigc7.png','logo1.png'],
	    'extension' : ['png','jpg'],
	    'size_min' : '2000',
	    'size_max' : '99999999',
	    'createdon_min' : '2015-01-01',
	    'createdon_max' : '2042-01-01'
    },
    'pagination' : {
        'pageNumber' : '1',
        'pageSize' : '1000'
    }
}

Response

If no error occured, you will receive a response like this one (object type: File). Please refer to error messages to learn more about the possible error responses.

[
   {
      "id": "1d89ffa3-6098-49af-90b4-8fa6aa15af67",
      "name": "bigc7.png",
      "extension": "png",
      "url": "http://localhost:84/files/Ui9imeVjqu",
      "size": "117558",
      "author": "Mr Example",
      "createdon": "2016-02-12 21:42:09"
   },
   {
      "id": "40d9e788-b556-4733-8cf9-fe53dabf75c6",
      "name": "logo1.png",
      "extension": "png",
      "url": "http://localhost:84/files/vVJypkKnCA",
      "size": "8489",
      "author": "Mr Example",
      "createdon": "2015-10-03 16:29:17"
   }
]

COUNT

URL

POST https://your-secured-store-url:443/api/v1/files/count

Filters

Filter Type
id Array of GUID
name Array of String (max 255 chars)
extension Array of String (max 255 chars)
size_min Integer (max 11 digits)
size_max Integer (max 11 digits)
createdon_min DateTime
createdon_max DateTime

Request

Count the items

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    }
}

Count specific items by extension

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    },
    'filters' : {
        'extension' : ['png','jpg','jpeg','gif']
    }
}

Most complete request (just to give you the format of each parameter)

{
    'authentication' : {
        'apiKey' : 'jjns7519v1v3ns6xU162'
    },
	'filters' : {
		'id' : ['1d89ffa3-6098-49af-90b4-8fa6aa15af67','40d9e788-b556-4733-8cf9-fe53dabf75c6'],
		'name' : ['bigc7.png','logo1.png'],
		'extension' : ['png','jpg'],
		'size_min' : '2000',
		'size_max' : '99999999',
		'createdon_min' : '2015-01-01',
		'createdon_max' : '2042-01-01'
	}
}

Response

If no error occured, you will receive a response like this one. Please refer to error messages to learn more about the possible error responses.

{
   "count": "98"
}