WorkSpan Bulk API

API change history

Use this API to load objects in bulk

Get Status of execution of integration using integration id

Check the execution status of your integration.

Try it

Request

Request URL

Request parameters

  • string

    Integration ID that is configured in WorkSpan App

  • string

    Execution ID of an integration execution which is returned from bulk API

  • (optional)
    boolean

    Include errors in the response if there are any errors

  • (optional)
    number

    Maximum number of errors to return back in the response

Request body

Responses

200 OK

Execution is retrieved successfully

Representations

{
  "integration_id": "WS-Integration_agpzfndzLW",
  "execution_id": "a64690c2450",
  "status": "completed",
  "input_count": 200,
  "error_count": 3,
  "success_count": 197,
  "skip_count": 0,
  "started_at": "2020-05-07T14:06:57.572Z",
  "completed_at": "2020-05-07T14:07:10.572Z",
  "include_errors": true,
  "errors": [
    {
      "id": "aw00079",
      "message": "invalid value in field 'close_date'",
      "data_row": {
        "opportunity_id": "aw00079",
        "close_date": "20-jan-2020",
        "amount": 250000
      }
    },
    {
      "id": "aw00082",
      "message": "invalid value in field 'amount'",
      "data_row": {
        "opportunity_id": "aw00082",
        "close_date": "2021-01-20",
        "amount": "-"
      }
    },
    {
      "id": "",
      "message": "Missing value of key field",
      "data_row": {
        "opportunity_id": "",
        "close_date": "2020-10-20",
        "amount": 75000
      }
    }
  ]
}
{
  "type": "object",
  "properties": {
    "integration_id": {
      "type": "string",
      "description": "Integration ID"
    },
    "execution_id": {
      "type": "string",
      "description": "Execution ID"
    },
    "status": {
      "type": "string",
      "description": "Status of execution",
      "enum": [
        "running",
        "completed"
      ]
    },
    "status_msg": {
      "type": "string",
      "description": "Status message for execution if execution has failed"
    },
    "success_count": {
      "type": "number",
      "description": "Number of records that were processed successfully"
    },
    "error_count": {
      "type": "number",
      "description": "Number of records with errors"
    },
    "input_count": {
      "type": "number",
      "description": "Number of records received"
    },
    "skip_count": {
      "type": "number",
      "description": "Number of records skipped"
    },
    "started_at": {
      "type": "string",
      "description": "Timestamp of starting execution",
      "format": "date-time"
    },
    "completed_at": {
      "type": "string",
      "description": "Timestamp of completing execution",
      "format": "date-time"
    },
    "max_errors": {
      "type": "number",
      "description": "Maximum number of errors to return"
    },
    "include_errors": {
      "type": "boolean",
      "description": "Flag which indicates whether errors will be returned in the response if any"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "id": {
            "type": "string",
            "description": "ID of the record which failed"
          },
          "data_row": {
            "type": "string",
            "description": "The data row which failed"
          }
        }
      }
    }
  },
  "example": {
    "integration_id": "WS-Integration_agpzfndzLW",
    "execution_id": "a64690c2450",
    "status": "completed",
    "input_count": 200,
    "error_count": 3,
    "success_count": 197,
    "skip_count": 0,
    "started_at": "2020-05-07T14:06:57.572Z",
    "completed_at": "2020-05-07T14:07:10.572Z",
    "include_errors": true,
    "errors": [
      {
        "id": "aw00079",
        "message": "invalid value in field 'close_date'",
        "data_row": {
          "opportunity_id": "aw00079",
          "close_date": "20-jan-2020",
          "amount": 250000
        }
      },
      {
        "id": "aw00082",
        "message": "invalid value in field 'amount'",
        "data_row": {
          "opportunity_id": "aw00082",
          "close_date": "2021-01-20",
          "amount": "-"
        }
      },
      {
        "id": "",
        "message": "Missing value of key field",
        "data_row": {
          "opportunity_id": "",
          "close_date": "2020-10-20",
          "amount": 75000
        }
      }
    ]
  }
}

400 Bad Request

invalid execution_id

Representations

401 Unauthorized

Authorization Error

Representations

404 Not Found

integration_id or execution_id not found

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://api-sandbox.workspan.com/bulk/v1/status/{integration_id}?execution_id={execution_id}?include_errors=false&max_errors=10"

--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 parameters
            queryString["include_errors"] = "false";
            queryString["max_errors"] = "10";
            var uri = "https://api-sandbox.workspan.com/bulk/v1/status/{integration_id}?execution_id={execution_id}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/status/{integration_id}?execution_id={execution_id}");

            builder.setParameter("include_errors", "false");
            builder.setParameter("max_errors", "10");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // 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
            "include_errors": "false",
            "max_errors": "10",
        };
      
        $.ajax({
            url: "https://api-sandbox.workspan.com/bulk/v1/status/{integration_id}?execution_id={execution_id}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "GET",
            // 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/status/{integration_id}?execution_id={execution_id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"include_errors=false",
                         @"max_errors=10",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // 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/status/{integration_id}?execution_id={execution_id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'include_errors' => 'false',
    'max_errors' => '10',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// 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 = {
}

params = urllib.urlencode({
    # Request parameters
    'include_errors': 'false',
    'max_errors': '10',
})

try:
    conn = httplib.HTTPSConnection('api-sandbox.workspan.com')
    conn.request("GET", "/bulk/v1/status/{integration_id}?execution_id={execution_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 = {
}

params = urllib.parse.urlencode({
    # Request parameters
    'include_errors': 'false',
    'max_errors': '10',
})

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

query = URI.encode_www_form({
    # Request parameters
    'include_errors' => 'false',
    'max_errors' => '10'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# 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