Field Squared API Services

<back to all web services

CatalogImport

Bulk import a catalog from a csv file.

The following routes are available for this service:
POST/{Workspace}/CatalogImport
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Catalogs;

namespace Field2Office.API.Model.Catalogs
{
    ///<summary>
    ///Bulk import a catalog from a csv file.
    ///</summary>
    public partial class CatalogImport
    {
        public CatalogImport()
        {
            Mappings = new Dictionary<string, string>{};
            CategoryPath = new List<string>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string Id { get; set; }
        public virtual string Type { get; set; }
        public virtual Dictionary<string, string> Mappings { get; set; }
        public virtual List<string> CategoryPath { get; set; }
        public virtual string Delimiter { get; set; }
    }

}

C# CatalogImport DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/CatalogImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Id: String,
	Type: String,
	Mappings: 
	{
		String: String
	},
	CategoryPath: 
	[
		String
	],
	Delimiter: String
}