Introduction

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

BYRD API provides a simple and consistent way that allows developers to build on top of BYRD via structured data and in predictable formats using RESTful endpoints.

We are continuously improving and adding new endpoints to the API. For any questions or feedback, please use this form.

Authentication

Code samples

# You can also use wget
# This curl statement will return a REST Representation of
# the current data model
curl -X GET /v1/datamodel/current \
  --user username:password

# This statement will return a REST Representation of
# the current data model

GET /v1/datamodel/current HTTP/1.1

Authorization: username:password

// This code will return a REST Representation of
// the current data model

const headers = {
  'Authorization':'username:password'
};

fetch('/v1/datamodel/current',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
  return res.json();
}).then(function(body) {
  console.log(body);
});

# This code will return a REST Representation of
# the current data model

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'username:password'
}

result = RestClient.get '/v1/datamodel/current',
  params: {
  }, headers: headers

p JSON.parse(result)

# This code will return a REST Representation of
# the current data model

import requests
headers = {
  'Authorization': 'username:password'
}

r = requests.get('/v1/datamodel/current', headers = headers)

print(r.json())

<?php
// This code will return a REST Representation of
// the current data model

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'username:password',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/datamodel/current', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

// This code will return a REST Representation of
// the current data model

URL obj = new URL("/v1/datamodel/current");
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());

// This code will return a REST Representation of
// the current data model

package main

import (
  "bytes"
  "net/http"
)

func main() {
  headers := map[string][]string{
      "Authorization": []string{"username:password"},
  }

  data := bytes.NewBuffer([]byte{jsonReq})
  req, err := http.NewRequest("GET", "/v1/datamodel/current", data)
  req.Header = headers

  client := &http.Client{}
  resp, err := client.Do(req)
  // ...
}

Most of the information can be obtained or sent to the system via simple HTTP GET and HTTP POST calls. The available endpoints are described in this documentation.

To obtain a connection to the system you need to pass your login credentials as Basic Authentication scheme in your Authorization Header.

Asset Folders

Documents, media files and folders management resource

convertToPublicAsset

Code samples

# You can also use wget
curl -X PUT /v1/assetFolders/_convertToPublicAsset{path} \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

