File and Folder Service
API change historyRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Store item search criteria
{
"SortBy": [
{
"Property": 1,
"Direction": 0
}
],
"PageInfo": {
"PageSize": 0,
"PageNumber": 0
},
"SearchString": "string",
"Created": {
"StartDate": "string",
"EndDate": "string"
},
"CreatedBy": "00000000-0000-0000-0000-000000000000",
"Description": "string",
"LastOrdered": {
"StartDate": "string",
"EndDate": "string"
},
"LastUpdated": {
"StartDate": "string",
"EndDate": "string"
},
"Name": "string",
"Type": "string",
"FolderId": "00000000-0000-0000-0000-000000000000",
"ReferenceData": "string",
"LevelOfDetail": 0,
"IncludeSubFolders": true,
"FolderScope": 0,
"OfferingCode": "string",
"FolderOwnerUserId": "00000000-0000-0000-0000-000000000000",
"ItemDetails": {},
"NumberOfTimesUsedInAnOrder": {
"Min": 0,
"Max": 0
}
}
<StoreItemSearchCriteria
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<PageInfo>
<PageSize>20</PageSize>
<PageNumber>1</PageNumber>
</PageInfo>
<StoreItemSearchSortCriteria>
<RESTStoreItemSearchSortCriteria>
<Property>Created</Property>
<Direction>Ascending</Direction>
</RESTStoreItemSearchSortCriteria>
</StoreItemSearchSortCriteria>
<SearchString>Test String</SearchString>
<CreatedDateRange>
<StartDate>2019-09-25T10:29:55.0934955+05:30</StartDate>
<EndDate>2019-09-25T10:29:55.0934955+05:30</EndDate>
</CreatedDateRange>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<Description>Test Description</Description>
<LastOrderedDateRange>
<StartDate>2019-09-25T10:29:55.0954901+05:30</StartDate>
<EndDate>2019-09-25T10:29:55.0954901+05:30</EndDate>
</LastOrderedDateRange>
<LastUpdatedDateRange>
<StartDate>2019-09-25T10:29:55.0954901+05:30</StartDate>
<EndDate>2019-09-25T10:29:55.0954901+05:30</EndDate>
</LastUpdatedDateRange>
<Name>TestName</Name>
<Type>Document</Type>
<FolderId>00000000-0000-0000-0000-000000000000</FolderId>
<ReferenceData>Test Fererence data</ReferenceData>
<LevelOfDetail>All</LevelOfDetail>
<FolderScope>All</FolderScope>
<OfferingCode>TestCode</OfferingCode>
<FolderOwnerUserId>00000000-0000-0000-0000-000000000000</FolderOwnerUserId>
<ItemDetails />
<IntegerRange>
<Min>1</Min>
<Max>50</Max>
</IntegerRange>
</StoreItemSearchCriteria>
Responses
200 OK
Representations
{
"TotalItemCount": 29,
"Items": [
{
"Id": "413b440c-b34d-43d4-80b0-a8ba9d19f682",
"Folder": null,
"Created": "2017-11-03T19:50:24.597Z",
"LastModified": "2017-11-03T19:51:09.537Z",
"LastUsed": null,
"Version": 2,
"NumberOfTimesUsedInAnOrder": 0,
"Name": "Stone Ridge AVRPX End Client Fact Sheet (2017-09-30)(AA) - Kendall Dwyer~gxz912oh.pdf",
"Description": "",
"SystemDetails": "",
"ReferenceData": "",
"IsBroken": false,
"LastModifiedByUserDetails": null,
"ItemData": null,
"CreatedByUserDetails": null,
"ItemDetails": null,
"Type": "Printfile",
"IsPublishedToAMarketplace": false,
"IsDeleted": false,
"GoodsType": "00000000-0000-0000-0000-000000000000"
},
{
"Id": "91b0e106-f4c1-4bd2-a3f1-9e1649291b35",
"Folder": null,
"Created": "2017-11-03T19:50:35.097Z",
"LastModified": "2017-11-03T19:50:35.097Z",
"LastUsed": null,
"Version": 1,
"NumberOfTimesUsedInAnOrder": 0,
"Name": "Stone Ridge AVRPX End Client Fact Sheet (2017-09-30)(AA) - Kendall Dwyer~gxz912oh.pdf",
"Description": "",
"SystemDetails": "",
"ReferenceData": "",
"IsBroken": false,
"LastModifiedByUserDetails": null,
"ItemData": null,
"CreatedByUserDetails": null,
"ItemDetails": null,
"Type": "Document",
"IsPublishedToAMarketplace": false,
"IsDeleted": false,
"GoodsType": "695ce26c-2886-4aec-89cf-fb0b25da7930"
}
]
}
<StoreItemSearchResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<TotalItemCount>29</TotalItemCount>
<StoreItems>
<StoreItem>
<Id>413b440c-b34d-43d4-80b0-a8ba9d19f682</Id>
<Created>2017-11-03T19:50:24.597Z</Created>
<LastModified>2017-11-03T19:51:09.537Z</LastModified>
<LastUsed xsi:nil="true" />
<Version>2</Version>
<NumberOfTimesUsedInAnOrder>0</NumberOfTimesUsedInAnOrder>
<Name>Stone Ridge AVRPX End Client Fact Sheet (2017-09-30)(AA) - Kendall Dwyer~gxz912oh.pdf</Name>
<Description />
<SystemDetails />
<ReferenceData />
<IsBroken>false</IsBroken>
<Type>Printfile</Type>
<IsPublishedToAMarketplace>false</IsPublishedToAMarketplace>
<IsDeleted>false</IsDeleted>
<GoodsType>00000000-0000-0000-0000-000000000000</GoodsType>
</StoreItem>
<StoreItem>
<Id>91b0e106-f4c1-4bd2-a3f1-9e1649291b35</Id>
<Created>2017-11-03T19:50:35.097Z</Created>
<LastModified>2017-11-03T19:50:35.097Z</LastModified>
<LastUsed xsi:nil="true" />
<Version>1</Version>
<NumberOfTimesUsedInAnOrder>0</NumberOfTimesUsedInAnOrder>
<Name>Stone Ridge AVRPX End Client Fact Sheet (2017-09-30)(AA) - Kendall Dwyer~gxz912oh.pdf</Name>
<Description />
<SystemDetails />
<ReferenceData />
<IsBroken>false</IsBroken>
<Type>Document</Type>
<IsPublishedToAMarketplace>false</IsPublishedToAMarketplace>
<IsDeleted>false</IsDeleted>
<GoodsType>695ce26c-2886-4aec-89cf-fb0b25da7930</GoodsType>
</StoreItem>
</StoreItems>
</StoreItemSearchResponse>
Code samples
@ECHO OFF
curl -v -X POST "https://print.api.mimeo.com/dir/StorageService/FindStoreItems"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://print.api.mimeo.com/dir/StorageService/FindStoreItems?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://print.api.mimeo.com/dir/StorageService/FindStoreItems");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://print.api.mimeo.com/dir/StorageService/FindStoreItems?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://print.api.mimeo.com/dir/StorageService/FindStoreItems";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://print.api.mimeo.com/dir/StorageService/FindStoreItems');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('print.api.mimeo.com')
conn.request("POST", "/dir/StorageService/FindStoreItems?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('print.api.mimeo.com')
conn.request("POST", "/dir/StorageService/FindStoreItems?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://print.api.mimeo.com/dir/StorageService/FindStoreItems')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body