WorkSpan Bulk API

API change history

Use this API to load objects in bulk

Bulk Load Objects to WorkSpan

Bulk Load Objects to WorkSpan. Data can be attached to the request body as JSON/CSV format, or attached as a JSON/CSV/XLSX file.

Try it

Request

Request URL

Request parameters

  • string

    Integration ID of CRM integration that is configured in WorkSpan App

  • (optional)
    string

    The format of the data which is sent in the request body or in the attached file; this is case insensitive

  • (optional)
    string

    The column delimiter for the CSV data that is passed in or attached; default is ','

Request headers

  • (optional)
    string
    Media type of the body sent to the API.

Request body

For content type 'CSV', data rows are as csv data format; first row will be column headers. For content type 'JSON', data format is array: [ { key1 : value, key2 : value}, { key1 : value, key2 : value } ]

Responses

200 OK

data uploaded

Representations

{
  "integration_id": "WS-Integration_agpzfndzLW",
  "execution_id": "a64690c2450",
  "created_at": "2020-05-18T14:06:57.572Z",
  "data_format": "JSON"
}
{
  "type": "object",
  "properties": {
    "integration_id": {
      "type": "string",
      "description": "Integration ID"
    },
    "execution_id": {
      "type": "string",
      "description": "Execution ID"
    },
    "created_at": {
      "type": "string",
      "description": "Creation time",
      "format": "date-time"
    },
    "data_format": {
      "type": "string",
      "description": "The format of the data which is sent in the request body or in the attached file"
    },
    "column_delimiter": {
      "type": "string",
      "description": "The column delimiter for the CSV data that is passed in or attached; default is ','"
    }
  },
  "example": {
    "integration_id": "WS-Integration_agpzfndzLW",
    "execution_id": "a64690c2450",
    "created_at": "2020-05-18T14:06:57.572Z",
    "data_format": "JSON"
  }
}

400 Bad Request

invalid input, object invalid

Representations

401 Unauthorized

Authorization Error

Representations

Code samples

@ECHO OFF

curl -v -X POST "https://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}?data_format=CSV&column_delimiter=,"
-H "Content-Type: plain/text"

--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

            // Request parameters
            queryString["data_format"] = "CSV";
            queryString["column_delimiter"] = ",";
            var uri = "https://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}&" + 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://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}");

            builder.setParameter("data_format", "CSV");
            builder.setParameter("column_delimiter", ",");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "plain/text");


            // 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
            "data_format": "CSV",
            "column_delimiter": ",",
        };
      
        $.ajax({
            url: "https://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","plain/text");
            },
            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://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"data_format=CSV",
                         @"column_delimiter=,",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"plain/text" forHTTPHeaderField:@"Content-Type"];
    // 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://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'plain/text',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'data_format' => 'CSV',
    'column_delimiter' => ',',
);

$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': 'plain/text',
}

params = urllib.urlencode({
    # Request parameters
    'data_format': 'CSV',
    'column_delimiter': ',',
})

try:
    conn = httplib.HTTPSConnection('api-sandbox.workspan.com')
    conn.request("POST", "/bulk/v1/bulkload?integration_id={integration_id}&%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': 'plain/text',
}

params = urllib.parse.urlencode({
    # Request parameters
    'data_format': 'CSV',
    'column_delimiter': ',',
})

try:
    conn = http.client.HTTPSConnection('api-sandbox.workspan.com')
    conn.request("POST", "/bulk/v1/bulkload?integration_id={integration_id}&%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://api-sandbox.workspan.com/bulk/v1/bulkload?integration_id={integration_id}')

query = URI.encode_www_form({
    # Request parameters
    'data_format' => 'CSV',
    'column_delimiter' => ','
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'plain/text'
# 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