File and Folder Service

API change history

Create document

Create Document

Try it

Request

Request URL

Request parameters

  • string

    File path.

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Document.

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "ReferenceData": "string",
  "Product": {
    "Content": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Source": "string",
        "Range": "string"
      }
    ],
    "Template": "string",
    "ApplicationId": "00000000-0000-0000-0000-000000000000",
    "DocumentTemplateId": "00000000-0000-0000-0000-000000000000",
    "Quantity": 0,
    "DocumentTemplateName": "string"
  }
}
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>Test Document Name</Name>
    <ReferenceData />
    <Description>Test Description</Description>
    <Product>
        <ApplicationId>00000000-0000-0000-0000-000000000000</ApplicationId>
        <Quantity>1</Quantity>
        <Template>Custom</Template>
        <DocumentTemplateId>d2194f63-902e-45b2-99cd-0e10a55a5656</DocumentTemplateId>
          <DocumentTemplateName>Test-81ff783c-56f1-4051-bd33-61db4fbd3889</DocumentTemplateName>
        <Content>
            <DocumentSection>
                <Source>a51b869f-0948-4c95-be94-91cac43c6d46</Source>
                <Range>[1,5]</Range>
            </DocumentSection>
        </Content>
    </Product>
</Document>

Responses

200 OK

Representations

{
    "FolderId": "1db1b139-8399-4be0-9bc7-f1f2de586c47",
    "Name": "Test2019",
    "Created": "2019-07-05T09:01:01.373Z",
    "Documents": [
        {
            "FileId": "c28e06d9-a412-4fd6-b5a7-a853b9d5b905",
            "Name": "psaaas-Dny-7fb4-42fa-8bf8-855f59c2fedddssse1jj",
            "DateCreated": "2019-09-25T11:43:32.1119023Z",
            "LastModified": "2019-09-25T11:43:32.1119023Z",
            "LastUsed": "0001-01-01T00:00:00"
        }
    ]
}
<Folder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xsi:type="StorageFolder">
    <FolderId>1db1b139-8399-4be0-9bc7-f1f2de586c47</FolderId>
    <Name>Test2019</Name>
    <Created>2019-07-05T09:01:01.373Z</Created>
    <Documents>
        <DocumentFile>
            <FileId>22d90950-768c-4cca-9569-d44a9b93020a</FileId>
            <Name>psaaas-Dny-7fb4-42fa-8bf8-855f59c2feddde1jj</Name>
            <DateCreated>2019-09-25T11:40:31.1886855Z</DateCreated>
            <LastModified>2019-09-25T11:40:31.1886855Z</LastModified>
            <LastUsed>0001-01-01T00:00:00</LastUsed>
        </DocumentFile>
    </Documents>
</Folder>

Code samples

@ECHO OFF

curl -v -X POST "https://print.api.sandbox.mimeo.com/dir/StorageService/Document/{filePath}"
-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.sandbox.mimeo.com/dir/StorageService/Document/{filePath}?" + 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.sandbox.mimeo.com/dir/StorageService/Document/{filePath}");


            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.sandbox.mimeo.com/dir/StorageService/Document/{filePath}?" + $.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.sandbox.mimeo.com/dir/StorageService/Document/{filePath}";
    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.sandbox.mimeo.com/dir/StorageService/Document/{filePath}');
$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.sandbox.mimeo.com')
    conn.request("POST", "/dir/StorageService/Document/{filePath}?%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.sandbox.mimeo.com')
    conn.request("POST", "/dir/StorageService/Document/{filePath}?%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.sandbox.mimeo.com/dir/StorageService/Document/{filePath}')


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