WorkSpan Object API
API change historyOperations on WorkSpan objects
Request
Request URL
Request parameters
-
string
Object ID of object receiving audit information assigned by WorkSpan (long ID)
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Request body containing audit information
{
"field_name": "partner_center.integration_status",
"integration_id": "WS-Integration_XYZabc123",
"external_id": "000owa24575",
"status_code": "CREATE_FAILED",
"message": "Successfully created Referral in Partner Center."
}
{
"type": "object",
"required": [
"field_name",
"status_code",
"message"
],
"properties": {
"field_name": {
"description": "Field name of Audit Field in WorkSpan.",
"type": "string",
"enum": [
"partner_center.integration_status"
],
"example": "partner_center.integration_status"
},
"integration_id": {
"description": "Object ID of related integration assigned by WorkSpan (long ID)",
"type": "string",
"example": "WS-Integration_XYZabc123"
},
"external_id": {
"description": "ID from external system (ex. CRM)",
"type": "string",
"example": "000owa24575"
},
"status_code": {
"description": "Code representing status of audit request.",
"type": "string",
"enum": [
"SCHEDULED",
"CREATE_FAILED",
"UPDATE_FAILED",
"LINKED"
],
"example": "CREATE_FAILED"
},
"message": {
"description": "Detailed Information about audit request",
"type": "string",
"example": "Successfully created Referral in Partner Center."
}
}
}
Responses
200 OK
Audit update is successful
Representations
{
"object_id": "WS-Project_agpzfndzLWF.",
"field_name": "partner_center.integration_status",
"status_code": "LINKED"
}
{
"type": "object",
"properties": {
"object_id": {
"type": "string",
"description": "Object ID assigned by WorkSpan (long ID) of audited object"
},
"field_name": {
"type": "string",
"description": "Name of WorkSpan field that was updated"
},
"status_code": {
"type": "string",
"description": "Value of WorkSpan field after the audit request"
}
},
"example": {
"object_id": "WS-Project_agpzfndzLWF.",
"field_name": "partner_center.integration_status",
"status_code": "LINKED"
}
}
400 Bad Request
Invalid input.
Representations
401 Unauthorized
Authorization Error
Representations
404 Not Found
WorkSpan object not found
Representations
Code samples
@ECHO OFF
curl -v -X PATCH "https://api-sandbox.workspan.com/app/v1/object/{object_id}/audit"
-H "Content-Type: application/json"
--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
var uri = "https://api-sandbox.workspan.com/app/v1/object/{object_id}/audit?" + queryString;
}
}
}
// // 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/app/v1/object/{object_id}/audit");
URI uri = builder.build();
HttpPatch request = new HttpPatch(uri);
request.setHeader("Content-Type", "application/json");
// 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
};
$.ajax({
url: "https://api-sandbox.workspan.com/app/v1/object/{object_id}/audit?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
},
type: "PATCH",
// 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/app/v1/object/{object_id}/audit";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PATCH"];
// Request headers
[_request setValue:@"application/json" 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/app/v1/object/{object_id}/audit');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PATCH);
// 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': 'application/json',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api-sandbox.workspan.com')
conn.request("PATCH", "/app/v1/object/{object_id}/audit?%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': 'application/json',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api-sandbox.workspan.com')
conn.request("PATCH", "/app/v1/object/{object_id}/audit?%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/app/v1/object/{object_id}/audit')
request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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