Loading...
NAV Navbar
Shell HTTP JavaScript Node.JS Python Ruby Java

AppWise API Reference

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

AppWise is an Intelligent Workspace integrated with 40+ cloud apps like Google Apps, Salesforce, Box, Dropbox, Asana, Microsoft Exchange and more (see the full list here https://www.appdirect.com/products/appwise/features/integrations).

The AppWise Search API enables you to build full-text search into your applications and workflows so you can provide contextual information to your users such a list of apps that contain the search term they’re looking for or providing auto-complete as they’re typing a name.

Use the following URL format to send API calls:

https://{marketplaceURL}/api/{endpoint}

For example:

https://myMarketplace.com/api/v2/users/me/company/clicks

Generated on 2018-11-07 11:14:11 EST

Companies

Add a document to designated Company index. Request needs to be made via a user account authorized to publish to the Company index.

Example request


curl -X post https://{marketplaceURL}/api/v2/companies/{company_id}/index/ \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

POST https://{marketplaceURL}/api/v2/companies/{company_id}/index/ HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/companies/{company_id}/index/',
  method: 'post',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/companies/{company_id}/index/',
{
  method: 'POST',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/companies/{company_id}/index/',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/companies/{company_id}/index/',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/companies/{company_id}/index/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/companies/{company_id}/index/

Add a document to designated Company index. Request needs to be made via a user account authorized to publish to the Company index.

Parameters

Parameter Type Data Type Default Description
*company_id path string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Inbound Events

Ingest Event

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v1/connectors/{source}/events <<EOF
{
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
}
EOF

POST https://{marketplaceURL}/api/v1/connectors/{source}/events HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v1/connectors/{source}/events',
  method: 'post',
  dataType: 'json',
  data: {
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v1/connectors/{source}/events',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v1/connectors/{source}/events',
payload={
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v1/connectors/{source}/events',
json={
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v1/connectors/{source}/events");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"key\": {" +
    "\"instance\": \"myclient.myapp.com\"," +
    "\"resourceId\": \"2222-uuid-3333\"," +
    "\"source\": \"product-uuid-1233\"" +
  "}" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v1/connectors/{source}/events

Ingests a given event according to the data provided. As long as the data adheres to the standard structure defined below, the events will be parsed, transformed properly not just by AppWise Events but all other downstream microservices (Feeds, Streams and Content Ingestion/Search). Moreover AppWise will track changes to the lifecycle of resources, as embodied by received events.

Parameters

Parameter Type Data Type Default Description
*source path string

Body Parameters

An event that contains the full context for multiple aspects of AppWise: Identifier of the resource affected by the change, Formal description of the change, Resource lifecycle controls, Resource attributes affected by the change, Users affected by the change, Control data for AppWise Streams, Content Ingestion etc.

InboundEvent object:

Property Type Description
action Action Description of changes in the event.
actor User User who made the change.
changes Changes List of field and user access changes to apply to the resource.
contents array of Content List of content items that belong to the resource.
initial Changes List of fields and users to initialize the resource with.
key Key Event key
messages array of Message Messages to send about the event.

Responses

Status Meaning Description Definition
200 OK Success
400 Bad Request Json Processing Exception
500 Internal Server Error Event body is missing or not a JSON

Inbound Provisioning

Provision Inbound User (WIP)

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v1/connectors/inbound/accounts <<EOF
{
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
}
EOF

POST https://{marketplaceURL}/api/v1/connectors/inbound/accounts HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v1/connectors/inbound/accounts',
  method: 'post',
  dataType: 'json',
  data: {
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v1/connectors/inbound/accounts',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v1/connectors/inbound/accounts',
payload={
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v1/connectors/inbound/accounts',
json={
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v1/connectors/inbound/accounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"app\": {" +
    "\"id\": \"731c6ad5-8f9d-4d37-97f6-101cc0426e22\"" +
  "}," +
  "\"user\": {" +
    "\"companyId\": \"0b235890-c58b-425c-b2bc-f272b5b819ea\"," +
    "\"handle\": \"ian.harris\"," +
    "\"userId\": \"351668c4-9b7f-4bdf-a5d6-65bbb23dca8f\"" +
  "}" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Example response

{
  "body": {
    "knownEmpty": false
  }
}

POST /v1/connectors/inbound/accounts

Creates a new user service entry in AppWise with the provided user information. If successful, the user and service will be provisioned and AppWise will be ready to ingest events from the user's interaction with the app.

Body Parameters

A provisioning request that contains information about the user and app. The information will be used to set up the app's record in AppWise (if it was not set up already) and connect the users account to the app in AppWise.

InboundProvisioningRequest object:

Property Type Description
app App App to provision
user UserForProvisioning User to provision (connect to the app)

Responses

Status Meaning Description Definition
200 OK successful operation Result
201 Created Success: user and service are provisioned
400 Bad Request Input is invalid or malformed
404 Not Found The provided Marketplace service and/or AppWise user were not found
409 Conflict Inputs are valid, but this user and handle are already connected to the service
502 Bad Gateway Internal AppWise services are unavailable

JSON Web Tokens

API View that receives a POST with a user's username and password.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/jwt-token-auth/ <<EOF
{
  "password": "...",
  "username": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/jwt-token-auth/ HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "password": "...",
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/jwt-token-auth/',
  method: 'post',
  dataType: 'json',
  data: {
  "password": "...",
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "password": "...",
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/jwt-token-auth/',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/jwt-token-auth/',
payload={
  "password": "...",
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/jwt-token-auth/',
json={
  "password": "...",
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/jwt-token-auth/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"password\": \"...\"," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/jwt-token-auth/

API View that receives a POST with a user's username and password.

Returns a JSON Web Token that can be used for authenticated requests.

Body Parameters

jwt-token-auth_create object:

Property Type Description
password string
username string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

API View that returns a refreshed token (with new expiration) based on

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/jwt-token-refresh/ <<EOF
{
  "token": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/jwt-token-refresh/ HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "token": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/jwt-token-refresh/',
  method: 'post',
  dataType: 'json',
  data: {
  "token": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "token": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/jwt-token-refresh/',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/jwt-token-refresh/',
payload={
  "token": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/jwt-token-refresh/',
json={
  "token": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/jwt-token-refresh/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"token\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/jwt-token-refresh/

API View that returns a refreshed token (with new expiration) based on existing token

If 'orig_iat' field (original issued-at-time) is found, will first check if it's within expiration window, then copy it to the new token

Body Parameters

jwt-token-refresh_create object:

Property Type Description
token string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

API View that checks the veracity of a token, returning the token if it

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/jwt-token-verify/ <<EOF
{
  "token": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/jwt-token-verify/ HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "token": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/jwt-token-verify/',
  method: 'post',
  dataType: 'json',
  data: {
  "token": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "token": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/jwt-token-verify/',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/jwt-token-verify/',
payload={
  "token": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/jwt-token-verify/',
json={
  "token": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/jwt-token-verify/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"token\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/jwt-token-verify/

API View that checks the veracity of a token, returning the token if it is valid.

Body Parameters

jwt-token-verify_create object:

Property Type Description
token string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Marketplaces

Search public content from specified AppDirect Marketplace.

Example request


curl -X get https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/marketplaces/{base_url}/index/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/marketplaces/{base_url}/index/search

Search public content from specified AppDirect Marketplace.

Parameters

Parameter Type Data Type Default Description
*base_url path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Refresh API token for use with AppDirect Marketplace APIs.

Example request


curl -X post https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

POST https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh',
  method: 'post',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh',
{
  method: 'POST',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/marketplaces/{base_url}/token/refresh");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/marketplaces/{base_url}/token/refresh

Refresh API token for use with AppDirect Marketplace APIs.

Parameters

Parameter Type Data Type Default Description
*base_url path string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Users

Clears authenticated user session.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/auth/logout/ \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/auth/logout/ HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/auth/logout/',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/auth/logout/',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/auth/logout/',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/auth/logout/',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/auth/logout/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/auth/logout/

Clears authenticated user session.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Exchanges an AppDirect Marketplace token for an AppWise authentication token.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/auth/token/appdirect \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/auth/token/appdirect HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/auth/token/appdirect',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/auth/token/appdirect',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/auth/token/appdirect',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/auth/token/appdirect',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/auth/token/appdirect");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/auth/token/appdirect

Exchanges an AppDirect Marketplace token for an AppWise authentication token.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Creates a short-lived single use token for use with mobile applications.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/auth/token/singleUse \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/auth/token/singleUse HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/auth/token/singleUse',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/auth/token/singleUse',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/auth/token/singleUse',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/auth/token/singleUse',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/auth/token/singleUse");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/auth/token/singleUse

Creates a short-lived single use token for use with mobile applications.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return Identity Provider associated with a user (identified by email).

Example request


curl -X get https://{marketplaceURL}/api/v2/users/idp \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/idp HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/idp',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/idp',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/idp',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/idp',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/idp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/idp

Return Identity Provider associated with a user (identified by email).

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Anonymized list of resources clicked by user's in a company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/clicks \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/clicks HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/clicks',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/clicks',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/clicks',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/clicks',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/clicks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/clicks

Anonymized list of resources clicked by user's in a company.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Get count of documents in user's index.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/documents/indexed \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/documents/indexed HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/documents/indexed',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/documents/indexed',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/documents/indexed',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/documents/indexed',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/documents/indexed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/documents/indexed

Get count of documents in user's index.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return count of number of queries per day.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/queries/day \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/queries/day HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/queries/day',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/queries/day',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/queries/day',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/queries/day',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/queries/day");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/queries/day

Return count of number of queries per day.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return count of number of queries per search term or phrase.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/queries/term \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/queries/term HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/queries/term',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/queries/term',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/queries/term',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/queries/term',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/queries/term");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/queries/term

Return count of number of queries per search term or phrase.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return count of number of queries per user in a company account.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/queries/user \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/queries/user HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/queries/user',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/queries/user',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/queries/user',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/queries/user',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/queries/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/queries/user

Return count of number of queries per user in a company account.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List SAML certificates associated with company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/saml-certificates \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/saml-certificates HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/saml-certificates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/saml-certificates

List SAML certificates associated with company.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List services available for authenticated user's company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/services \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/services HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/services',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/services',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/services',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/services',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/services");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/services

List services available for authenticated user's company.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List synonyms associated with company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/synonyms \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/synonyms HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/synonyms',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/synonyms',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/synonyms',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/synonyms',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/synonyms

List synonyms associated with company.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List users associated with company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/me/company/users \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/me/company/users HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/users',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/users',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/me/company/users',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/me/company/users',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/me/company/users

List users associated with company.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return a single user by their username.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/username/{user_name} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/username/{user_name} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/username/{user_name}',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/username/{user_name}',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/username/{user_name}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/username/{user_name}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/username/{user_name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/username/{user_name}

Return a single user by their username.

Parameters

Parameter Type Data Type Default Description
*user_name path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Anonymized list of resources clicked by user's in a company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/clicks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/clicks

Anonymized list of resources clicked by user's in a company.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Get count of documents in user's index.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/documents/indexed");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/documents/indexed

Get count of documents in user's index.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return count of number of queries per day.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/day");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/queries/day

Return count of number of queries per day.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return count of number of queries per search term or phrase.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/term");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/queries/term

Return count of number of queries per search term or phrase.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return count of number of queries per user in a company account.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/queries/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/queries/user

Return count of number of queries per user in a company account.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List SAML certificates associated with company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/saml-certificates

List SAML certificates associated with company.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List services available for authenticated user's company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/services

List services available for authenticated user's company.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List synonyms associated with company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/synonyms

List synonyms associated with company.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List users associated with company.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/companies/{company_id}/users

List users associated with company.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List digests.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/digests \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/digests HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/digests',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/digests',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/digests',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/digests',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/digests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/digests

List digests.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Simple lookup to verify whether designated user account exists.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/exists \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/exists HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/exists',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/exists',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/exists',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/exists',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/exists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/exists

Simple lookup to verify whether designated user account exists.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns the closest matching phrase or sentence based on partial characters of a word or phrase.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/autocomplete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/autocomplete

Returns the closest matching phrase or sentence based on partial characters of a word or phrase.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Retrieve specific document from index.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/documents/{document_id}

Retrieve specific document from index.

Parameters

Parameter Type Data Type Default Description
*document_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Experimentatal search endpoint which can be used to compare the effectiveness of different algorithms.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/experiment-search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/experiment-search

Experimentatal search endpoint which can be used to compare the effectiveness of different algorithms.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns collection counts for documents by classification: content type, source application, date range.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/facets \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/facets HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/facets',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/facets',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/facets',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/facets',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/facets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/facets

Returns collection counts for documents by classification: content type, source application, date range.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns collection counts for sub-sections of the AppDirect Marketplace.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name}',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name}',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/facets/{service_name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/facets/{service_name}

Returns collection counts for sub-sections of the AppDirect Marketplace.

Parameters

Parameter Type Data Type Default Description
*service_name path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns facets for content only within the designated folder.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/facets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/folder/facets

Returns facets for content only within the designated folder.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Searches only within the designated folder.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/folder/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/folder/search

Searches only within the designated folder.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns most recently updated documents from across the user's connected accounts.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/recent \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/recent HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/recent',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/recent',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/recent',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/recent',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/recent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/recent

Returns most recently updated documents from across the user's connected accounts.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Searches across unified index of content derived from user's connected accounts.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/search \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/search HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/search',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/search',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/search',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/search',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/search

Searches across unified index of content derived from user's connected accounts.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns list of terms which are semantically similar to the query search terms.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/semantic-similarity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/semantic-similarity

Returns list of terms which are semantically similar to the query search terms.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns suggestions for words in the search query which may have been mis-typed.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/spelling");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/spelling

Returns suggestions for words in the search query which may have been mis-typed.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns stats about the user's index: number of documents, number of services connected.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/stats \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/stats HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/stats',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/stats',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/stats',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/stats',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/stats");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/stats

Returns stats about the user's index: number of documents, number of services connected.

Sample payload

{
    "storm_user_id":"3",
    "service_id":"11390",
    "utc_last_index_timestamp":"2015-08-28T19:08:22Z",
    "source":"jira",
    "id":"11390-11862",
    "last_modified":"2011-08-21T07:38:07.000+0000",
    "utc_last_modified":"2011-08-21T07:38:07Z",
    "utc_xendo_sort_timestamp":"2011-08-21T07:38:07Z",
    "source_content_type":"Sub-task",
    "content_type":"task",
    "title":"Use catalog views for SQLServerManager",
    "status":"Resolved",
    "content":"A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.",
    "endtime":"2011-08-21T07:36:53Z",
    "url":"https://issues.cloudera.org/browse/SQOOP-236",
    "author":"Bilung Lee2",
    "folder":["Sqoop"],
    "imageUrl":"https://issues.cloudera.org/secure/projectavatar?pid=10000"
}

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns a list of phrases and sentences matching the specified search terms.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/suggest");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/suggest

Returns a list of phrases and sentences matching the specified search terms.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Returns a list of synonyms for terms used in the search query. May be used to suggest a modified search query.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/index/synonyms

Returns a list of synonyms for terms used in the search query. May be used to suggest a modified search query.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

User's preferences.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/preferences \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/preferences HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/preferences',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/preferences',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/preferences',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/preferences',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/preferences");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/preferences

User's preferences.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List recent search queries.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/queries \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/queries HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/queries',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/queries',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/queries',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/queries',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/queries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/queries

List recent search queries.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

List user's saved searches.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/saved-searches

List user's saved searches.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Return list of service account connections.

Example request


curl -X get https://{marketplaceURL}/api/v2/users/{user_id}/services \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

GET https://{marketplaceURL}/api/v2/users/{user_id}/services HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/services',
  method: 'get',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/services',
{
  method: 'GET',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.get 'https://{marketplaceURL}/api/v2/users/{user_id}/services',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.get('https://{marketplaceURL}/api/v2/users/{user_id}/services',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/services");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /v2/users/{user_id}/services

Return list of service account connections.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Authenticate user via username and password.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/auth/login/ <<EOF
{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/auth/login/ HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/auth/login/',
  method: 'post',
  dataType: 'json',
  data: {
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/auth/login/',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/auth/login/',
payload={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/auth/login/',
json={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/auth/login/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"company\": \"...\"," +
  "\"company_id\": \"...\"," +
  "\"groups\": []," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/auth/login/

Authenticate user via username and password.

Body Parameters

users_auth_login object:

Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Create SAML certificate for company.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/me/company/saml-certificates <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/me/company/saml-certificates HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',
  method: 'post',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/me/company/saml-certificates',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/saml-certificates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/me/company/saml-certificates

Create SAML certificate for company.

Body Parameters

users_me_company_saml-certificates_create object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Create synoym.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/me/company/synonyms <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/me/company/synonyms HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/synonyms',
  method: 'post',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/synonyms',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/me/company/synonyms',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/me/company/synonyms',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/me/company/synonyms

Create synoym.

Body Parameters

users_me_company_synonyms_create object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Create SAML certificate for company.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',
  method: 'post',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/companies/{company_id}/saml-certificates

Create SAML certificate for company.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Body Parameters

users_companies_saml-certificates_create object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Create synoym.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',
  method: 'post',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/companies/{company_id}/synonyms

Create synoym.

Parameters

Parameter Type Data Type Default Description
*company_id path string
*user_id path string

Body Parameters

users_companies_synonyms_create object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Create digest.

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/digests <<EOF
{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/{user_id}/digests HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/digests',
  method: 'post',
  dataType: 'json',
  data: {
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/digests',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/digests',
payload={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/digests',
json={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/digests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"company\": \"...\"," +
  "\"company_id\": \"...\"," +
  "\"groups\": []," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/digests

Create digest.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Body Parameters

users_digests_create object:

Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Lists the tags associated with a specific document in the index.

Example request


curl -X post https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

POST https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',
  method: 'post',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',
{
  method: 'POST',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/index/documents/{document_id}/tags

Lists the tags associated with a specific document in the index.

Parameters

Parameter Type Data Type Default Description
*document_id path string
*user_id path string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Optimized end-point for processing and indexing files.

Example request


curl -X post https://{marketplaceURL}/api/v2/users/{user_id}/index/file \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

POST https://{marketplaceURL}/api/v2/users/{user_id}/index/file HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/file',
  method: 'post',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/file',
{
  method: 'POST',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/index/file',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/index/file',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/index/file

Optimized end-point for processing and indexing files.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Optimized end-point for indexing messages.

Example request


curl -X post https://{marketplaceURL}/api/v2/users/{user_id}/index/message \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

POST https://{marketplaceURL}/api/v2/users/{user_id}/index/message HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/message',
  method: 'post',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/message',
{
  method: 'POST',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/index/message',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/index/message',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/message");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/index/message

Optimized end-point for indexing messages.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Example request


curl -X post \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches <<EOF
{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
EOF

POST https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',
  method: 'post',
  dataType: 'json',
  data: {
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',
{
  method: 'POST',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',
payload={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches',
json={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
String inputBody = "{" +
  "\"company\": \"...\"," +
  "\"company_id\": \"...\"," +
  "\"groups\": []," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user_id}/saved-searches

Store user's saved search.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Body Parameters

users_saved-searches_create object:

Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Index an individual dashboard with charts from AppInsights.

Example request


curl -X post https://{marketplaceURL}/api/v2/users/{user}/index/chart \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

POST https://{marketplaceURL}/api/v2/users/{user}/index/chart HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user}/index/chart',
  method: 'post',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user}/index/chart',
{
  method: 'POST',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.post 'https://{marketplaceURL}/api/v2/users/{user}/index/chart',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.post('https://{marketplaceURL}/api/v2/users/{user}/index/chart',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user}/index/chart");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /v2/users/{user}/index/chart

Index an individual dashboard with charts from AppInsights.

Parameters

Parameter Type Data Type Default Description
*user path string

Responses

Status Meaning Description Definition
201 Created HTTP_201_CREATED

Associate supported service with company.

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/me/company/services/{id} <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/me/company/services/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/services/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/services/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/me/company/services/{id}',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/me/company/services/{id}',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/services/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/me/company/services/{id}

Associate supported service with company.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.

Body Parameters

users_me_company_set_service object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Associated user with company.

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/me/company/users/{id} <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/me/company/users/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/users/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/users/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/me/company/users/{id}',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/me/company/users/{id}',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/me/company/users/{id}

Associated user with company.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.

Body Parameters

users_me_company_users_update object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Associate supported service with company.

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id} <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id}',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id}',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/services/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/{user_id}/companies/{company_id}/services/{id}

Associate supported service with company.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*company_id path string
*user_id path string

Body Parameters

users_companies_set_service object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Associated user with company.

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id} <<EOF
{
  "domain_name": "...",
  "name": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "domain_name": "...",
  "name": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "domain_name": "...",
  "name": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "domain_name": "...",
  "name": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',
payload={
  "domain_name": "...",
  "name": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',
json={
  "domain_name": "...",
  "name": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"domain_name\": \"...\"," +
  "\"name\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/{user_id}/companies/{company_id}/users/{id}

Associated user with company.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*company_id path string
*user_id path string

Body Parameters

users_companies_users_update object:

Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Update digest.

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id} <<EOF
{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',
payload={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',
json={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"company\": \"...\"," +
  "\"company_id\": \"...\"," +
  "\"groups\": []," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/{user_id}/digests/{id}

Update digest.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*user_id path string

Body Parameters

users_digests_update object:

Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Lists the tags associated with a specific document in the index.

Example request


curl -X put https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

PUT https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',
  method: 'put',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',
{
  method: 'PUT',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/{user_id}/index/documents/{document_id}/tags

Lists the tags associated with a specific document in the index.

Parameters

Parameter Type Data Type Default Description
*document_id path string
*user_id path string

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Set User's preferences.

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id} <<EOF
{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id}',
payload={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id}',
json={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/preferences/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"company\": \"...\"," +
  "\"company_id\": \"...\"," +
  "\"groups\": []," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/{user_id}/preferences/{id}

Set User's preferences.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*user_id path string

Body Parameters

users_set_preferences object:

Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Example request


curl -X put \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-binary @- https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id} <<EOF
{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
EOF

PUT https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}


var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',
  method: 'put',
  dataType: 'json',
  data: {
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
},

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const inputBody = '{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}';
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',
{
  method: 'PUT',body: inputBody,headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.put 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',
payload={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.put('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',
json={
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
String inputBody = "{" +
  "\"company\": \"...\"," +
  "\"company_id\": \"...\"," +
  "\"groups\": []," +
  "\"username\": \"...\"" +
"}";

OutputStream os = conn.getOutputStream();
os.write(inputBody.getBytes("UTF-8"));
os.close();

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /v2/users/{user_id}/saved-searches/{id}

Update user's saved search.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*user_id path string

Body Parameters

users_saved-searches_update object:

Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Status Meaning Description Definition
200 OK HTTP_200_OK

Delete SAML certificate.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/saml-certificates/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/me/company/saml-certificates/{id}

Delete SAML certificate.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete synonym.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/synonyms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/me/company/synonyms/{id}

Delete synonym.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete user.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/me/company/users/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/me/company/users/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/me/company/users/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/me/company/users/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/me/company/users/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/me/company/users/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/me/company/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/me/company/users/{id}

Delete user.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete SAML certificate.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/saml-certificates/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/companies/{company_id}/saml-certificates/{id}

Delete SAML certificate.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete synonym.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/synonyms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/companies/{company_id}/synonyms/{id}

Delete synonym.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete user.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/companies/{company_id}/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/companies/{company_id}/users/{id}

Delete user.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*company_id path string
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete digest.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/digests/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/digests/{id}

Delete digest.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete indexed document.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/index/documents \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/index/documents HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/index/documents

Delete indexed document.

Parameters

Parameter Type Data Type Default Description
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Lists the tags associated with a specific document in the index.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/index/documents/{document_id}/tags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/index/documents/{document_id}/tags

Lists the tags associated with a specific document in the index.

Parameters

Parameter Type Data Type Default Description
*document_id path string
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/saved-searches/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/saved-searches/{id}

Delete user's saved search.

Parameters

Parameter Type Data Type Default Description
*id path integer A unique integer value identifying this user.
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete service account.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id} HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id}',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id}',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id}',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id}',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user_id}/services/{userservice_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user_id}/services/{userservice_id}

Delete service account.

Parameters

Parameter Type Data Type Default Description
*userservice_id path string
*user_id path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Delete specified chart from index.

Example request


curl -X delete https://{marketplaceURL}/api/v2/users/{user}/index/chart \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

DELETE https://{marketplaceURL}/api/v2/users/{user}/index/chart HTTP/1.1
Host: appdirect.com
Content-Type: application/json
Accept: application/json



var headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

$.ajax({
  url: 'https://{marketplaceURL}/api/v2/users/{user}/index/chart',
  method: 'delete',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
const request = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'Content-Type':'application/json'

};

fetch('https://{marketplaceURL}/api/v2/users/{user}/index/chart',
{
  method: 'DELETE',headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'https://{marketplaceURL}/api/v2/users/{user}/index/chart',

params: {
},
headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json',
  'Content-Type': 'application/json'
}

r = requests.delete('https://{marketplaceURL}/api/v2/users/{user}/index/chart',

params={
},
headers = headers)

print r.json()
URL obj = new URL("https://{marketplaceURL}/api/v2/users/{user}/index/chart");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /v2/users/{user}/index/chart

Delete specified chart from index.

Parameters

Parameter Type Data Type Default Description
*user path string

Responses

Status Meaning Description Definition
204 No Content HTTP_204_NO_CONTENT

Definitions

Action


Property Type Description
delete boolean If true, the resource will be deleted.
text string Description of the action to apply as a suffix.
verb string Verb of the action as defined in the integrated app.

App


Property Type Description
iconUrl string A URL pointing to an icon image for the app
id string Application ID
logoUrl string A URL pointing to a logo image for the app
name string Application Name
prettyName string A human-readable app name which will be displayed in the UI

Changes


Property Type Description
fields array of Field Field changes.
users array of User User access changes.

Content


Property Type Description
delete boolean Indicates whether the content will be removed from the resource.
url string Content URL.

Field


Property Type Description
badge boolean Controls whether the value of the fields should be rendered as a badge in Feeds. Default is false.
display string Controls for displaying the field in AppWise. Default is "expanded". Does not apply to some standard fields, eg. "_title".
name string Field name.
op string The operation to apply to the existing field. Default is "replace".
value number New value of field. Can be literal or JSON node.

HttpEntity

{
  "knownEmpty": false
}
Property Type Description
knownEmpty boolean

InboundEvent

{
  "key": {
    "instance": "myclient.myapp.com",
    "resourceId": "2222-uuid-3333",
    "source": "product-uuid-1233"
  }
}
Property Type Description
action Action Description of changes in the event.
actor User User who made the change.
changes Changes List of field and user access changes to apply to the resource.
contents array of Content List of content items that belong to the resource.
initial Changes List of fields and users to initialize the resource with.
key Key Event key
messages array of Message Messages to send about the event.

InboundProvisioningRequest

{
  "app": {
    "id": "731c6ad5-8f9d-4d37-97f6-101cc0426e22"
  },
  "user": {
    "companyId": "0b235890-c58b-425c-b2bc-f272b5b819ea",
    "handle": "ian.harris",
    "userId": "351668c4-9b7f-4bdf-a5d6-65bbb23dca8f"
  }
}
Property Type Description
app App App to provision
user UserForProvisioning User to provision (connect to the app)

jwt-token-auth_create

{
  "password": "...",
  "username": "..."
}
Property Type Description
password string
username string

jwt-token-refresh_create

{
  "token": "..."
}
Property Type Description
token string

jwt-token-verify_create

{
  "token": "..."
}
Property Type Description
token string

Key


Property Type Description
instance string Tenant instance within the application
resourceId string Unique ID of the resource in the instance.
source string Application identifier
timestamp integer UTC timestamp of when the event occurred in epoch format, with millisecond precision.

Message


Property Type Description
recipient User Recipient user.
text string Description of the action to apply as a suffix.

Result

{
  "body": {
    "knownEmpty": false
  }
}
Property Type Description
body HttpEntity

User


Property Type Description
delete boolean If true, the user's access to the resource will be revoked.
identifier string Identifier of the user in the integrated app.
name string Name of the user in the integrated app. Should be full name (first name + " " + last name) if available.

UserForProvisioning


Property Type Description
companyId string The user's company UUID
handle string The user's ISV handle
userId string The user's UUID

users_auth_login

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

users_companies_saml-certificates_create

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_companies_set_service

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_companies_synonyms_create

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_companies_users_update

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_digests_create

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

users_digests_update

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

users_me_company_saml-certificates_create

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_me_company_set_service

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_me_company_synonyms_create

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_me_company_users_update

{
  "domain_name": "...",
  "name": "..."
}
Property Type Description
account_type string
domain_name string
logo string
logo_url string
name string
seats_available integer
seats_used integer

users_saved-searches_create

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

users_saved-searches_update

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

users_set_preferences

{
  "company": "...",
  "company_id": "...",
  "groups": [],
  "username": "..."
}
Property Type Description
company string
company_id string
email string
first_name string
groups array of string
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_name string
username string Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.