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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Catalogs

Namespace Global

    Namespace Field2Office.API.Model.Catalogs

        '''<Summary>
        '''Bulk import a catalog from a csv file.
        '''</Summary>
        Public Partial Class CatalogImport
            Public Sub New()
                Mappings = New Dictionary(Of String, String)
                CategoryPath = New List(Of String)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property Id As String
            Public Overridable Property Type As String
            Public Overridable Property Mappings As Dictionary(Of String, String)
            Public Overridable Property CategoryPath As List(Of String)
            Public Overridable Property Delimiter As String
        End Class
    End Namespace
End Namespace

VB.NET 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
}