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
namespace Field2Office.API.Model.Catalogs

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Bulk import a catalog from a csv file.
    ///</summary>
    [<AllowNullLiteral>]
    type CatalogImport() = 
        member val Workspace:String = null with get,set
        member val Id:String = null with get,set
        member val Type:String = null with get,set
        member val Mappings:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val CategoryPath:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Delimiter:String = null with get,set

F# CatalogImport DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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