PUT /v1/assetFolders/_convertToPublicAsset{path} HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_convertToPublicAsset{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.put '/v1/assetFolders/_convertToPublicAsset{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.put('/v1/assetFolders/_convertToPublicAsset{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/assetFolders/_convertToPublicAsset{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_convertToPublicAsset{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/assetFolders/_convertToPublicAsset{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/assetFolders/_convertToPublicAsset{path}

Convert an asset to a public asset

Body parameter

Parameters

Name	In	Type	Required	Description
path	path	string	true	none
body	body	FolderPathName	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

deleteItems

Code samples

# You can also use wget
curl -X DELETE /v1/assetFolders/_deleteItems \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

DELETE /v1/assetFolders/_deleteItems HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_deleteItems',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.delete '/v1/assetFolders/_deleteItems',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.delete('/v1/assetFolders/_deleteItems', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/assetFolders/_deleteItems', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_deleteItems");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/assetFolders/_deleteItems", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/assetFolders/_deleteItems

Delete assets/folders with the given paths

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	object	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

deleteItem

Code samples

# You can also use wget
curl -X DELETE /v1/assetFolders/_delete{path} \
  -H 'Accept: application/json; charset=UTF-8'

DELETE /v1/assetFolders/_delete{path} HTTP/1.1

Accept: application/json; charset=UTF-8

const headers = {
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_delete{path}',
{
  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; charset=UTF-8'
}

result = RestClient.delete '/v1/assetFolders/_delete{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.delete('/v1/assetFolders/_delete{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/assetFolders/_delete{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_delete{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/assetFolders/_delete{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/assetFolders/_delete{path}

Delete asset/folder with the given path

Parameters

Name	In	Type	Required	Description
path	path	string	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

getDetailsOfAnAssetFolderLink

Code samples

# You can also use wget
curl -X GET /v1/assetFolders/_getDetails{path} \
  -H 'Accept: application/json'

GET /v1/assetFolders/_getDetails{path} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/v1/assetFolders/_getDetails{path}',
{
  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'
}

result = RestClient.get '/v1/assetFolders/_getDetails{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/assetFolders/_getDetails{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/assetFolders/_getDetails{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_getDetails{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/assetFolders/_getDetails{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/assetFolders/_getDetails{path}

Get folder details by its path

Parameters

Name	In	Type	Required	Description
path	path	string	true	none

Example responses

200 Response

{
  "changedAt": "2019-08-24T14:15:22Z",
  "changedBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "linkType": "ASSET",
  "name": "string",
  "parentFolderId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	none	AssetFolderLink

moveAsset

Code samples

# You can also use wget
curl -X PUT /v1/assetFolders/_moveAsset{path} \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

PUT /v1/assetFolders/_moveAsset{path} HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_moveAsset{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.put '/v1/assetFolders/_moveAsset{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.put('/v1/assetFolders/_moveAsset{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/assetFolders/_moveAsset{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_moveAsset{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/assetFolders/_moveAsset{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/assetFolders/_moveAsset{path}

Move asset to the given path

Body parameter

Parameters

Name	In	Type	Required	Description
path	path	string	true	none
body	body	FolderPathName	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

moveFolder

Code samples

# You can also use wget
curl -X PUT /v1/assetFolders/_moveFolder{path} \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

PUT /v1/assetFolders/_moveFolder{path} HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_moveFolder{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.put '/v1/assetFolders/_moveFolder{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.put('/v1/assetFolders/_moveFolder{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/assetFolders/_moveFolder{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_moveFolder{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/assetFolders/_moveFolder{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/assetFolders/_moveFolder{path}

Move folder to the given path

Body parameter

Parameters

Name	In	Type	Required	Description
path	path	string	true	none
body	body	FolderPathName	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

renameAsset

Code samples

# You can also use wget
curl -X PUT /v1/assetFolders/_renameAsset{path} \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

PUT /v1/assetFolders/_renameAsset{path} HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_renameAsset{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.put '/v1/assetFolders/_renameAsset{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.put('/v1/assetFolders/_renameAsset{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/assetFolders/_renameAsset{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_renameAsset{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/assetFolders/_renameAsset{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/assetFolders/_renameAsset{path}

Rename asset to the given name

Body parameter

Parameters

Name	In	Type	Required	Description
path	path	string	true	none
body	body	FolderPathName	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

renameFolder

Code samples

# You can also use wget
curl -X PUT /v1/assetFolders/_renameFolder{path} \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

PUT /v1/assetFolders/_renameFolder{path} HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_renameFolder{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.put '/v1/assetFolders/_renameFolder{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.put('/v1/assetFolders/_renameFolder{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/assetFolders/_renameFolder{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_renameFolder{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/assetFolders/_renameFolder{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/assetFolders/_renameFolder{path}

Rename folder to the given name

Body parameter

Parameters

Name	In	Type	Required	Description
path	path	string	true	none
body	body	FolderPathName	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

uploadArchive

Code samples

# You can also use wget
curl -X POST /v1/assetFolders/_uploadArchive{path} \
  -H 'Accept: application/json; charset=UTF-8'

POST /v1/assetFolders/_uploadArchive{path} HTTP/1.1

Accept: application/json; charset=UTF-8

const headers = {
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_uploadArchive{path}',
{
  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; charset=UTF-8'
}

result = RestClient.post '/v1/assetFolders/_uploadArchive{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.post('/v1/assetFolders/_uploadArchive{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/assetFolders/_uploadArchive{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_uploadArchive{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/assetFolders/_uploadArchive{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/assetFolders/_uploadArchive{path}

Upload an archive file and uncompress it to the given folder path

Parameters

Name	In	Type	Required	Description
path	path	string	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

uploadFile

Code samples

# You can also use wget
curl -X POST /v1/assetFolders/_uploadFile{path} \
  -H 'Accept: application/json; charset=UTF-8'

POST /v1/assetFolders/_uploadFile{path} HTTP/1.1

Accept: application/json; charset=UTF-8

const headers = {
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders/_uploadFile{path}',
{
  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; charset=UTF-8'
}

result = RestClient.post '/v1/assetFolders/_uploadFile{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.post('/v1/assetFolders/_uploadFile{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/assetFolders/_uploadFile{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders/_uploadFile{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/assetFolders/_uploadFile{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/assetFolders/_uploadFile{path}

Upload a file to the given folder path

Parameters

Name	In	Type	Required	Description
path	path	string	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

getFolderContent

Code samples

# You can also use wget
curl -X GET /v1/assetFolders{path} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: string'

GET /v1/assetFolders{path} HTTP/1.1

Accept: application/json
If-None-Match: string

const headers = {
  'Accept':'application/json',
  'If-None-Match':'string'
};

fetch('/v1/assetFolders{path}',
{
  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',
  'If-None-Match' => 'string'
}

result = RestClient.get '/v1/assetFolders{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'string'
}

r = requests.get('/v1/assetFolders{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'If-None-Match' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/assetFolders{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-None-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/assetFolders{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/assetFolders{path}

Get a folder content by its path

Parameters

Name	In	Type	Required	Description
If-None-Match	header	string	false	none
allowCaching	query	boolean	false	none
download	query	boolean	false	none
path	path	string	true	none

Example responses

200 Response

[
  {
    "changedAt": "2019-08-24T14:15:22Z",
    "changedBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "linkType": "ASSET",
    "name": "string",
    "parentFolderId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AssetFolderLink]	false	none	none
» changedAt	string(date-time)	false	none	none
» changedBy	string	false	none	none
» createdAt	string(date-time)	false	none	none
» createdBy	string	false	none	none
» linkType	string	false	none	none
» name	string	false	none	none
» parentFolderId	integer(int64)	false	none	none

Enumerated Values

Property	Value
linkType	ASSET
linkType	FOLDER

createFolder

Code samples

# You can also use wget
curl -X POST /v1/assetFolders{path} \
  -H 'Content-Type: */*' \
  -H 'Accept: application/json; charset=UTF-8'

POST /v1/assetFolders{path} HTTP/1.1

Content-Type: */*
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/assetFolders{path}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.post '/v1/assetFolders{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.post('/v1/assetFolders{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => '*/*',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/assetFolders{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/assetFolders{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/assetFolders{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/assetFolders{path}

Create a folder in the specified path

Body parameter

Parameters

Name	In	Type	Required	Description
path	path	string	true	none
body	body	FolderPathName	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Bulk subscriptions

A bulk subscription is used to retrieve a bulk of items based on a set of criteria. The bulk subscription entries are used to define such criteria. Each entry is a tuple of attributes and their values.

getBulkSubscriptions

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription \
  -H 'Accept: application/json; charset=UTF-8' \
  -H 'x-cursor: string'

GET /v1/bulkSubscription HTTP/1.1

Accept: application/json; charset=UTF-8
x-cursor: string

const headers = {
  'Accept':'application/json; charset=UTF-8',
  'x-cursor':'string'
};

fetch('/v1/bulkSubscription',
{
  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; charset=UTF-8',
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/bulkSubscription',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json; charset=UTF-8',
  'x-cursor': 'string'
}

r = requests.get('/v1/bulkSubscription', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json; charset=UTF-8',
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json; charset=UTF-8"},
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription

Retrieve bulk subscriptions

Retrieves a list of bulk subscriptions based on the provided parameters, ordered by the last updated date. Pagination is supported through the use of ‘limit’ query parameter with either ‘cursor’ header or the ‘offset’ query parameter.

Parameters

Name	In	Type	Required	Description
keywords	query	string	false	Specifies the keywords or query string to search bulk subscriptions for
limit	query	integer(int32)	false	Maximum number of bulk subscriptions to return in the page
offset	query	integer(int32)	false	Offset of the first bulk subscription to return in the page
x-cursor	header	string	false	Cursor to use for pagination

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

createBulkSubscription

Code samples

# You can also use wget
curl -X POST /v1/bulkSubscription \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json; charset=UTF-8'

POST /v1/bulkSubscription HTTP/1.1

Content-Type: application/json
Accept: application/json; charset=UTF-8

const inputBody = '{
  "name": "<BULK_SUBSCRIPTION_NAME>",
  "label": "<BULK_SUBSCRIPTION_LABEL>",
  "attributes": [
    "attribute1",
    "attribute2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/bulkSubscription',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.post '/v1/bulkSubscription',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.post('/v1/bulkSubscription', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/bulkSubscription', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/bulkSubscription", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/bulkSubscription

Create a bulk subscription

Body parameter

Sample request

{
  "name": "<BULK_SUBSCRIPTION_NAME>",
  "label": "<BULK_SUBSCRIPTION_LABEL>",
  "attributes": [
    "attribute1",
    "attribute2"
  ]
}

Parameters

Name	In	Type	Required	Description
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

getBulkSubscription_1

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{id}

GET /v1/bulkSubscription/{id} HTTP/1.1

fetch('/v1/bulkSubscription/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/bulkSubscription/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/bulkSubscription/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{id}

Retrieve a bulk subscription

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to retrieve

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

updateBulkSubscription_1

Code samples

# You can also use wget
curl -X PUT /v1/bulkSubscription/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json; charset=UTF-8'

PUT /v1/bulkSubscription/{id} HTTP/1.1

Content-Type: application/json
Accept: application/json; charset=UTF-8

const inputBody = '{
  "id": "<BULK_SUBSCRIPTION_ID>",
  "label": "<BULK_SUBSCRIPTION_LABEL>",
  "attributes": [
    "attribute1",
    "attribute2"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/bulkSubscription/{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 = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.put '/v1/bulkSubscription/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.put('/v1/bulkSubscription/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/bulkSubscription/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/bulkSubscription/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/bulkSubscription/{id}

Update bulk subscription

Body parameter

Sample request

{
  "id": "<BULK_SUBSCRIPTION_ID>",
  "label": "<BULK_SUBSCRIPTION_LABEL>",
  "attributes": [
    "attribute1",
    "attribute2"
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to update
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

deleteBulkSubscription_1

Code samples

# You can also use wget
curl -X DELETE /v1/bulkSubscription/{id}

DELETE /v1/bulkSubscription/{id} HTTP/1.1

fetch('/v1/bulkSubscription/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/v1/bulkSubscription/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/v1/bulkSubscription/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/bulkSubscription/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/bulkSubscription/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/bulkSubscription/{id}

Delete bulk subscription

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to delete
synchronously	query	string	false	Specify whether to to delete synchronously or not
force	query	string	false	Enforces deletion even bulk subscription is in wrong state
id	path	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

uploadBulkSubscriptionEntriesForId

Code samples

# You can also use wget
curl -X POST /v1/bulkSubscription/{id}/_upload \
  -H 'Content-Type: multipart/form-data'

POST /v1/bulkSubscription/{id}/_upload HTTP/1.1

Content-Type: multipart/form-data

const inputBody = '[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]';
const headers = {
  'Content-Type':'multipart/form-data'
};

fetch('/v1/bulkSubscription/{id}/_upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data'
}

result = RestClient.post '/v1/bulkSubscription/{id}/_upload',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data'
}

r = requests.post('/v1/bulkSubscription/{id}/_upload', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/bulkSubscription/{id}/_upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}/_upload");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/bulkSubscription/{id}/_upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/bulkSubscription/{id}/_upload

Upload bulk subscription entries for a bulk subscription

Body parameter

Sample request file

|-
[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to upload entries for
action	query	string	false	The action to perform on the uploaded entries. Valid values are: ADD_ENTRIES, DELETE_ENTRIES

Responses

Status	Meaning	Description	Schema
400	Bad Request	No file found in the request	None
404	Not Found	No bulk subscription found for the provided id	None

getBulkSubscriptionEntriesForId

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{id}/entries \
  -H 'x-cursor: string'

GET /v1/bulkSubscription/{id}/entries HTTP/1.1

x-cursor: string

const headers = {
  'x-cursor':'string'
};

fetch('/v1/bulkSubscription/{id}/entries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/bulkSubscription/{id}/entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-cursor': 'string'
}

r = requests.get('/v1/bulkSubscription/{id}/entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{id}/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}/entries");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{id}/entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{id}/entries

Retrieve bulk subscription entries for a bulk subscription

Retrieves a list of bulk subscription entries based on the provided parameters. Pagination is supported through the use of ‘limit’ query parameter with either ‘cursor’ header or the ‘offset’ query parameter.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to retrieve entries for
keywords	query	string	false	Specifies the keywords or query string to search bulk subscription entries for
limit	query	integer(int32)	false	Maximum number of bulk subscription entries to return in the page
offset	query	integer(int32)	false	Offset of the first bulk subscription entry to return in the page
x-cursor	header	string	false	Cursor to use for pagination

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

addBulkSubscriptionEntriesForId

Code samples

# You can also use wget
curl -X POST /v1/bulkSubscription/{id}/entries \
  -H 'Content-Type: application/json'

POST /v1/bulkSubscription/{id}/entries HTTP/1.1

Content-Type: application/json

const inputBody = '[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]';
const headers = {
  'Content-Type':'application/json'
};

fetch('/v1/bulkSubscription/{id}/entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.post '/v1/bulkSubscription/{id}/entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/v1/bulkSubscription/{id}/entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/bulkSubscription/{id}/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}/entries");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/bulkSubscription/{id}/entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/bulkSubscription/{id}/entries

Add bulk subscription entries for a bulk subscription

Body parameter

Sample request

"[\n    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_2>\"\n    }    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_3>\"\n    }    {\n        \"attribute1\": \"<val_C>\"\n        \"attribute2\": \"<val_1>\"\n    }]"

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to add entries for
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

removeBulkSubscriptionEntriesForId

Code samples

# You can also use wget
curl -X DELETE /v1/bulkSubscription/{id}/entries \
  -H 'Content-Type: application/json'

DELETE /v1/bulkSubscription/{id}/entries HTTP/1.1

Content-Type: application/json

const inputBody = '[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]';
const headers = {
  'Content-Type':'application/json'
};

fetch('/v1/bulkSubscription/{id}/entries',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.delete '/v1/bulkSubscription/{id}/entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('/v1/bulkSubscription/{id}/entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/bulkSubscription/{id}/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}/entries");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/bulkSubscription/{id}/entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/bulkSubscription/{id}/entries

Remove bulk subscription entries for a bulk subscription

Body parameter

Sample request

"[\n    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_2>\"\n    }    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_3>\"\n    }    {\n        \"attribute1\": \"<val_C>\"\n        \"attribute2\": \"<val_1>\"\n    }]"

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to remove entries for
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

getBulkSubscriptionImportsForId

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{id}/imports \
  -H 'x-cursor: string'

GET /v1/bulkSubscription/{id}/imports HTTP/1.1

x-cursor: string

const headers = {
  'x-cursor':'string'
};

fetch('/v1/bulkSubscription/{id}/imports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/bulkSubscription/{id}/imports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-cursor': 'string'
}

r = requests.get('/v1/bulkSubscription/{id}/imports', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{id}/imports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}/imports");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{id}/imports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{id}/imports

Retrieve bulk subscription imports for a bulk subscription

Retrieves a list of bulk subscription imports based on the provided parameters. Pagination is supported through the use of ‘limit’ query parameter with either ‘cursor’ header or the ‘offset’ query parameter.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription to retrieve imports for
offset	query	integer(int32)	false	Offset of the first bulk subscription import to return in the page
limit	query	integer(int32)	false	Maximum number of bulk subscription imports to return in the page
x-cursor	header	string	false	Cursor to use for pagination

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

getBulkSubscriptionName

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{id}/name

GET /v1/bulkSubscription/{id}/name HTTP/1.1

fetch('/v1/bulkSubscription/{id}/name',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/bulkSubscription/{id}/name',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/bulkSubscription/{id}/name')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{id}/name', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{id}/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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{id}/name", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{id}/name

Retrieve the name associated with a bulk subscription

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the bulk subscription

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided id	None

getBulkSubscription

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{name}

GET /v1/bulkSubscription/{name} HTTP/1.1

fetch('/v1/bulkSubscription/{name}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/bulkSubscription/{name}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/bulkSubscription/{name}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{name}

Retrieve a bulk subscription

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to retrieve

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

updateBulkSubscription

Code samples

# You can also use wget
curl -X PUT /v1/bulkSubscription/{name} \
  -H 'Content-Type: application/json'

PUT /v1/bulkSubscription/{name} HTTP/1.1

Content-Type: application/json

const inputBody = '{
  "name": "<BULK_SUBSCRIPTION_NAME>",
  "label": "<BULK_SUBSCRIPTION_LABEL>",
  "attributes": [
    "attribute1",
    "attribute2"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/v1/bulkSubscription/{name}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.put '/v1/bulkSubscription/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('/v1/bulkSubscription/{name}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/v1/bulkSubscription/{name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/v1/bulkSubscription/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /v1/bulkSubscription/{name}

Update bulk subscription

Body parameter

Sample request

{
  "name": "<BULK_SUBSCRIPTION_NAME>",
  "label": "<BULK_SUBSCRIPTION_LABEL>",
  "attributes": [
    "attribute1",
    "attribute2"
  ]
}

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to update
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

deleteBulkSubscription

Code samples

# You can also use wget
curl -X DELETE /v1/bulkSubscription/{name}

DELETE /v1/bulkSubscription/{name} HTTP/1.1

fetch('/v1/bulkSubscription/{name}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/v1/bulkSubscription/{name}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/v1/bulkSubscription/{name}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/bulkSubscription/{name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/bulkSubscription/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/bulkSubscription/{name}

Delete bulk subscription

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to delete
synchronously	query	string	false	Specify whether to to delete synchronously or not
force	query	string	false	Enforces deletion even bulk subscription is in wrong state

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

uploadBulkSubscriptionForName

Code samples

# You can also use wget
curl -X POST /v1/bulkSubscription/{name}/_upload \
  -H 'Content-Type: multipart/form-data'

POST /v1/bulkSubscription/{name}/_upload HTTP/1.1

Content-Type: multipart/form-data

const inputBody = '[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]';
const headers = {
  'Content-Type':'multipart/form-data'
};

fetch('/v1/bulkSubscription/{name}/_upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data'
}

result = RestClient.post '/v1/bulkSubscription/{name}/_upload',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data'
}

r = requests.post('/v1/bulkSubscription/{name}/_upload', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/bulkSubscription/{name}/_upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}/_upload");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/bulkSubscription/{name}/_upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/bulkSubscription/{name}/_upload

Upload bulk subscription entries for a bulk subscription

Body parameter

Sample request file

|-
[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to upload entries for
action	query	string	false	The action to perform on the uploaded entries. Valid values are: ADD_ENTRIES, DELETE_ENTRIES

Responses

Status	Meaning	Description	Schema
400	Bad Request	No file found in the request	None
404	Not Found	No bulk subscription found for the provided name	None

getBulkSubscriptionEntriesForName

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{name}/entries \
  -H 'x-cursor: string'

GET /v1/bulkSubscription/{name}/entries HTTP/1.1

x-cursor: string

const headers = {
  'x-cursor':'string'
};

fetch('/v1/bulkSubscription/{name}/entries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/bulkSubscription/{name}/entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-cursor': 'string'
}

r = requests.get('/v1/bulkSubscription/{name}/entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{name}/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}/entries");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{name}/entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{name}/entries

Retrieve bulk subscription entries for a bulk subscription

Retrieves a list of bulk subscription entries based on the provided parameters. Pagination is supported through the use of ‘limit’ query parameter with either ‘cursor’ header or the ‘offset’ query parameter.

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to retrieve entries for
keywords	query	string	false	Specifies the keywords or query string to search bulk subscription entries for
limit	query	integer(int32)	false	Maximum number of bulk subscription entries to return in the page
offset	query	integer(int32)	false	Offset of the first bulk subscription entry to return in the page
x-cursor	header	string	false	Cursor to use for pagination

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

addBulkSubscriptionEntriesForName

Code samples

# You can also use wget
curl -X POST /v1/bulkSubscription/{name}/entries \
  -H 'Content-Type: application/json'

POST /v1/bulkSubscription/{name}/entries HTTP/1.1

Content-Type: application/json

const inputBody = '[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]';
const headers = {
  'Content-Type':'application/json'
};

fetch('/v1/bulkSubscription/{name}/entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.post '/v1/bulkSubscription/{name}/entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/v1/bulkSubscription/{name}/entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/bulkSubscription/{name}/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}/entries");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/bulkSubscription/{name}/entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/bulkSubscription/{name}/entries

Add bulk subscription entries for a bulk subscription

Body parameter

Sample request

"[\n    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_2>\"\n    }    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_3>\"\n    }    {\n        \"attribute1\": \"<val_C>\"\n        \"attribute2\": \"<val_1>\"\n    }]"

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to add entries for
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

removeBulkSubscriptionEntriesForName

Code samples

# You can also use wget
curl -X DELETE /v1/bulkSubscription/{name}/entries \
  -H 'Content-Type: application/json'

DELETE /v1/bulkSubscription/{name}/entries HTTP/1.1

Content-Type: application/json

const inputBody = '[
    {
        "attribute1": "<val_A>"
        "attribute2": "<val_2>"
    }    {
        "attribute1": "<val_A>"
        "attribute2": "<val_3>"
    }    {
        "attribute1": "<val_C>"
        "attribute2": "<val_1>"
    }]';
const headers = {
  'Content-Type':'application/json'
};

fetch('/v1/bulkSubscription/{name}/entries',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.delete '/v1/bulkSubscription/{name}/entries',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('/v1/bulkSubscription/{name}/entries', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/bulkSubscription/{name}/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}/entries");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/bulkSubscription/{name}/entries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/bulkSubscription/{name}/entries

Remove bulk subscription entries for a bulk subscription

Body parameter

Sample request

"[\n    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_2>\"\n    }    {\n        \"attribute1\": \"<val_A>\"\n        \"attribute2\": \"<val_3>\"\n    }    {\n        \"attribute1\": \"<val_C>\"\n        \"attribute2\": \"<val_1>\"\n    }]"

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to remove entries for
synchronously	query	boolean	false	Determines whether the operation should be performed synchronously

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

getBulkSubscriptionId

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{name}/id

GET /v1/bulkSubscription/{name}/id HTTP/1.1

fetch('/v1/bulkSubscription/{name}/id',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/bulkSubscription/{name}/id',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/bulkSubscription/{name}/id')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{name}/id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}/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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{name}/id", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{name}/id

Retrieve the id associated with a bulk subscription

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

getBulkSubscriptionImportsForName

Code samples

# You can also use wget
curl -X GET /v1/bulkSubscription/{name}/imports \
  -H 'x-cursor: string'

GET /v1/bulkSubscription/{name}/imports HTTP/1.1

x-cursor: string

const headers = {
  'x-cursor':'string'
};

fetch('/v1/bulkSubscription/{name}/imports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/bulkSubscription/{name}/imports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-cursor': 'string'
}

r = requests.get('/v1/bulkSubscription/{name}/imports', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/bulkSubscription/{name}/imports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/bulkSubscription/{name}/imports");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/bulkSubscription/{name}/imports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/bulkSubscription/{name}/imports

Retrieve bulk subscription imports for a bulk subscription

Retrieves a list of bulk subscription imports based on the provided parameters. Pagination is supported through the use of ‘limit’ query parameter with either ‘cursor’ header or the ‘offset’ query parameter.

Parameters

Name	In	Type	Required	Description
name	path	string	true	The name of the bulk subscription to retrieve imports for
offset	query	integer(int32)	false	Offset of the first bulk subscription import to return in the page
limit	query	integer(int32)	false	Maximum number of bulk subscription imports to return in the page
x-cursor	header	string	false	Cursor to use for pagination

Responses

Status	Meaning	Description	Schema
404	Not Found	No bulk subscription found for the provided name	None

Data Model

Data Model Resource - provides information about data models

getDataModel

Code samples

# You can also use wget
curl -X GET /v1/datamodel/current \
  -H 'If-None-Match: string'

GET /v1/datamodel/current HTTP/1.1

If-None-Match: string

const headers = {
  'If-None-Match':'string'
};

fetch('/v1/datamodel/current',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'If-None-Match' => 'string'
}

result = RestClient.get '/v1/datamodel/current',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'If-None-Match': 'string'
}

r = requests.get('/v1/datamodel/current', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'If-None-Match' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/datamodel/current', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/datamodel/current");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "If-None-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/datamodel/current", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/datamodel/current

Retrieve the current data model

The result contains classes, attributes, layouts, etc.

Parameters

Name	In	Type	Required	Description
If-None-Match	header	string	false	none
allowCaching	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Sign-in required	None

getDefaultItem

Code samples

# You can also use wget
curl -X GET /v1/datamodel/defaultItem/{category}

GET /v1/datamodel/defaultItem/{category} HTTP/1.1

fetch('/v1/datamodel/defaultItem/{category}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/datamodel/defaultItem/{category}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/datamodel/defaultItem/{category}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/datamodel/defaultItem/{category}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/datamodel/defaultItem/{category}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/datamodel/defaultItem/{category}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/datamodel/defaultItem/{category}

Get an item with pre-populated default values for a category

Returns default values as specified by the current data model

Parameters

Name	In	Type	Required	Description
category	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Sign-in required	None
404	Not Found	Category not found	None

getExportFormats

Code samples

# You can also use wget
curl -X GET /v1/datamodel/exportFormats

GET /v1/datamodel/exportFormats HTTP/1.1

fetch('/v1/datamodel/exportFormats',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/datamodel/exportFormats',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/datamodel/exportFormats')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/datamodel/exportFormats', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/datamodel/exportFormats");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/datamodel/exportFormats", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/datamodel/exportFormats

Retrieve all available Export Formats defined either by the system or the current data model

The result contains all formats defined in the system or the headers of the outbound transformation script or the export script

Parameters

Name	In	Type	Required	Description
includeExportMappings	query	boolean	false	none
returnKeyValueFormat	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Sign-in required	None

findByTranslation

Code samples

# You can also use wget
curl -X GET /v1/datamodel/retrieval/{kind}

GET /v1/datamodel/retrieval/{kind} HTTP/1.1

fetch('/v1/datamodel/retrieval/{kind}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/datamodel/retrieval/{kind}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/datamodel/retrieval/{kind}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/datamodel/retrieval/{kind}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/datamodel/retrieval/{kind}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/datamodel/retrieval/{kind}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/datamodel/retrieval/{kind}

Retrieve definitions of the data model that match a given query

Returns keys of categories, attributes, or enum codes

Parameters

Name	In	Type	Required	Description
kind	path	string	true	none
q	query	string	false	none
dataModel	query	string	false	none
extension	query	string	false	none
leaf	query	boolean	false	none
parent	query	array[string]	false	none
name	query	array[string]	false	none
code	query	array[string]	false	none
limit	query	integer(int32)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Sign-in required	None

Items

The items resource is used to retrieve and manipulate items

getItems

Code samples

# You can also use wget
curl -X GET /v1/items \
  -H 'x-item-cursor: string'

GET /v1/items HTTP/1.1

x-item-cursor: string

const headers = {
  'x-item-cursor':'string'
};

fetch('/v1/items',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-item-cursor' => 'string'
}

result = RestClient.get '/v1/items',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-item-cursor': 'string'
}

r = requests.get('/v1/items', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-item-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-item-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items

Retrieve items

Several parameters can be used to filter the result list

Parameters

Name	In	Type	Required	Description
selectionId	query	string	false	Specifies the id of a stored selection to query the items with.
items	query	array[string]	false	none
keyword	query	string	false	Specifies the keywords or query string to search items for.
category	query	string	false	none
tags	query	string	false	none
compliant	query	boolean	false	none
errorKey	query	string	false	none
warningKey	query	string	false	none
reviewErrorKey	query	string	false	none
reviewWarningKey	query	string	false	none
publicationDestination	query	string	false	none
publicationTaskId	query	integer(int64)	false	none
withPublicationTaskChecksums	query	boolean	false	none
recipientKey	query	string	false	none
reviewer	query	string	false	none
reviewStatus	query	string	false	none
taskId	query	integer(int64)	false	none
exactSearchAttributeName	query	string	false	none
exactSearchValues	query	array[string]	false	none
disableAdditionalAttributes	query	string	false	none
simpleQuery	query	boolean	false	Set to true to enforce a direct database query instead of a full text query.
primaryKey	query	array[string]	false	Specify one or more item primary keys to restrict the query for.
newestFirst	query	boolean	false	Set to true to sort the result by the updatedAt__ system property in DECENDING order, set to false to sort the result by the updatedAt__ system property in ASCENDING order or not set it at all to sort by primaryKey__.
updatedAfter	query	string(date-time)	false	Retrieves only items which were updated after the specified date.
updatedBefore	query	string(date-time)	false	Retrieves only items which were updated before the specified date.
page	query	integer(int32)	false	none
sort	query	array[string]	false	Specifies one or multiple attributes to sort the result by.
direction	query	array[string]	false	Specifies the sort direction per attribute defined in the sort parameter
bulkSubscriptionName	query	string	false	Specifies the name of a bulk subscription to query the items belonging to the bulk subscription.
bulkSubscriptionId	query	integer(int32)	false	Specifies the id of a bulk subscription to query the items belonging to the bulk subscription.
count	query	integer(int32)	false	Determines the maximum number of items to return
format	query	string	false	none
download	query	boolean	false	none
fields	query	array[string]	false	none
layout	query	string	false	none
x-item-cursor	header	string	false	none

Detailed descriptions

selectionId: Specifies the id of a stored selection to query the items with.

This parameter will force using the full text index. See also the simpleQuery parameter.

keyword: Specifies the keywords or query string to search items for.

This parameter will force using the full text index. See also the simpleQuery parameter.

simpleQuery: Set to true to enforce a direct database query instead of a full text query.

This is only necessary, if you do not specify any of the following parameters:

• primaryKey
• newestFirst
• updatedAfter
• updatedBefore

Please note that the direct datastore access is only possible, if you DO NOT specify any specific full text related query parameter, e.g. keyword or sort!

primaryKey: Specify one or more item primary keys to restrict the query for.

Please note that the direct datastore access is only possible, if you DO NOT specify any specific full text related query parameter, e.g. keyword or sort!

newestFirst: Set to true to sort the result by the updatedAt__ system property in DECENDING order, set to false to sort the result by the updatedAt__ system property in ASCENDING order or not set it at all to sort by primaryKey__.

Please note that the direct datastore access is only possible, if you DO NOT specify any specific full text related query parameter, e.g. keyword or sort!

updatedAfter: Retrieves only items which were updated after the specified date.

Specify the date in any proper ISO 8601 format, with UTC as default time zone, e.g.

• updatedAfter=2021-10-10
• updatedAfter=2021-10-10T18:00
• updatedAfter=2021-10-10T18:00:00.000Z
• updatedAfter=2021-10-10T18:00:00%2B02:00

Please note that the direct datastore access is only possible, if you DO NOT specify any specific full text related query parameter, e.g. keyword or sort!

updatedBefore: Retrieves only items which were updated before the specified date.

Specify the date in any proper ISO 8601 format, with UTC as default time zone, e.g.

• updatedBefore=2021-10-10
• updatedBefore=2021-10-10T18:00
• updatedBefore=2021-10-10T18:00:00.000Z
• updatedBefore=2021-10-10T18:00:00%2B02:00

Please note that the direct datastore access is only possible, if you DO NOT specify any specific full text related query parameter, e.g. keyword or sort!

sort: Specifies one or multiple attributes to sort the result by.

This parameter will force using the full text index. See also the simpleQuery parameter.

direction: Specifies the sort direction per attribute defined in the sort parameter

This parameter will force using the full text index. See also the simpleQuery parameter.

count: Determines the maximum number of items to return

Defaults to 20

Enumerated Values

Parameter	Value
direction	asc
direction	desc

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid query parameter	None
403	Forbidden	Sign-in required	None

storeItem

Code samples

# You can also use wget
curl -X POST /v1/items

POST /v1/items HTTP/1.1

fetch('/v1/items',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/v1/items',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/v1/items')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/items', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/items

Creates or changes items

Parameters

Name	In	Type	Required	Description
unique	query	boolean	false	none
merge	query	boolean	false	none
validate	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Sign-in required	None

getFavorites

Code samples

# You can also use wget
curl -X GET /v1/items/favorites

GET /v1/items/favorites HTTP/1.1

fetch('/v1/items/favorites',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/favorites',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/favorites')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/favorites', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/favorites");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/favorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/favorites

Fetch the favorite items

Items from the user`s favorite list

Responses

Status	Meaning	Description	Schema
403	Forbidden	Sign-in required	None

addToFavorites

Code samples

# You can also use wget
curl -X POST /v1/items/favorites/{primaryKey}

POST /v1/items/favorites/{primaryKey} HTTP/1.1

fetch('/v1/items/favorites/{primaryKey}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/v1/items/favorites/{primaryKey}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/v1/items/favorites/{primaryKey}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/items/favorites/{primaryKey}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/favorites/{primaryKey}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/items/favorites/{primaryKey}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/items/favorites/{primaryKey}

Adds an item to the favorite list

The item itself doesn’t change

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none

Responses

Status	Meaning	Description	Schema
403	Forbidden	Sign-in required	None

removeFromFavorites

Code samples

# You can also use wget
curl -X DELETE /v1/items/favorites/{primaryKey}

DELETE /v1/items/favorites/{primaryKey} HTTP/1.1

fetch('/v1/items/favorites/{primaryKey}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/v1/items/favorites/{primaryKey}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/v1/items/favorites/{primaryKey}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/items/favorites/{primaryKey}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/favorites/{primaryKey}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/items/favorites/{primaryKey}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/items/favorites/{primaryKey}

Removes an item from the favorite list

The item itself doesn’t change

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none

Responses

Status	Meaning	Description	Schema
403	Forbidden	Sign-in required	None

retrieveItemHierarchies

Code samples

# You can also use wget
curl -X POST /v1/items/hierarchies

POST /v1/items/hierarchies HTTP/1.1

fetch('/v1/items/hierarchies',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/v1/items/hierarchies',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/v1/items/hierarchies')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/items/hierarchies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/hierarchies");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/items/hierarchies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/items/hierarchies

Get the hierarchy of an item, given a JSON-formatted item in the POST request body

Parameters

Name	In	Type	Required	Description
hierarchyName	query	string	false	none

Responses

Status	Meaning	Description	Schema
404	Not Found	Item not found	None

getLatestItems

Code samples

# You can also use wget
curl -X GET /v1/items/latest

GET /v1/items/latest HTTP/1.1

fetch('/v1/items/latest',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/latest',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/latest')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/latest', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/latest");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/latest", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/latest

Return the most recently changed items

Parameters

Name	In	Type	Required	Description
count	query	integer(int32)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Sign-in required	None

getStoreItemsResultsChunks

Code samples

# You can also use wget
curl -X GET /v1/items/storeResults/{storeItemsTaskId} \
  -H 'If-None-Match: string'

GET /v1/items/storeResults/{storeItemsTaskId} HTTP/1.1

If-None-Match: string

const headers = {
  'If-None-Match':'string'
};

fetch('/v1/items/storeResults/{storeItemsTaskId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'If-None-Match' => 'string'
}

result = RestClient.get '/v1/items/storeResults/{storeItemsTaskId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'If-None-Match': 'string'
}

r = requests.get('/v1/items/storeResults/{storeItemsTaskId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'If-None-Match' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/storeResults/{storeItemsTaskId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/storeResults/{storeItemsTaskId}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "If-None-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/storeResults/{storeItemsTaskId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/storeResults/{storeItemsTaskId}

Get the list of items based on the task id, given a task id in the path

Parameters

Name	In	Type	Required	Description
If-None-Match	header	string	false	none
allowCaching	query	boolean	false	none
download	query	boolean	false	none
storeItemsTaskId	path	string	true	none

Responses

Status	Meaning	Description	Schema
404	Not Found	Digital asset is not found	None

getStoreItemsResults

Code samples

# You can also use wget
curl -X GET /v1/items/storeResults/{storeItemsTaskId}/{chunkNumber} \
  -H 'If-None-Match: string'

GET /v1/items/storeResults/{storeItemsTaskId}/{chunkNumber} HTTP/1.1

If-None-Match: string

const headers = {
  'If-None-Match':'string'
};

fetch('/v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'If-None-Match' => 'string'
}

result = RestClient.get '/v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'If-None-Match': 'string'
}

r = requests.get('/v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'If-None-Match' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "If-None-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/storeResults/{storeItemsTaskId}/{chunkNumber}

Get the list of items based on the task id

Given a task id in the path

Parameters

Name	In	Type	Required	Description
If-None-Match	header	string	false	none
allowCaching	query	boolean	false	none
download	query	boolean	false	none
storeItemsTaskId	path	string	true	none
chunkNumber	path	integer(int32)	true	none
dontDelete	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
404	Not Found	Digital asset is not found	None

getItemByKey

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}

GET /v1/items/{primaryKey} HTTP/1.1

fetch('/v1/items/{primaryKey}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/{primaryKey}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/{primaryKey}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}

Find an item by its primary key

To get item by its primary key

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	the item`s primary key
checksum	query	string	false	none
validate	query	boolean	false	none
forceRevalidation	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
403	Forbidden	Sign-in required	None
404	Not Found	Item not found	None

auditItem

Code samples

# You can also use wget
curl -X POST /v1/items/{primaryKey}/audit

POST /v1/items/{primaryKey}/audit HTTP/1.1

fetch('/v1/items/{primaryKey}/audit',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/v1/items/{primaryKey}/audit',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/v1/items/{primaryKey}/audit')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/items/{primaryKey}/audit', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/audit");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/items/{primaryKey}/audit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/items/{primaryKey}/audit

Audit/Unaudit an item

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
status	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
404	Not Found	Item not found	None

copyItem

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/copy

GET /v1/items/{primaryKey}/copy HTTP/1.1

fetch('/v1/items/{primaryKey}/copy',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/{primaryKey}/copy',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/{primaryKey}/copy')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/copy', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/copy");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/copy", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/copy

Get a copy of an item

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
validate	query	boolean	false	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
404	Not Found	Item not found	None

getItemEventHistory

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/eventHistory \
  -H 'x-cursor: string'

GET /v1/items/{primaryKey}/eventHistory HTTP/1.1

x-cursor: string

const headers = {
  'x-cursor':'string'
};

fetch('/v1/items/{primaryKey}/eventHistory',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/items/{primaryKey}/eventHistory',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-cursor': 'string'
}

r = requests.get('/v1/items/{primaryKey}/eventHistory', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/eventHistory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/eventHistory");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/eventHistory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/eventHistory

Get the event history of an item

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
newestFirst	query	boolean	false	none
offset	query	integer(int32)	false	none
limit	query	integer(int32)	false	none
x-cursor	header	string	false	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
404	Not Found	Item not found	None

getItemHierarchies

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/hierarchies

GET /v1/items/{primaryKey}/hierarchies HTTP/1.1

fetch('/v1/items/{primaryKey}/hierarchies',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/{primaryKey}/hierarchies',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/{primaryKey}/hierarchies')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/hierarchies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/hierarchies");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/hierarchies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/hierarchies

Get the hierarchy of an item, given a primary key in the path

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
hierarchyName	query	string	false	none

Responses

Status	Meaning	Description	Schema
404	Not Found	Item not found	None

getItemHistory

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/history

GET /v1/items/{primaryKey}/history HTTP/1.1

fetch('/v1/items/{primaryKey}/history',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/{primaryKey}/history',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/{primaryKey}/history')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/history', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/history");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/history

Get the change history of an item

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
historyId	query	integer(int64)	false	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
404	Not Found	Item not found	None

getItemPublications

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/publications

GET /v1/items/{primaryKey}/publications HTTP/1.1

fetch('/v1/items/{primaryKey}/publications',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/{primaryKey}/publications',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/{primaryKey}/publications')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/publications', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/publications");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/publications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/publications

Get the current publications of an item

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
404	Not Found	Item not found	None

getItemTags

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/tags \
  -H 'x-cursor: string'

GET /v1/items/{primaryKey}/tags HTTP/1.1

x-cursor: string

const headers = {
  'x-cursor':'string'
};

fetch('/v1/items/{primaryKey}/tags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'x-cursor' => 'string'
}

result = RestClient.get '/v1/items/{primaryKey}/tags',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'x-cursor': 'string'
}

r = requests.get('/v1/items/{primaryKey}/tags', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'x-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/tags', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/tags");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "x-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/tags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/tags

Get the stored tags of an item

This will only return any ‘recently’ stored tags

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
newestFirst	query	boolean	false	none
baseTag	query	string	false	none
offset	query	integer(int32)	false	none
limit	query	integer(int32)	false	none
x-cursor	header	string	false	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
404	Not Found	Item not found	None

getItemValidationResult

Code samples

# You can also use wget
curl -X GET /v1/items/{primaryKey}/validationResult

GET /v1/items/{primaryKey}/validationResult HTTP/1.1

fetch('/v1/items/{primaryKey}/validationResult',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/v1/items/{primaryKey}/validationResult',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/v1/items/{primaryKey}/validationResult')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/items/{primaryKey}/validationResult', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/items/{primaryKey}/validationResult");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/items/{primaryKey}/validationResult", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/items/{primaryKey}/validationResult

Find the latest validation result for an item

This will return the result of the latest validation for the specified item. It includes the validation error and warning messages as well as the attribute status. Note that the existance of the item is not checked, so the returned value can simply be null or empty.

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none

Responses

Status	Meaning	Description	Schema
400	Bad Request	Invalid primary key	None
403	Forbidden	Sign-in required	None

validateItem

Code samples

# You can also use wget
curl -X POST /v1/validate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /v1/validate HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "oldItem": {},
  "newItem": {},
  "attributeNames": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/v1/validate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.post '/v1/validate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/v1/validate', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/validate', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/validate");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/validate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/validate

Validate an item

Body parameter

Sample Request

{
  "oldItem": {},
  "newItem": {},
  "attributeNames": []
}

Parameters

Name	In	Type	Required	Description
timed	query	boolean	false	none

Example responses

Sample Response

{
  "validations": {
    "simple_date": [
      {
        "name": "simple_validation",
        "level": "Warning",
        "path": [
          "simple_date"
        ],
        "message": "'Simple Date' should not be a Friday",
        "params": {
          "msg_id": "friday",
          "err_val": "2013-07-26",
          "err_val_msg": "'2013-07-26' "
        }
      }
    ]
  },
  "attributeStates": {},
  "calculations": {}
}

Responses

Status	Meaning	Description	Schema
default	Default	none	None

Response Schema

Uploads

Upload a file and execute import

createGathering

Code samples

# You can also use wget
curl -X POST /v1/gatherings \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json'

POST /v1/gatherings HTTP/1.1

Content-Type: multipart/form-data
Accept: application/json

const inputBody = 'Use form field:
file: <filename> <iostream>';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json'
};

fetch('/v1/gatherings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.post '/v1/gatherings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

r = requests.post('/v1/gatherings', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/gatherings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/gatherings");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/gatherings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/gatherings

Create a gathering

Body parameter

Sample Request

|-
Use form field:
file: <filename> <iostream>

Example responses

Sample Response

[
  {
    "gatheringKey": "<UUID-same-for-all-files>",
    "assetKey": "<UUID-per-file>",
    "path": "<Path-of-file>",
    "contentType": ""
  }
]

Responses

Status	Meaning	Description	Schema
default	Default	none	None

Response Schema

executeImport

Code samples

# You can also use wget
curl -X POST /v1/imports \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json; charset=UTF-8'

POST /v1/imports HTTP/1.1

Content-Type: application/json
Accept: application/json; charset=UTF-8

const inputBody = '{
  "gatheringKey": "<gathering-key>",
  "path": "<path>"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/imports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.post '/v1/imports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.post('/v1/imports', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/imports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/imports");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/imports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/imports

Execute a gathering import

Body parameter

Sample Request

{
  "gatheringKey": "<gathering-key>",
  "path": "<path>"
}

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Item Review

APIs for item review operations

getSupplierItemReviews

Code samples

# You can also use wget
curl -X GET /v1/supplierreviews/{primaryKey} \
  -H 'Accept: application/json'

GET /v1/supplierreviews/{primaryKey} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/v1/supplierreviews/{primaryKey}',
{
  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'
}

result = RestClient.get '/v1/supplierreviews/{primaryKey}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/supplierreviews/{primaryKey}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/supplierreviews/{primaryKey}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/supplierreviews/{primaryKey}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/supplierreviews/{primaryKey}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/supplierreviews/{primaryKey}

Fetch supplier item reviews

Parameters

Name	In	Type	Required	Description
primaryKey	path	string	true	none
reviewer	query	string	false	none
publicationDestination	query	string	false	none

Example responses

Sample Response

[
  {
    "primaryKey": "<primaryKey>",
    "supplierId": "<supplierId>",
    "channelId": "<channelId>",
    "messagingAssetId": 111111111111111,
    "supplier": "supplier",
    "reviewer": "reviewer",
    "reviewStatus": "APPROVED",
    "date": 1624017700422,
    "comment": "",
    "messagingCreatorType": "REVIEW"
  }
]

Responses

Status	Meaning	Description	Schema
default	Default	none	None

Response Schema

Messaging

Messaging Operations

getMessagingAssetsForOwner

Code samples

# You can also use wget
curl -X GET /v1/messaging/messagingassets \
  -H 'Accept: application/json' \
  -H 'x-message-cursor: string'

GET /v1/messaging/messagingassets HTTP/1.1

Accept: application/json
x-message-cursor: string

const headers = {
  'Accept':'application/json',
  'x-message-cursor':'string'
};

fetch('/v1/messaging/messagingassets',
{
  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',
  'x-message-cursor' => 'string'
}

result = RestClient.get '/v1/messaging/messagingassets',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'x-message-cursor': 'string'
}

r = requests.get('/v1/messaging/messagingassets', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'x-message-cursor' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/messaging/messagingassets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingassets");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-message-cursor": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/messaging/messagingassets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/messaging/messagingassets

Retrieve all messaging assets

Parameters

Name	In	Type	Required	Description
channelId	query	integer(int64)	false	none
direction	query	string	false	none
status	query	string	false	none
contentType	query	string	false	none
creatorType	query	string	false	none
creatorId	query	integer(int64)	false	none
createdBefore	query	string(date-time)	false	none
createdAfter	query	string(date-time)	false	none
oldestFirst	query	boolean	false	none
offset	query	integer(int32)	false	none
limit	query	integer(int32)	false	none
x-message-cursor	header	string	false	none

Enumerated Values

Parameter	Value
direction	INBOUND
direction	OUTBOUND
status	DEFERRED
status	PENDING
status	BLOCKED
status	SENDING
status	DELIVERED
status	SUCCESS
status	EXCEPTION
status	WARNING
status	FATAL
status	RECEIVED
status	IGNORED
status	IMPORTING
status	IMPORTED
status	PENDING_PROCESSING
status	PROCESSING
status	PROCESSED
status	ERROR
creatorType	PUBLICATION
creatorType	SUBSCRIPTION
creatorType	REVIEW
creatorType	MANUAL
creatorType	EXTERNAL
creatorType	SCRIPT

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

uploadInboundMessagingAssetForOwner

Code samples

# You can also use wget
curl -X POST /v1/messaging/messagingassets \
  -H 'Accept: application/json'

POST /v1/messaging/messagingassets HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/v1/messaging/messagingassets',
{
  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'
}

result = RestClient.post '/v1/messaging/messagingassets',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/v1/messaging/messagingassets', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/messaging/messagingassets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingassets");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/messaging/messagingassets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/messaging/messagingassets

Upload a messaging asset

Parameters

Name	In	Type	Required	Description
direction	query	string	false	none

Enumerated Values

Parameter	Value
direction	INBOUND
direction	OUTBOUND

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

countMessagingAssetsForOwner

Code samples

# You can also use wget
curl -X GET /v1/messaging/messagingassets/count \
  -H 'Accept: application/json'

GET /v1/messaging/messagingassets/count HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/v1/messaging/messagingassets/count',
{
  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'
}

result = RestClient.get '/v1/messaging/messagingassets/count',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/messaging/messagingassets/count', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/messaging/messagingassets/count', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingassets/count");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/messaging/messagingassets/count", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/messaging/messagingassets/count

Count all messaging assets

Parameters

Name	In	Type	Required	Description
channelId	query	integer(int64)	false	none
direction	query	string	false	none
status	query	string	false	none
contentType	query	string	false	none
creatorType	query	string	false	none
creatorId	query	integer(int64)	false	none
createdBefore	query	string(date-time)	false	none
createdAfter	query	string(date-time)	false	none

Enumerated Values

Parameter	Value
direction	INBOUND
direction	OUTBOUND
status	DEFERRED
status	PENDING
status	BLOCKED
status	SENDING
status	DELIVERED
status	SUCCESS
status	EXCEPTION
status	WARNING
status	FATAL
status	RECEIVED
status	IGNORED
status	IMPORTING
status	IMPORTED
status	PENDING_PROCESSING
status	PROCESSING
status	PROCESSED
status	ERROR
creatorType	PUBLICATION
creatorType	SUBSCRIPTION
creatorType	REVIEW
creatorType	MANUAL
creatorType	EXTERNAL
creatorType	SCRIPT

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

serveMessagingAssetForOwner_1

Code samples

# You can also use wget
curl -X GET /v1/messaging/messagingassets/{assetKey}/{path} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: string'

GET /v1/messaging/messagingassets/{assetKey}/{path} HTTP/1.1

Accept: application/json
If-None-Match: string

const headers = {
  'Accept':'application/json',
  'If-None-Match':'string'
};

fetch('/v1/messaging/messagingassets/{assetKey}/{path}',
{
  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',
  'If-None-Match' => 'string'
}

result = RestClient.get '/v1/messaging/messagingassets/{assetKey}/{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'string'
}

r = requests.get('/v1/messaging/messagingassets/{assetKey}/{path}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'If-None-Match' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/messaging/messagingassets/{assetKey}/{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingassets/{assetKey}/{path}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-None-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/messaging/messagingassets/{assetKey}/{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/messaging/messagingassets/{assetKey}/{path}

Download a messaging asset

Parameters

Name	In	Type	Required	Description
If-None-Match	header	string	false	none
allowCaching	query	boolean	false	none
download	query	boolean	false	none
assetKey	path	string	true	none
path	path	string	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

serveMessagingAssetForOwner

Code samples

# You can also use wget
curl -X GET /v1/messaging/messagingassets/{messagingAssetId} \
  -H 'Accept: application/json' \
  -H 'If-None-Match: string'

GET /v1/messaging/messagingassets/{messagingAssetId} HTTP/1.1

Accept: application/json
If-None-Match: string

const headers = {
  'Accept':'application/json',
  'If-None-Match':'string'
};

fetch('/v1/messaging/messagingassets/{messagingAssetId}',
{
  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',
  'If-None-Match' => 'string'
}

result = RestClient.get '/v1/messaging/messagingassets/{messagingAssetId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'If-None-Match': 'string'
}

r = requests.get('/v1/messaging/messagingassets/{messagingAssetId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'If-None-Match' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/messaging/messagingassets/{messagingAssetId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingassets/{messagingAssetId}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "If-None-Match": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/messaging/messagingassets/{messagingAssetId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/messaging/messagingassets/{messagingAssetId}

Download a messaging asset

Parameters

Name	In	Type	Required	Description
If-None-Match	header	string	false	none
allowCaching	query	boolean	false	none
download	query	boolean	false	none
messagingAssetId	path	integer(int64)	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

getMessagingAssetResponseForOwner

Code samples

# You can also use wget
curl -X GET /v1/messaging/messagingassets/{messagingAssetId}/messagingresponse \
  -H 'Accept: application/json'

GET /v1/messaging/messagingassets/{messagingAssetId}/messagingresponse HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/v1/messaging/messagingassets/{messagingAssetId}/messagingresponse',
{
  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'
}

result = RestClient.get '/v1/messaging/messagingassets/{messagingAssetId}/messagingresponse',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/messaging/messagingassets/{messagingAssetId}/messagingresponse', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/messaging/messagingassets/{messagingAssetId}/messagingresponse', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingassets/{messagingAssetId}/messagingresponse");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/messaging/messagingassets/{messagingAssetId}/messagingresponse", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/messaging/messagingassets/{messagingAssetId}/messagingresponse

Retrieve the most significant response for a messaging assets

Parameters

Name	In	Type	Required	Description
messagingAssetId	path	integer(int64)	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

getMessagingResponsesForOwner

Code samples

# You can also use wget
curl -X GET /v1/messaging/messagingresponses \
  -H 'Accept: application/json'

GET /v1/messaging/messagingresponses HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/v1/messaging/messagingresponses',
{
  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'
}

result = RestClient.get '/v1/messaging/messagingresponses',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/messaging/messagingresponses', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/messaging/messagingresponses', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/messaging/messagingresponses");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/messaging/messagingresponses", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/messaging/messagingresponses

Retrieve all messaging responses

Parameters

Name	In	Type	Required	Description
messagingAssetId	query	integer(int64)	false	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Publications

Publication Operations

startPublication

Code samples

# You can also use wget
curl -X POST /v1/publications \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json; charset=UTF-8'

POST /v1/publications HTTP/1.1

Content-Type: application/json
Accept: application/json; charset=UTF-8

const inputBody = '{
  "selectionId": "<See-Above>",
  "destinations": [
    {
      "destinationType": "COMMUNICATION_CHANNEL",
      "destinationId": "<Channel-ID>"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/publications',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json; charset=UTF-8'
}

result = RestClient.post '/v1/publications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.post('/v1/publications', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/publications', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/publications");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/publications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/publications

Publish an item selection

Body parameter

Sample Request with Selection ID

{
  "selectionId": "<See-Above>",
  "destinations": [
    {
      "destinationType": "COMMUNICATION_CHANNEL",
      "destinationId": "<Channel-ID>"
    }
  ]
}

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Selections

Selection Operations

createSelection

Code samples

# You can also use wget
curl -X POST /v1/selections \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /v1/selections HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "primaryKeys": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/v1/selections',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.post '/v1/selections',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/v1/selections', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/v1/selections', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/selections");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/v1/selections", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /v1/selections

Create an item selection

Body parameter

Sample Request

{
  "primaryKeys": []
}

Example responses

Sample Response

{
  "selectionId": "<UUID>",
  "numberOfItems": 1
}

Responses

Status	Meaning	Description	Schema
default	Default	none	None

Response Schema

getSelection

Code samples

# You can also use wget
curl -X GET /v1/selections/{identifier} \
  -H 'Accept: application/json; charset=UTF-8'

GET /v1/selections/{identifier} HTTP/1.1

Accept: application/json; charset=UTF-8

const headers = {
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/selections/{identifier}',
{
  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; charset=UTF-8'
}

result = RestClient.get '/v1/selections/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.get('/v1/selections/{identifier}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/v1/selections/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/selections/{identifier}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/v1/selections/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /v1/selections/{identifier}

Parameters

Name	In	Type	Required	Description
identifier	path	string	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

deleteSelection

Code samples

# You can also use wget
curl -X DELETE /v1/selections/{identifier} \
  -H 'Accept: application/json; charset=UTF-8'

DELETE /v1/selections/{identifier} HTTP/1.1

Accept: application/json; charset=UTF-8

const headers = {
  'Accept':'application/json; charset=UTF-8'
};

fetch('/v1/selections/{identifier}',
{
  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; charset=UTF-8'
}

result = RestClient.delete '/v1/selections/{identifier}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json; charset=UTF-8'
}

r = requests.delete('/v1/selections/{identifier}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json; charset=UTF-8',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/v1/selections/{identifier}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/v1/selections/{identifier}");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json; charset=UTF-8"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/v1/selections/{identifier}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /v1/selections/{identifier}

Parameters

Name	In	Type	Required	Description
identifier	path	string	true	none

Example responses

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Schemas

Address

{
  "address": "string",
  "firstName": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
address	string	false	none	none
firstName	string	false	none	none
name	string	false	none	none

ApiKeyRequest_UserView

{
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none

AssetFolderLink

{
  "changedAt": "2019-08-24T14:15:22Z",
  "changedBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "linkType": "ASSET",
  "name": "string",
  "parentFolderId": 0
}

Properties

Name	Type	Required	Restrictions	Description
changedAt	string(date-time)	false	none	none
changedBy	string	false	none	none
createdAt	string(date-time)	false	none	none
createdBy	string	false	none	none
linkType	string	false	none	none
name	string	false	none	none
parentFolderId	integer(int64)	false	none	none

Enumerated Values

Property	Value
linkType	ASSET
linkType	FOLDER

Attachement

{
  "contentType": "string",
  "name": "string",
  "url": "string"
}

Properties

Name	Type	Required	Restrictions	Description
contentType	string	false	none	none
name	string	false	none	none
url	string	false	none	none

BroadcastEvent

{
  "data": {
    "property1": {},
    "property2": {}
  },
  "event": "string",
  "identifier": "string",
  "namespace": "string",
  "organizationId": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	none
» additionalProperties	object	false	none	none
event	string	false	none	none
identifier	string	false	none	none
namespace	string	false	none	none
organizationId	integer(int64)	false	none	none

BulkSubscription

{
  "attributes": [
    "string"
  ],
  "combinedAttributes": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdByName": "string",
  "description": "string",
  "id": 0,
  "label": "string",
  "name": "string",
  "processId": 0,
  "status": "PENDING",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedById": 0,
  "updatedByName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
attributes	[string]	false	none	none
combinedAttributes	string	false	none	none
createdAt	string(date-time)	false	none	none
createdById	integer(int64)	false	none	none
createdByName	string	false	none	none
description	string	false	none	none
id	integer(int64)	false	none	none
label	string	false	none	none
name	string	false	none	none
processId	integer(int64)	false	none	none
status	string	false	none	none
updatedAt	string(date-time)	false	none	none
updatedById	integer(int64)	false	none	none
updatedByName	string	false	none	none

Enumerated Values

Property	Value
status	PENDING
status	INITIALIZING
status	UPDATING
status	DELETING
status	READY

ChangePasswordRequest

{
  "newPassword": "string",
  "oldPassword": "string"
}

Properties

Name	Type	Required	Restrictions	Description
newPassword	string	false	none	none
oldPassword	string	false	none	none

Codelist

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
name	string	false	none	none

CodelistEntry

{
  "code": "string",
  "codelistId": 0,
  "defaultLabel": "string",
  "localeLabels": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
codelistId	integer(int64)	false	none	none
defaultLabel	string	false	none	none
localeLabels	object	false	none	none
» additionalProperties	string	false	none	none

Comment

{
  "assets": [
    {
      "contentType": "string",
      "name": "string",
      "url": "string"
    }
  ],
  "author": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "id": 0,
  "taskId": 0,
  "text": "string"
}

Properties

Name	Type	Required	Restrictions	Description
assets	[Attachement]	false	none	none
author	string	false	none	none
createDate	string(date-time)	false	none	none
id	integer(int64)	false	none	none
taskId	integer(int64)	false	none	none
text	string	false	none	none

Community_InternalView

{
  "connectorName": "string",
  "customQueueMappings": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "customQueues": [
    "string"
  ],
  "dbCustomQueueMappings": [
    "string"
  ],
  "defaultCommunity": true,
  "enableExternalRubyRuntime": true,
  "id": 0,
  "managerOrganization": 0,
  "marketingCampaigns": [
    "string"
  ],
  "marketingCampaignsFrequencyInterval": 0,
  "memberOrganizations": [
    0
  ],
  "name": "string",
  "specialBillingOffers": [
    "string"
  ],
  "visibleToMembers": true
}

Properties

Name	Type	Required	Restrictions	Description
connectorName	string	false	none	none
customQueueMappings	object	false	none	none
» additionalProperties	[string]	false	none	none
customQueues	[string]	false	none	none
dbCustomQueueMappings	[string]	false	none	none
defaultCommunity	boolean	false	none	none
enableExternalRubyRuntime	boolean	false	none	none
id	integer(int64)	false	none	none
managerOrganization	integer(int64)	false	none	none
marketingCampaigns	[string]	false	none	none
marketingCampaignsFrequencyInterval	integer(int32)	false	none	none
memberOrganizations	[integer]	false	none	none
name	string	false	none	none
specialBillingOffers	[string]	false	none	none
visibleToMembers	boolean	false	none	none

Contact

{
  "acceptanceDate": "2019-08-24T14:15:22Z",
  "address": "string",
  "contactRole": "DATA_SUPPLIER",
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "date": "2019-08-24T14:15:22Z",
  "email": "string",
  "gln": "string",
  "id": 0,
  "imageUrl": "string",
  "invitationType": "INVITED_BUYER",
  "managedContact": true,
  "name": "string",
  "organizationId": 0,
  "state": "INVITED",
  "text": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "url": "string",
  "user": "string"
}

Properties

Name	Type	Required	Restrictions	Description
acceptanceDate	string(date-time)	false	none	none
address	string	false	none	none
contactRole	string	false	none	none
customValues	object	false	none	none
» additionalProperties	object	false	none	none
date	string(date-time)	false	none	none
email	string	false	none	none
gln	string	false	none	none
id	integer(int64)	false	none	none
imageUrl	string	false	none	none
invitationType	string	false	none	none
managedContact	boolean	false	none	none
name	string	false	none	none
organizationId	integer(int64)	false	none	none
state	string	false	none	none
text	string	false	none	none
updatedAt	string(date-time)	false	none	none
url	string	false	none	none
user	string	false	none	none

Enumerated Values

Property	Value
contactRole	DATA_SUPPLIER
contactRole	DATA_RECIPIENT
contactRole	DATA_SUPPLIER_AND_RECIPIENT
invitationType	INVITED_BUYER
invitationType	INVITED_COMMUNITY_MEMBER
invitationType	INVITED_SUPPLIER
invitationType	INVITED_COLLEAGUE
invitationType	CONTACT_REQUEST
invitationType	REQUEST_FOR_COMMUNITY_MEMBERSHIP
invitationType	COMMUNITY_INVITATION
state	INVITED
state	PENDING
state	ESTABLISHED
state	REJECTED

Contact_InternalView

{
  "acceptanceDate": "2019-08-24T14:15:22Z",
  "address": "string",
  "contactRole": "DATA_SUPPLIER",
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "date": "2019-08-24T14:15:22Z",
  "email": "string",
  "gln": "string",
  "id": 0,
  "imageUrl": "string",
  "invitationType": "INVITED_BUYER",
  "managedContact": true,
  "name": "string",
  "organizationId": 0,
  "state": "INVITED",
  "text": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "url": "string",
  "user": "string"
}

Properties

Name	Type	Required	Restrictions	Description
acceptanceDate	string(date-time)	false	none	none
address	string	false	none	none
contactRole	string	false	none	none
customValues	object	false	none	none
» additionalProperties	object	false	none	none
date	string(date-time)	false	none	none
email	string	false	none	none
gln	string	false	none	none
id	integer(int64)	false	none	none
imageUrl	string	false	none	none
invitationType	string	false	none	none
managedContact	boolean	false	none	none
name	string	false	none	none
organizationId	integer(int64)	false	none	none
state	string	false	none	none
text	string	false	none	none
updatedAt	string(date-time)	false	none	none
url	string	false	none	none
user	string	false	none	none

Enumerated Values

Property	Value
contactRole	DATA_SUPPLIER
contactRole	DATA_RECIPIENT
contactRole	DATA_SUPPLIER_AND_RECIPIENT
invitationType	INVITED_BUYER
invitationType	INVITED_COMMUNITY_MEMBER
invitationType	INVITED_SUPPLIER
invitationType	INVITED_COLLEAGUE
invitationType	CONTACT_REQUEST
invitationType	REQUEST_FOR_COMMUNITY_MEMBERSHIP
invitationType	COMMUNITY_INVITATION
state	INVITED
state	PENDING
state	ESTABLISHED
state	REJECTED

CustomAttribute

{
  "action": "ADD",
  "id": "string",
  "label": "string",
  "params": {
    "property1": {},
    "property2": {}
  },
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	none
id	string	false	none	none
label	string	false	none	none
params	object	false	none	none
» additionalProperties	object	false	none	none
type	string	false	none	none

Enumerated Values

Property	Value
action	ADD
action	UPDATE
action	REMOVE
action	SORT

CustomCategory

{
  "action": "ADD",
  "attributes": [
    {
      "action": "ADD",
      "id": "string",
      "predecessor": "string"
    }
  ],
  "id": "string",
  "label": "string",
  "parent": "string"
}

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	none
attributes	[CustomSectionAttribute]	false	none	none
id	string	false	none	none
label	string	false	none	none
parent	string	false	none	none

Enumerated Values

Property	Value
action	ADD
action	UPDATE
action	REMOVE
action	SORT

CustomLayout

{
  "action": "ADD",
  "id": "string",
  "label": "string",
  "order": [
    "string"
  ],
  "sections": [
    {
      "action": "ADD",
      "attributes": [
        {
          "action": "ADD",
          "id": "string",
          "predecessor": "string"
        }
      ],
      "id": "string",
      "label": "string",
      "order": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	none
id	string	false	none	none
label	string	false	none	none
order	[string]	false	none	none
sections	[CustomSection]	false	none	none

Enumerated Values

Property	Value
action	ADD
action	UPDATE
action	REMOVE
action	SORT

CustomSection

{
  "action": "ADD",
  "attributes": [
    {
      "action": "ADD",
      "id": "string",
      "predecessor": "string"
    }
  ],
  "id": "string",
  "label": "string",
  "order": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	none
attributes	[CustomSectionAttribute]	false	none	none
id	string	false	none	none
label	string	false	none	none
order	[string]	false	none	none

Enumerated Values

Property	Value
action	ADD
action	UPDATE
action	REMOVE
action	SORT

CustomSectionAttribute

{
  "action": "ADD",
  "id": "string",
  "predecessor": "string"
}

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	none
id	string	false	none	none
predecessor	string	false	none	none

Enumerated Values

Property	Value
action	ADD
action	UPDATE
action	REMOVE
action	SORT

DataModelCustomization

{
  "attributes": [
    {
      "action": "ADD",
      "id": "string",
      "label": "string",
      "params": {
        "property1": {},
        "property2": {}
      },
      "type": "string"
    }
  ],
  "categories": [
    {
      "action": "ADD",
      "attributes": [
        {
          "action": "ADD",
          "id": "string",
          "predecessor": "string"
        }
      ],
      "id": "string",
      "label": "string",
      "parent": "string"
    }
  ],
  "layouts": [
    {
      "action": "ADD",
      "id": "string",
      "label": "string",
      "order": [
        "string"
      ],
      "sections": [
        {
          "action": "ADD",
          "attributes": [
            {
              "action": "ADD",
              "id": "string",
              "predecessor": "string"
            }
          ],
          "id": "string",
          "label": "string",
          "order": [
            "string"
          ]
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
attributes	[CustomAttribute]	false	none	none
categories	[CustomCategory]	false	none	none
layouts	[CustomLayout]	false	none	none

DataModelTemplate

{
  "activateable": true,
  "communityId": 0,
  "communityTemplate": true,
  "datamodelForInvitees": true,
  "descriptions": {
    "property1": "string",
    "property2": "string"
  },
  "gathering": "string",
  "hasTranslations": true,
  "id": 0,
  "imageUrl": "string",
  "inflatedGatheringKey": "string",
  "invalid": true,
  "labels": {
    "property1": "string",
    "property2": "string"
  },
  "name": "string",
  "owner": 0,
  "ownerEmail": "string",
  "ownerName": "string",
  "ownerNamespace": "string",
  "path": "string",
  "publicTemplate": true,
  "releaseNotes": {
    "property1": "string",
    "property2": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "url": "string",
  "version": "string"
}

Properties

Name	Type	Required	Restrictions	Description
activateable	boolean	false	none	none
communityId	integer(int64)	false	none	none
communityTemplate	boolean	false	none	none
datamodelForInvitees	boolean	false	none	none
descriptions	object	false	none	none
» additionalProperties	string	false	none	none
gathering	string	false	none	none
hasTranslations	boolean	false	none	none
id	integer(int64)	false	none	none
imageUrl	string	false	none	none
inflatedGatheringKey	string	false	none	none
invalid	boolean	false	none	none
labels	object	false	none	none
» additionalProperties	string	false	none	none
name	string	false	none	none
owner	integer(int64)	false	none	none
ownerEmail	string	false	none	none
ownerName	string	false	none	none
ownerNamespace	string	false	none	none
path	string	false	none	none
publicTemplate	boolean	false	none	none
releaseNotes	object	false	none	none
» additionalProperties	string	false	none	none
updatedAt	string(date-time)	false	none	none
updatedBy	string	false	none	none
url	string	false	none	none
version	string	false	none	none

EMailInvitation

{
  "acceptanceDate": "2019-08-24T14:15:22Z",
  "acceptingOrganizationId": 0,
  "acceptingUserId": "string",
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "date": "2019-08-24T14:15:22Z",
  "id": 0,
  "invitationState": "PENDING",
  "invitationType": "INVITED_BUYER",
  "invitedContactCustomValues": {
    "property1": {},
    "property2": {}
  },
  "invitedEmailAddress": "string",
  "invitedOrganizationCustomId": "string",
  "invitedOrganizationName": "string",
  "invitingOrganizationId": 0,
  "restrictionFilter": "string",
  "restrictionQuery": "string",
  "roles": [
    "string"
  ],
  "text": "string",
  "user": "string",
  "userCustomValues": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
acceptanceDate	string(date-time)	false	none	none
acceptingOrganizationId	integer(int64)	false	none	none
acceptingUserId	string	false	none	none
customValues	object	false	none	none
» additionalProperties	object	false	none	none
date	string(date-time)	false	none	none
id	integer(int64)	false	none	none
invitationState	string	false	none	none
invitationType	string	false	none	none
invitedContactCustomValues	object	false	none	none
» additionalProperties	object	false	none	none
invitedEmailAddress	string	false	none	none
invitedOrganizationCustomId	string	false	none	none
invitedOrganizationName	string	false	none	none
invitingOrganizationId	integer(int64)	false	none	none
restrictionFilter	string	false	none	none
restrictionQuery	string	false	none	none
roles	[string]	false	none	none
text	string	false	none	none
user	string	false	none	none
userCustomValues	object	false	none	none
» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
invitationState	PENDING
invitationState	ACCEPTED
invitationType	INVITED_BUYER
invitationType	INVITED_COMMUNITY_MEMBER
invitationType	INVITED_SUPPLIER
invitationType	INVITED_COLLEAGUE
invitationType	CONTACT_REQUEST
invitationType	REQUEST_FOR_COMMUNITY_MEMBERSHIP
invitationType	COMMUNITY_INVITATION

EnhancedContent

{
  "changedAt": "2019-08-24T14:15:22Z",
  "changedBy": "string",
  "description": "string",
  "id": 0,
  "layoutBlocks": [
    {
      "blockParams": {
        "property1": {},
        "property2": {}
      },
      "templateName": "string"
    }
  ],
  "linkedAssets": [
    "string"
  ],
  "name": "string",
  "needsPublishing": true,
  "published": true,
  "publishedAt": "2019-08-24T14:15:22Z",
  "publishedBy": "string",
  "publishedRetailerLinks": [
    "string"
  ],
  "retailerLinkIds": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
changedAt	string(date-time)	false	none	none
changedBy	string	false	none	none
description	string	false	none	none
id	integer(int64)	false	none	none
layoutBlocks	[LayoutBlock]	false	none	none
linkedAssets	[string]	false	none	none
name	string	false	none	none
needsPublishing	boolean	false	none	none
published	boolean	false	none	none
publishedAt	string(date-time)	false	none	none
publishedBy	string	false	none	none
publishedRetailerLinks	[string]	false	none	none
retailerLinkIds	object	false	none	none
» additionalProperties	[string]	false	none	none

ExportJob

{
  "creationDate": "2019-08-24T14:15:22Z",
  "exceptionToThrow": {
    "cause": {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "classLoaderName": "string",
          "moduleName": "string",
          "moduleVersion": "string",
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        {
          "stackTrace": [
            {
              "classLoaderName": "string",
              "moduleName": "string",
              "moduleVersion": "string",
              "methodName": "string",
              "fileName": "string",
              "lineNumber": 0,
              "className": "string",
              "nativeMethod": true
            }
          ],
          "message": "string",
          "localizedMessage": "string"
        }
      ]
    },
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "classLoaderName": "string",
        "moduleName": "string",
        "moduleVersion": "string",
        "methodName": "string",
        "fileName": "string",
        "lineNumber": 0,
        "className": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      {
        "stackTrace": [
          {
            "classLoaderName": "string",
            "moduleName": "string",
            "moduleVersion": "string",
            "methodName": "string",
            "fileName": "string",
            "lineNumber": 0,
            "className": "string",
            "nativeMethod": true
          }
        ],
        "message": "string",
        "localizedMessage": "string"
      }
    ]
  },
  "id": 0,
  "message": "string",
  "name": "string",
  "schedule": {
    "active": true,
    "endAfterRuns": 0,
    "endDateTime": "2019-08-24T14:15:22Z",
    "nextRunDateTime": "2019-08-24T14:15:22Z",
    "remainingRuns": 0,
    "repeatDaysOfMonth": [
      0
    ],
    "repeatDaysOfWeek": [
      0
    ],
    "repeatEvery": 0,
    "repeatHour": 0,
    "repeatMinute": 0,
    "repeatType": "MINUTE",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "RUNNING"
  },
  "type": "string",
  "updateDate": "2019-08-24T14:15:22Z",
  "user": "string",
  "selectionId": "string",
  "format": "string",
  "emailRecipients": [
    "string"
  ]
}

Properties

allOf - discriminator: Job.type

Name	Type	Required	Restrictions	Description
anonymous	Job	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» selectionId	string	false	none	none
» format	string	false	none	none
» emailRecipients	[string]	false	none	none

ExportSubscription

{
  "email": "string",
  "exportFormats": [
    "string"
  ],
  "id": 0,
  "tenantNamespace": "string"
}

Properties

Name	Type	Required	Restrictions	Description
email	string	false	none	none
exportFormats	[string]	false	none	none
id	integer(int64)	false	none	none
tenantNamespace	string	false	none	none

FilterProfile

{
  "changedAt": "2019-08-24T14:15:22Z",
  "changedBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "id": "string",
  "itemsQuery": {
    "bulkSubscriptionId": 0,
    "bulkSubscriptionName": "string",
    "category": "string",
    "compliant": true,
    "disableAdditionalAttributes": true,
    "errorKey": "string",
    "exactSearchAttributeName": "string",
    "exactSearchValues": [
      {}
    ],
    "items": [
      "string"
    ],
    "keyword": "string",
    "numberOfItems": 0,
    "publicationDestination": "string",
    "publicationStates": [
      "PENDING"
    ],
    "publicationStatus": "string",
    "publicationTaskId": 0,
    "publicationTaskStates": [
      "PENDING"
    ],
    "recipientKey": "string",
    "reviewErrorKey": "string",
    "reviewStatus": "string",
    "reviewWarningKey": "string",
    "reviewer": "string",
    "selectionId": "string",
    "tags": "string",
    "taskId": 0,
    "warningKey": "string"
  },
  "name": "string",
  "primaryKeys": [
    "string"
  ],
  "userId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
changedAt	string(date-time)	false	none	none
changedBy	string	false	none	none
createdAt	string(date-time)	false	none	none
createdBy	string	false	none	none
id	string	false	none	none
itemsQuery	ItemQuery	false	none	none
name	string	false	none	none
primaryKeys	[string]	false	none	none
userId	string	false	none	none

FolderPathName

{
  "name": "string",
  "path": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
path	string	false	none	none

GdsnParty

{
  "gln": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
gln	string	false	none	none
name	string	false	none	none

GlobalProvider

{
  "name": "string",
  "namespace": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
namespace	string	false	none	none

IdentityProvider

{
  "authenticationEndpoint": "string",
  "certificate": "string",
  "entityId": "string",
  "logoutEndpoint": "string"
}

Properties

Name	Type	Required	Restrictions	Description
authenticationEndpoint	string	false	none	none
certificate	string	false	none	none
entityId	string	false	none	none
logoutEndpoint	string	false	none	none

ImportRequestDigitalAsset

{
  "gatheringKey": "string",
  "importImmediately": true,
  "importSequentially": true,
  "namespace": {},
  "path": "string",
  "sequentialImportGroup": "string",
  "tags": [
    "string"
  ],
  "url": "string"
}

Properties

Name	Type	Required	Restrictions	Description
gatheringKey	string	false	none	none
importImmediately	boolean	false	none	none
importSequentially	boolean	false	none	none
namespace	Namespace	false	none	none
path	string	false	none	none
sequentialImportGroup	string	false	none	none
tags	[string]	false	none	none
url	string(url)	false	none	none

ItemQuery

{
  "bulkSubscriptionId": 0,
  "bulkSubscriptionName": "string",
  "category": "string",
  "compliant": true,
  "disableAdditionalAttributes": true,
  "errorKey": "string",
  "exactSearchAttributeName": "string",
  "exactSearchValues": [
    {}
  ],
  "items": [
    "string"
  ],
  "keyword": "string",
  "numberOfItems": 0,
  "publicationDestination": "string",
  "publicationStates": [
    "PENDING"
  ],
  "publicationStatus": "string",
  "publicationTaskId": 0,
  "publicationTaskStates": [
    "PENDING"
  ],
  "recipientKey": "string",
  "reviewErrorKey": "string",
  "reviewStatus": "string",
  "reviewWarningKey": "string",
  "reviewer": "string",
  "selectionId": "string",
  "tags": "string",
  "taskId": 0,
  "warningKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
bulkSubscriptionId	integer(int64)	false	none	none
bulkSubscriptionName	string	false	none	none
category	string	false	none	none
compliant	boolean	false	none	none
disableAdditionalAttributes	boolean	false	none	none
errorKey	string	false	none	none
exactSearchAttributeName	string	false	none	none
exactSearchValues	[object]	false	none	none
items	[string]	false	none	none
keyword	string	false	none	none
numberOfItems	integer(int64)	false	none	none
publicationDestination	string	false	none	none
publicationStates	[string]	false	write-only	none
publicationStatus	string	false	none	none
publicationTaskId	integer(int64)	false	none	none
publicationTaskStates	[string]	false	none	none
recipientKey	string	false	none	none
reviewErrorKey	string	false	none	none
reviewStatus	string	false	none	none
reviewWarningKey	string	false	none	none
reviewer	string	false	none	none
selectionId	string	false	none	none
tags	string	false	none	none
taskId	integer(int64)	false	none	none
warningKey	string	false	none	none

Job

{
  "creationDate": "2019-08-24T14:15:22Z",
  "exceptionToThrow": {
    "cause": {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "classLoaderName": "string",
          "moduleName": "string",
          "moduleVersion": "string",
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        {
          "stackTrace": [
            {
              "classLoaderName": "string",
              "moduleName": "string",
              "moduleVersion": "string",
              "methodName": "string",
              "fileName": "string",
              "lineNumber": 0,
              "className": "string",
              "nativeMethod": true
            }
          ],
          "message": "string",
          "localizedMessage": "string"
        }
      ]
    },
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "classLoaderName": "string",
        "moduleName": "string",
        "moduleVersion": "string",
        "methodName": "string",
        "fileName": "string",
        "lineNumber": 0,
        "className": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      {
        "stackTrace": [
          {
            "classLoaderName": "string",
            "moduleName": "string",
            "moduleVersion": "string",
            "methodName": "string",
            "fileName": "string",
            "lineNumber": 0,
            "className": "string",
            "nativeMethod": true
          }
        ],
        "message": "string",
        "localizedMessage": "string"
      }
    ]
  },
  "id": 0,
  "message": "string",
  "name": "string",
  "schedule": {
    "active": true,
    "endAfterRuns": 0,
    "endDateTime": "2019-08-24T14:15:22Z",
    "nextRunDateTime": "2019-08-24T14:15:22Z",
    "remainingRuns": 0,
    "repeatDaysOfMonth": [
      0
    ],
    "repeatDaysOfWeek": [
      0
    ],
    "repeatEvery": 0,
    "repeatHour": 0,
    "repeatMinute": 0,
    "repeatType": "MINUTE",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "RUNNING"
  },
  "type": "string",
  "updateDate": "2019-08-24T14:15:22Z",
  "user": "string"
}

Properties

Name	Type	Required	Restrictions	Description
creationDate	string(date-time)	false	none	none
exceptionToThrow	object	false	none	none
» cause	object	false	none	none
»» localizedMessage	string	false	none	none
»» message	string	false	none	none
»» stackTrace	[object]	false	none	none
»»» classLoaderName	string	false	none	none
»»» moduleName	string	false	none	none
»»» moduleVersion	string	false	none	none
»»» methodName	string	false	none	none
»»» fileName	string	false	none	none
»»» lineNumber	integer(int32)	false	none	none
»»» className	string	false	none	none
»»» nativeMethod	boolean	false	none	none
»» suppressed	[object]	false	none	none
»»» stackTrace	[object]	false	none	none
»»»» classLoaderName	string	false	none	none
»»»» moduleName	string	false	none	none
»»»» moduleVersion	string	false	none	none
»»»» methodName	string	false	none	none
»»»» fileName	string	false	none	none
»»»» lineNumber	integer(int32)	false	none	none
»»»» className	string	false	none	none
»»»» nativeMethod	boolean	false	none	none
»»» message	string	false	none	none
»»» localizedMessage	string	false	none	none
» localizedMessage	string	false	none	none
» message	string	false	none	none
» stackTrace	[object]	false	none	none
»» classLoaderName	string	false	none	none
»» moduleName	string	false	none	none
»» moduleVersion	string	false	none	none
»» methodName	string	false	none	none
»» fileName	string	false	none	none
»» lineNumber	integer(int32)	false	none	none
»» className	string	false	none	none
»» nativeMethod	boolean	false	none	none
» suppressed	[object]	false	none	none
»» stackTrace	[object]	false	none	none
»»» classLoaderName	string	false	none	none
»»» moduleName	string	false	none	none
»»» moduleVersion	string	false	none	none
»»» methodName	string	false	none	none
»»» fileName	string	false	none	none
»»» lineNumber	integer(int32)	false	none	none
»»» className	string	false	none	none
»»» nativeMethod	boolean	false	none	none
»» message	string	false	none	none
»» localizedMessage	string	false	none	none
id	integer(int64)	false	none	none
message	string	false	none	none
name	string	false	none	none
schedule	JobSchedule	false	none	none
type	string	true	none	none
updateDate	string(date-time)	false	none	none
user	string	false	none	none

JobSchedule

{
  "active": true,
  "endAfterRuns": 0,
  "endDateTime": "2019-08-24T14:15:22Z",
  "nextRunDateTime": "2019-08-24T14:15:22Z",
  "remainingRuns": 0,
  "repeatDaysOfMonth": [
    0
  ],
  "repeatDaysOfWeek": [
    0
  ],
  "repeatEvery": 0,
  "repeatHour": 0,
  "repeatMinute": 0,
  "repeatType": "MINUTE",
  "startDateTime": "2019-08-24T14:15:22Z",
  "status": "RUNNING"
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
endAfterRuns	integer(int32)	false	none	none
endDateTime	string(date-time)	false	none	none
nextRunDateTime	string(date-time)	false	none	none
remainingRuns	integer(int32)	false	none	none
repeatDaysOfMonth	[integer]	false	none	none
repeatDaysOfWeek	[integer]	false	none	none
repeatEvery	integer(int32)	false	none	none
repeatHour	integer(int32)	false	none	none
repeatMinute	integer(int32)	false	none	none
repeatType	string	false	none	none
startDateTime	string(date-time)	false	none	none
status	string	false	none	none

Enumerated Values

Property	Value
repeatType	MINUTE
repeatType	HOUR
repeatType	DAY
repeatType	WEEK
repeatType	MONTH
status	RUNNING
status	INACTIVE
status	ERROR
status	ENDED

Key

{
  "certificate": "string",
  "enabled": true,
  "privateKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
certificate	string	false	none	none
enabled	boolean	false	none	none
privateKey	string	false	none	none

LayoutBlock

{
  "blockParams": {
    "property1": {},
    "property2": {}
  },
  "templateName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
blockParams	object	false	none	none
» additionalProperties	object	false	none	none
templateName	string	false	none	none

LinkedAsset

{
  "changedAt": "2019-08-24T14:15:22Z",
  "changedBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "linkType": "ASSET",
  "name": "string",
  "parentFolderId": 0,
  "gatheringKey": "string",
  "path": "string",
  "publicAssetKey": "string",
  "contentType": "string",
  "sha1": "string",
  "privateAssetUrl": "string",
  "publicAssetUrl": "string"
}

Properties

allOf - discriminator: AssetFolderLink.linkType

Name	Type	Required	Restrictions	Description
anonymous	AssetFolderLink	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» gatheringKey	string	false	none	none
» path	string	false	none	none
» publicAssetKey	string	false	none	none
» contentType	string	false	none	none
» sha1	string	false	none	none
» privateAssetUrl	string	false	none	none
» publicAssetUrl	string	false	none	none

LinkedFolder

{
  "changedAt": "2019-08-24T14:15:22Z",
  "changedBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "linkType": "ASSET",
  "name": "string",
  "parentFolderId": 0,
  "folderId": 0
}

Properties

allOf - discriminator: AssetFolderLink.linkType

Name	Type	Required	Restrictions	Description
anonymous	AssetFolderLink	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» folderId	integer(int64)	false	none	none

MediaAssetExportRequest

{
  "items": {
    "property1": [
      {
        "property1": {},
        "property2": {}
      }
    ],
    "property2": [
      {
        "property1": {},
        "property2": {}
      }
    ]
  },
  "namingPattern": "string"
}

Properties

Name	Type	Required	Restrictions	Description
items	object	false	none	none
» additionalProperties	[object]	false	none	none
»» additionalProperties	object	false	none	none
namingPattern	string	false	none	none

Namespace

{}

Properties

None

OrganizationRequest_UserView

{
  "organizationId": 0,
  "recreateCookie": true
}

Properties

Name	Type	Required	Restrictions	Description
organizationId	integer(int64)	false	none	none
recreateCookie	boolean	false	none	none

OrganizationVerification_InternalView

{
  "connectorName": "string",
  "gln": "string",
  "verified": true
}

Properties

Name	Type	Required	Restrictions	Description
connectorName	string	false	none	none
gln	string	false	none	none
verified	boolean	false	none	none

Organization_InternalView

{
  "active": true,
  "activeExportMapping": "string",
  "address": "string",
  "baseURI": "http://example.com",
  "baseURIs": [
    "http://example.com"
  ],
  "communities": [
    0
  ],
  "communityManager": true,
  "connectorName": "string",
  "contactData": {
    "acceptanceDate": "2019-08-24T14:15:22Z",
    "address": "string",
    "contactRole": "DATA_SUPPLIER",
    "customValues": {
      "property1": {},
      "property2": {}
    },
    "date": "2019-08-24T14:15:22Z",
    "email": "string",
    "gln": "string",
    "id": 0,
    "imageUrl": "string",
    "invitationType": "INVITED_BUYER",
    "managedContact": true,
    "name": "string",
    "organizationId": 0,
    "state": "INVITED",
    "text": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "url": "string",
    "user": "string"
  },
  "customOrganizationId": "string",
  "customQueueMappings": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "customQueues": [
    "string"
  ],
  "customSite": "string",
  "customSiteFqdn": "string",
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "dataModelAutoUpdate": true,
  "dataModelClass": "string",
  "dataModelDataTypeVersions": {
    "property1": "string",
    "property2": "string"
  },
  "dataModelDeployedAt": "2019-08-24T14:15:22Z",
  "dataModelDeployedBy": "string",
  "dataModelDescriptions": {
    "property1": "string",
    "property2": "string"
  },
  "dataModelExternalRubyCalls": [
    "string"
  ],
  "dataModelExternalRubyCallsMode": true,
  "dataModelGatheringKey": "string",
  "dataModelHash": "string",
  "dataModelHashSdkVersion": "string",
  "dataModelJsonGatheringKey": "string",
  "dataModelLabels": {
    "property1": "string",
    "property2": "string"
  },
  "dataModelMigrate": true,
  "dataModelName": "string",
  "dataModelNamespace": "string",
  "dataModelOwnerGatheringKey": "string",
  "dataModelOwnerId": 0,
  "dataModelReleaseNotes": {
    "property1": "string",
    "property2": "string"
  },
  "dataModelVersion": "string",
  "dataModelWebApps": {
    "property1": "string",
    "property2": "string"
  },
  "dbCustomQueueMappings": [
    "string"
  ],
  "deleted": true,
  "deletedAt": "2019-08-24T14:15:22Z",
  "design": "string",
  "disableMonitoringModules": [
    "string"
  ],
  "effectiveDataModelNamespace": "string",
  "email": "string",
  "enableExternalRubyRuntime": true,
  "gln": "string",
  "globalProvider": true,
  "hasImage": true,
  "id": 0,
  "invitationReference": "string",
  "invitedOrganization": true,
  "isDataModelDeploying": true,
  "itemCount": 0,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastReminderEmailDate": "2019-08-24T14:15:22Z",
  "lastReminderEmailSent": true,
  "licensedDataModels": [
    "string"
  ],
  "licensedFeatures": [
    "string"
  ],
  "localeSpecificNumberFormat": true,
  "locales": [
    "string"
  ],
  "managedOrganization": true,
  "managingOrganizationId": 0,
  "mapping": "string",
  "marketingCampaigns": [
    "string"
  ],
  "marketingCampaignsFrequencyInterval": 0,
  "matchingInviteeDataModel": true,
  "name": "string",
  "orderedAdditionalLicenses": [
    "string"
  ],
  "orderedProfile": "string",
  "organizationRole": "COMMUNITY_MANAGER",
  "providedServices": [
    "string"
  ],
  "providerNamespaces": [
    "string"
  ],
  "reminderEmailSent": true,
  "reminderEmailSentDate": "2019-08-24T14:15:22Z",
  "scripts": {
    "property1": "string",
    "property2": "string"
  },
  "searchIndexesCurrentSizes": {
    "property1": 0,
    "property2": 0
  },
  "searchIndexesDiff": {
    "property1": 0,
    "property2": 0
  },
  "searchIndexesMaximumSizes": {
    "property1": 0,
    "property2": 0
  },
  "serviceProvider": true,
  "settings": {
    "property1": {},
    "property2": {}
  },
  "signupDate": "2019-08-24T14:15:22Z",
  "tenantNamespace": "string",
  "totalPublishedItemCount": 0,
  "translationsStoredAtDataModelOwner": true,
  "uniqueCustomOrganizationId": "string",
  "url": "string",
  "useOpensearch": true,
  "usesServices": [
    "string"
  ],
  "verified": true,
  "visible": true,
  "webHookKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
activeExportMapping	string	false	none	none
address	string	false	none	none
baseURI	string(uri)	false	none	none
baseURIs	[string]	false	none	none
communities	[integer]	false	none	none
communityManager	boolean	false	none	none
connectorName	string	false	none	none
contactData	Contact_InternalView	false	none	none
customOrganizationId	string	false	none	none
customQueueMappings	object	false	none	none
» additionalProperties	[string]	false	none	none
customQueues	[string]	false	none	none
customSite	string	false	none	none
customSiteFqdn	string	false	none	none
customValues	object	false	none	none
» additionalProperties	object	false	none	none
dataModelAutoUpdate	boolean	false	none	none
dataModelClass	string	false	none	none
dataModelDataTypeVersions	object	false	none	none
» additionalProperties	string	false	none	none
dataModelDeployedAt	string(date-time)	false	none	none
dataModelDeployedBy	string	false	none	none
dataModelDescriptions	object	false	none	none
» additionalProperties	string	false	none	none
dataModelExternalRubyCalls	[string]	false	none	none
dataModelExternalRubyCallsMode	boolean	false	none	none
dataModelGatheringKey	string	false	none	none
dataModelHash	string	false	none	none
dataModelHashSdkVersion	string	false	none	none
dataModelJsonGatheringKey	string	false	none	none
dataModelLabels	object	false	none	none
» additionalProperties	string	false	none	none
dataModelMigrate	boolean	false	none	none
dataModelName	string	false	none	none
dataModelNamespace	string	false	none	none
dataModelOwnerGatheringKey	string	false	none	none
dataModelOwnerId	integer(int64)	false	none	none
dataModelReleaseNotes	object	false	none	none
» additionalProperties	string	false	none	none
dataModelVersion	string	false	none	none
dataModelWebApps	object	false	none	none
» additionalProperties	string	false	none	none
dbCustomQueueMappings	[string]	false	none	none
deleted	boolean	false	none	none
deletedAt	string(date-time)	false	none	none
design	string	false	none	none
disableMonitoringModules	[string]	false	none	none
effectiveDataModelNamespace	string	false	none	none
email	string	false	none	none
enableExternalRubyRuntime	boolean	false	none	none
gln	string	false	none	none
globalProvider	boolean	false	none	none
hasImage	boolean	false	none	none
id	integer(int64)	false	none	none
invitationReference	string	false	none	none
invitedOrganization	boolean	false	none	none
isDataModelDeploying	boolean	false	none	none
itemCount	integer(int64)	false	none	none
lastLogin	string(date-time)	false	none	none
lastReminderEmailDate	string(date-time)	false	none	none
lastReminderEmailSent	boolean	false	none	none
licensedDataModels	[string]	false	none	none
licensedFeatures	[string]	false	none	none
localeSpecificNumberFormat	boolean	false	none	none
locales	[string]	false	none	none
managedOrganization	boolean	false	none	none
managingOrganizationId	integer(int64)	false	none	none
mapping	string	false	none	none
marketingCampaigns	[string]	false	none	none
marketingCampaignsFrequencyInterval	integer(int32)	false	none	none
matchingInviteeDataModel	boolean	false	none	none
name	string	false	none	none
orderedAdditionalLicenses	[string]	false	none	none
orderedProfile	string	false	none	none
organizationRole	string	false	none	none
providedServices	[string]	false	none	none
providerNamespaces	[string]	false	none	none
reminderEmailSent	boolean	false	none	none
reminderEmailSentDate	string(date-time)	false	none	none
scripts	object	false	none	none
» additionalProperties	string	false	none	none
searchIndexesCurrentSizes	object	false	none	none
» additionalProperties	integer(int64)	false	none	none
searchIndexesDiff	object	false	none	none
» additionalProperties	integer(int64)	false	none	none
searchIndexesMaximumSizes	object	false	none	none
» additionalProperties	integer(int64)	false	none	none
serviceProvider	boolean	false	none	none
settings	object	false	none	none
» additionalProperties	object	false	none	none
signupDate	string(date-time)	false	none	none
tenantNamespace	string	false	none	none
totalPublishedItemCount	integer(int32)	false	none	none
translationsStoredAtDataModelOwner	boolean	false	none	none
uniqueCustomOrganizationId	string	false	none	none
url	string	false	none	none
useOpensearch	boolean	false	none	none
usesServices	[string]	false	none	none
verified	boolean	false	none	none
visible	boolean	false	none	none
webHookKey	string	false	none	none

Enumerated Values

Property	Value
organizationRole	COMMUNITY_MANAGER
organizationRole	INVITED_BUYER
organizationRole	INVITED_COMMUNITY_MEMBER
organizationRole	INVITED_SUPPLIER

PairLongLong_InternalView

{
  "key": 0,
  "left": 0,
  "right": 0,
  "value": 0
}

Properties

Name	Type	Required	Restrictions	Description
key	integer(int64)	false	none	none
left	integer(int64)	false	none	none
right	integer(int64)	false	none	none
value	integer(int64)	false	none	none

PublicationDestination

{
  "destinationId": 0,
  "destinationType": "IN_PLATFORM",
  "subDestination": "string"
}

Properties

Name	Type	Required	Restrictions	Description
destinationId	integer(int64)	false	none	none
destinationType	string	false	none	none
subDestination	string	false	none	none

Enumerated Values

Property	Value
destinationType	IN_PLATFORM
destinationType	COMMUNICATION_CHANNEL

PublicationJob

{
  "creationDate": "2019-08-24T14:15:22Z",
  "exceptionToThrow": {
    "cause": {
      "localizedMessage": "string",
      "message": "string",
      "stackTrace": [
        {
          "classLoaderName": "string",
          "moduleName": "string",
          "moduleVersion": "string",
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "suppressed": [
        {
          "stackTrace": [
            {
              "classLoaderName": "string",
              "moduleName": "string",
              "moduleVersion": "string",
              "methodName": "string",
              "fileName": "string",
              "lineNumber": 0,
              "className": "string",
              "nativeMethod": true
            }
          ],
          "message": "string",
          "localizedMessage": "string"
        }
      ]
    },
    "localizedMessage": "string",
    "message": "string",
    "stackTrace": [
      {
        "classLoaderName": "string",
        "moduleName": "string",
        "moduleVersion": "string",
        "methodName": "string",
        "fileName": "string",
        "lineNumber": 0,
        "className": "string",
        "nativeMethod": true
      }
    ],
    "suppressed": [
      {
        "stackTrace": [
          {
            "classLoaderName": "string",
            "moduleName": "string",
            "moduleVersion": "string",
            "methodName": "string",
            "fileName": "string",
            "lineNumber": 0,
            "className": "string",
            "nativeMethod": true
          }
        ],
        "message": "string",
        "localizedMessage": "string"
      }
    ]
  },
  "id": 0,
  "message": "string",
  "name": "string",
  "schedule": {
    "active": true,
    "endAfterRuns": 0,
    "endDateTime": "2019-08-24T14:15:22Z",
    "nextRunDateTime": "2019-08-24T14:15:22Z",
    "remainingRuns": 0,
    "repeatDaysOfMonth": [
      0
    ],
    "repeatDaysOfWeek": [
      0
    ],
    "repeatEvery": 0,
    "repeatHour": 0,
    "repeatMinute": 0,
    "repeatType": "MINUTE",
    "startDateTime": "2019-08-24T14:15:22Z",
    "status": "RUNNING"
  },
  "type": "string",
  "updateDate": "2019-08-24T14:15:22Z",
  "user": "string",
  "destinationChannelIds": [
    0
  ],
  "destinationOrganizationIds": [
    0
  ],
  "channelSubDestinations": [
    "string"
  ],
  "selectionId": "string",
  "publicationType": "ADD",
  "publicationValues": {
    "property1": {},
    "property2": {}
  }
}

Properties

allOf - discriminator: Job.type

Name	Type	Required	Restrictions	Description
anonymous	Job	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» destinationChannelIds	[integer]	false	none	none
» destinationOrganizationIds	[integer]	false	none	none
» channelSubDestinations	[string]	false	none	none
» selectionId	string	false	none	none
» publicationType	string	false	none	none
» publicationValues	object	false	none	none
»» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
publicationType	ADD
publicationType	DELETE

PublicationRequest

{
  "destinations": [
    {
      "destinationId": 0,
      "destinationType": "IN_PLATFORM",
      "subDestination": "string"
    }
  ],
  "itemsQuery": {
    "bulkSubscriptionId": 0,
    "bulkSubscriptionName": "string",
    "category": "string",
    "compliant": true,
    "disableAdditionalAttributes": true,
    "errorKey": "string",
    "exactSearchAttributeName": "string",
    "exactSearchValues": [
      {}
    ],
    "items": [
      "string"
    ],
    "keyword": "string",
    "numberOfItems": 0,
    "publicationDestination": "string",
    "publicationStates": [
      "PENDING"
    ],
    "publicationStatus": "string",
    "publicationTaskId": 0,
    "publicationTaskStates": [
      "PENDING"
    ],
    "recipientKey": "string",
    "reviewErrorKey": "string",
    "reviewStatus": "string",
    "reviewWarningKey": "string",
    "reviewer": "string",
    "selectionId": "string",
    "tags": "string",
    "taskId": 0,
    "warningKey": "string"
  },
  "jobId": 0,
  "offset": 0,
  "partitionSize": 0,
  "publicationType": "ADD",
  "publicationValues": {
    "property1": {},
    "property2": {}
  },
  "selectionId": "string",
  "taskGroupId": "string",
  "user": "string"
}

Properties

Name	Type	Required	Restrictions	Description
destinations	[PublicationDestination]	false	none	none
itemsQuery	ItemQuery	false	none	none
jobId	integer(int64)	false	none	none
offset	integer(int32)	false	none	none
partitionSize	integer(int32)	false	none	none
publicationType	string	false	none	none
publicationValues	object	false	none	none
» additionalProperties	object	false	none	none
selectionId	string	false	none	none
taskGroupId	string	false	none	none
user	string	false	none	none

Enumerated Values

Property	Value
publicationType	ADD
publicationType	DELETE

Selection

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "id": "string",
  "itemsQuery": {
    "bulkSubscriptionId": 0,
    "bulkSubscriptionName": "string",
    "category": "string",
    "compliant": true,
    "disableAdditionalAttributes": true,
    "errorKey": "string",
    "exactSearchAttributeName": "string",
    "exactSearchValues": [
      {}
    ],
    "items": [
      "string"
    ],
    "keyword": "string",
    "numberOfItems": 0,
    "publicationDestination": "string",
    "publicationStates": [
      "PENDING"
    ],
    "publicationStatus": "string",
    "publicationTaskId": 0,
    "publicationTaskStates": [
      "PENDING"
    ],
    "recipientKey": "string",
    "reviewErrorKey": "string",
    "reviewStatus": "string",
    "reviewWarningKey": "string",
    "reviewer": "string",
    "selectionId": "string",
    "tags": "string",
    "taskId": 0,
    "warningKey": "string"
  },
  "primaryKeys": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
createdAt	string(date-time)	false	none	none
createdBy	string	false	none	none
id	string	false	none	none
itemsQuery	ItemQuery	false	none	none
primaryKeys	[string]	false	none	none

ServiceProvider

{
  "clientSecret": "string",
  "encryptionKey": {
    "certificate": "string",
    "enabled": true,
    "privateKey": "string"
  },
  "entityId": "string",
  "signingKey": {
    "certificate": "string",
    "enabled": true,
    "privateKey": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
clientSecret	string	false	none	none
encryptionKey	Key	false	none	none
entityId	string	false	none	none
signingKey	Key	false	none	none

ShoppingCart

{
  "accountId": "string",
  "id": 0,
  "items": [
    {
      "currency": "string",
      "description": "string",
      "id": 0,
      "price": "string",
      "primaryKey": "string",
      "quantity": "string",
      "shoppingCartId": 0,
      "totalPrice": "string"
    }
  ],
  "orderDate": "2019-08-24T14:15:22Z",
  "orderReference": "string"
}

Properties

Name	Type	Required	Restrictions	Description
accountId	string	false	none	none
id	integer(int64)	false	none	none
items	[ShoppingCartItem]	false	none	none
orderDate	string(date-time)	false	none	none
orderReference	string	false	none	none

ShoppingCartItem

{
  "currency": "string",
  "description": "string",
  "id": 0,
  "price": "string",
  "primaryKey": "string",
  "quantity": "string",
  "shoppingCartId": 0,
  "totalPrice": "string"
}

Properties

Name	Type	Required	Restrictions	Description
currency	string	false	none	none
description	string	false	none	none
id	integer(int64)	false	none	none
price	string	false	none	none
primaryKey	string	false	none	none
quantity	string	false	none	none
shoppingCartId	integer(int64)	false	none	none
totalPrice	string	false	none	none

SimpleLoginAccount_InternalView

{
  "active": true,
  "activeExportMapping": "string",
  "city": "string",
  "clientAddress": "string",
  "completedTours": [
    "string"
  ],
  "confirmed": true,
  "country": "string",
  "currentShoppingCartId": 0,
  "customSite": "string",
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "dashboardConfiguration": "string",
  "effectiveRoles": [
    "string"
  ],
  "email": "string",
  "firstName": "string",
  "fullName": "string",
  "groupIds": [
    0
  ],
  "id": 0,
  "imageUrl": "string",
  "invitationId": 0,
  "invitationReference": "string",
  "lastActivity": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "latLong": "string",
  "managingAccount": true,
  "normalizedEmail": "string",
  "normalizedNames": [
    "string"
  ],
  "normalizedUsername": "string",
  "notificationsLastRead": "2019-08-24T14:15:22Z",
  "organizationId": 0,
  "region": "string",
  "requestLocales": [
    {
      "language": "string",
      "displayName": "string",
      "country": "string",
      "variant": "string",
      "script": "string",
      "unicodeLocaleAttributes": [
        "string"
      ],
      "unicodeLocaleKeys": [
        "string"
      ],
      "displayLanguage": "string",
      "displayScript": "string",
      "displayCountry": "string",
      "displayVariant": "string",
      "extensionKeys": [
        "string"
      ],
      "iso3Language": "string",
      "iso3Country": "string"
    }
  ],
  "restrictionFilter": "string",
  "restrictionQuery": "string",
  "roles": [
    "string"
  ],
  "settings": {
    "property1": {},
    "property2": {}
  },
  "signupDate": "2019-08-24T14:15:22Z",
  "systemAccount": true,
  "tenantNamespace": "string",
  "userDataModelHash": "string",
  "userDataModelJsonGatheringKey": "string",
  "userId": "string",
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
activeExportMapping	string	false	none	none
city	string	false	none	none
clientAddress	string	false	none	none
completedTours	[string]	false	none	none
confirmed	boolean	false	none	none
country	string	false	none	none
currentShoppingCartId	integer(int64)	false	none	none
customSite	string	false	read-only	none
customValues	object	false	none	none
» additionalProperties	object	false	none	none
dashboardConfiguration	string	false	none	none
effectiveRoles	[string]	false	read-only	none
email	string	false	none	none
firstName	string	false	none	none
fullName	string	false	read-only	none
groupIds	[integer]	false	none	none
id	integer(int64)	false	none	none
imageUrl	string	false	none	none
invitationId	integer(int64)	false	read-only	none
invitationReference	string	false	read-only	none
lastActivity	string(date-time)	false	read-only	none
lastLogin	string(date-time)	false	read-only	none
lastName	string	false	none	none
latLong	string	false	none	none
managingAccount	boolean	false	none	none
normalizedEmail	string	false	read-only	none
normalizedNames	[string]	false	read-only	none
normalizedUsername	string	false	read-only	none
notificationsLastRead	string(date-time)	false	none	none
organizationId	integer(int64)	false	none	none
region	string	false	none	none
requestLocales	[object]	false	read-only	none
» language	string	false	none	none
» displayName	string	false	none	none
» country	string	false	none	none
» variant	string	false	none	none
» script	string	false	none	none
» unicodeLocaleAttributes	[string]	false	none	none
» unicodeLocaleKeys	[string]	false	none	none
» displayLanguage	string	false	none	none
» displayScript	string	false	none	none
» displayCountry	string	false	none	none
» displayVariant	string	false	none	none
» extensionKeys	[string]	false	none	none
» iso3Language	string	false	none	none
» iso3Country	string	false	none	none
restrictionFilter	string	false	none	none
restrictionQuery	string	false	none	none
roles	[string]	false	none	none
settings	object	false	none	none
» additionalProperties	object	false	none	none
signupDate	string(date-time)	false	read-only	none
systemAccount	boolean	false	none	none
tenantNamespace	string	false	none	none
userDataModelHash	string	false	read-only	none
userDataModelJsonGatheringKey	string	false	read-only	none
userId	string	false	read-only	none
username	string	false	none	none

SimpleMapping

{
  "id": 0,
  "linkedAttributes": [
    "string"
  ],
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	none	none
linkedAttributes	[string]	false	none	none
name	string	false	none	none

SimpleMappingEntry

{
  "key": "string",
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
value	string	false	none	none

SingleSignOnConfig

{
  "alternativeConfigs": {
    "property1": {
      "alternativeConfigs": {},
      "attributeMapping": {
        "property1": "string",
        "property2": "string"
      },
      "identityProvider": {
        "authenticationEndpoint": "string",
        "certificate": "string",
        "entityId": "string",
        "logoutEndpoint": "string"
      },
      "protocol": "SAML",
      "samlLoginBinding": "HTTP_REDIRECT",
      "samlLogoutBinding": "HTTP_REDIRECT",
      "serviceProvider": {
        "clientSecret": "string",
        "encryptionKey": {
          "certificate": "string",
          "enabled": true,
          "privateKey": "string"
        },
        "entityId": "string",
        "signingKey": {
          "certificate": "string",
          "enabled": true,
          "privateKey": "string"
        }
      },
      "settings": {
        "property1": {},
        "property2": {}
      },
      "variables": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "alternativeConfigs": {},
      "attributeMapping": {
        "property1": "string",
        "property2": "string"
      },
      "identityProvider": {
        "authenticationEndpoint": "string",
        "certificate": "string",
        "entityId": "string",
        "logoutEndpoint": "string"
      },
      "protocol": "SAML",
      "samlLoginBinding": "HTTP_REDIRECT",
      "samlLogoutBinding": "HTTP_REDIRECT",
      "serviceProvider": {
        "clientSecret": "string",
        "encryptionKey": {
          "certificate": "string",
          "enabled": true,
          "privateKey": "string"
        },
        "entityId": "string",
        "signingKey": {
          "certificate": "string",
          "enabled": true,
          "privateKey": "string"
        }
      },
      "settings": {
        "property1": {},
        "property2": {}
      },
      "variables": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "attributeMapping": {
    "property1": "string",
    "property2": "string"
  },
  "identityProvider": {
    "authenticationEndpoint": "string",
    "certificate": "string",
    "entityId": "string",
    "logoutEndpoint": "string"
  },
  "protocol": "SAML",
  "samlLoginBinding": "HTTP_REDIRECT",
  "samlLogoutBinding": "HTTP_REDIRECT",
  "serviceProvider": {
    "clientSecret": "string",
    "encryptionKey": {
      "certificate": "string",
      "enabled": true,
      "privateKey": "string"
    },
    "entityId": "string",
    "signingKey": {
      "certificate": "string",
      "enabled": true,
      "privateKey": "string"
    }
  },
  "settings": {
    "property1": {},
    "property2": {}
  },
  "variables": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
alternativeConfigs	object	false	none	none
» additionalProperties	SingleSignOnConfig	false	none	none
attributeMapping	object	false	none	none
» additionalProperties	string	false	none	none
identityProvider	IdentityProvider	false	none	none
protocol	string	false	none	none
samlLoginBinding	string	false	none	none
samlLogoutBinding	string	false	none	none
serviceProvider	ServiceProvider	false	none	none
settings	object	false	none	none
» additionalProperties	object	false	none	none
variables	object	false	none	none
» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
protocol	SAML
protocol	OIDC
samlLoginBinding	HTTP_REDIRECT
samlLoginBinding	HTTP_POST
samlLogoutBinding	HTTP_REDIRECT
samlLogoutBinding	HTTP_POST

Todo

{
  "assets": [
    "string"
  ],
  "assignee": "string",
  "author": "string",
  "chosenTransition": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "dueDate": "2019-08-24T14:15:22Z",
  "id": 0,
  "items": [
    "string"
  ],
  "notes": "string",
  "numberOfComments": 0,
  "selectionId": "string",
  "tags": [
    "string"
  ],
  "taskListId": 0,
  "taskStatus": "OPEN",
  "title": "string",
  "transitions": [
    {
      "defaultTransition": true,
      "key": "string",
      "text": "string"
    }
  ],
  "uploadGathering": "string"
}

Properties

Name	Type	Required	Restrictions	Description
assets	[string]	false	none	none
assignee	string	false	none	none
author	string	false	none	none
chosenTransition	string	false	none	none
createDate	string(date-time)	false	none	none
customValues	object	false	none	none
» additionalProperties	object	false	none	none
dueDate	string(date-time)	false	none	none
id	integer(int64)	false	none	none
items	[string]	false	none	none
notes	string	false	none	none
numberOfComments	integer(int32)	false	none	none
selectionId	string	false	none	none
tags	[string]	false	none	none
taskListId	integer(int64)	false	none	none
taskStatus	string	false	none	none
title	string	false	none	none
transitions	[Transition]	false	none	none
uploadGathering	string	false	none	none

Enumerated Values

Property	Value
taskStatus	OPEN
taskStatus	FINISHED

TodoList

{
  "defaultTaskList": true,
  "id": 0,
  "title": "string"
}

Properties

Name	Type	Required	Restrictions	Description
defaultTaskList	boolean	false	none	none
id	integer(int64)	false	none	none
title	string	false	none	none

Transition

{
  "defaultTransition": true,
  "key": "string",
  "text": "string"
}

Properties

Name	Type	Required	Restrictions	Description
defaultTransition	boolean	false	none	none
key	string	false	none	none
text	string	false	none	none

UpdateUserDataRequest_UserView

{
  "customValues": {
    "property1": {},
    "property2": {}
  },
  "firstName": "string",
  "imageUrl": "string",
  "lastName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
customValues	object	false	none	none
» additionalProperties	object	false	none	none
firstName	string	false	none	none
imageUrl	string	false	none	none
lastName	string	false	none	none

Upgrade

{
  "additionalLicense": "string",
  "billingAddress": {
    "address": "string",
    "firstName": "string",
    "name": "string"
  },
  "currency": "string",
  "plan": "string"
}

Properties

Name	Type	Required	Restrictions	Description
additionalLicense	string	false	none	none
billingAddress	Address	false	none	none
currency	string	false	none	none
plan	string	false	none	none

UsageLimit_InternalView

{
  "exceedances": {
    "property1": {
      "key": 0,
      "left": 0,
      "right": 0,
      "value": 0
    },
    "property2": {
      "key": 0,
      "left": 0,
      "right": 0,
      "value": 0
    }
  },
  "limits": {
    "property1": 0,
    "property2": 0
  },
  "usages": {
    "property1": 0,
    "property2": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
exceedances	object	false	read-only	none
» additionalProperties	PairLongLong_InternalView	false	none	none
limits	object	false	none	none
» additionalProperties	integer(int64)	false	none	none
usages	object	false	none	none
» additionalProperties	integer(int64)	false	none	none

UserGroup

{
  "groupName": "string",
  "id": 0,
  "organizationId": 0,
  "roles": [
    "string"
  ],
  "userIds": [
    0
  ]
}

Properties

Name	Type	Required	Restrictions	Description
groupName	string	false	none	none
id	integer(int64)	false	none	none
organizationId	integer(int64)	false	none	none
roles	[string]	false	none	none
userIds	[integer]	false	none	none

User_InternalView

{
  "active": true,
  "city": "string",
  "clientAddress": "string",
  "confirmed": true,
  "country": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "currentOrganizationId": 0,
  "customSite": "string",
  "email": "string",
  "firstName": "string",
  "fullName": "string",
  "id": 0,
  "imageUrl": "string",
  "lastName": "string",
  "latLong": "string",
  "migratedLegacyAccountId": 0,
  "normalizedEmail": "string",
  "normalizedNames": [
    "string"
  ],
  "normalizedUsername": "string",
  "organizationIds": [
    0
  ],
  "region": "string",
  "systemUser": true,
  "updatedDate": "2019-08-24T14:15:22Z",
  "userId": "string",
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
city	string	false	none	none
clientAddress	string	false	none	none
confirmed	boolean	false	none	none
country	string	false	none	none
creationDate	string(date-time)	false	read-only	none
currentOrganizationId	integer(int64)	false	none	none
customSite	string	false	read-only	none
email	string	false	none	none
firstName	string	false	none	none
fullName	string	false	read-only	none
id	integer(int64)	false	none	none
imageUrl	string	false	none	none
lastName	string	false	none	none
latLong	string	false	none	none
migratedLegacyAccountId	integer(int64)	false	none	none
normalizedEmail	string	false	read-only	none
normalizedNames	[string]	false	read-only	none
normalizedUsername	string	false	read-only	none
organizationIds	[integer]	false	read-only	none
region	string	false	none	none
systemUser	boolean	false	none	none
updatedDate	string(date-time)	false	read-only	none
userId	string	false	read-only	none
username	string	false	none	none