Global Trade and Supply Chain v0.0.1

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

REST API for Global Trade and Supply Chain building blocks.

License: Apache 2.0 License

Authentication

• API Key (apiKeyQueryAuthScheme)

  • Parameter Name: x-api-key, in: query.

• API Key (apiKeyHeaderAuthScheme)

  • Parameter Name: x-api-key, in: header.

• HTTP Authentication, scheme: bearer

• API Key (jwtCookieAuthScheme)
  • Parameter Name: auth_token, in: cookie.

Core

Core endpoints

Get the version of the API running

Code samples

GET / HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET / \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

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

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

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

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

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

print(r.json())

GET /

Get the version of the API running

Example responses

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Bootstrap any components that need initialization

Code samples

GET /bootstrap HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /bootstrap \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/bootstrap',
{
  method: 'GET',

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

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

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

r = requests.get('/bootstrap', headers = headers)

print(r.json())

GET /bootstrap

Bootstrap any components that need initialization

Example responses

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Auditable Item Graph

Store items and their associated data, and provide an immutable audit trail for the item. Includes relationships between the items to form a graph.

Features

• Create/update/retrieve data for an item
  • Properties
  • Primary Identifier
  • Secondary Identifiers (alternative IDs that can be used to find the item e.g. associated document IDs)
  • Relationships to other items (parent/child/inherits)
  • Resources associated with the item(documents, data feeds)
• Store the hash of the item data in immutable storage
• Complete immutable audit trail of all the changes to the item
• Search for the item by its primary or secondary identifiers

Extensions

• Blobs - create/update binary items resources (e.g. documents)
• JSON-LD - readable version of the item for interoperability

Use Cases

• Store the data for a consignment with associated documents
• Store the data for an item, related to a parent consignment and inheriting a product type

Get a list of items

Code samples

GET /auditable-item-graph/item HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item");
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());

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

r = requests.get('/auditable-item-graph/item', headers = headers)

print(r.json())

GET /auditable-item-graph/item

Get a list of items

Parameters

Name	In	Type	Required	Description
orderBy	query	string	false	Sort key.
direction	query	string	false	The direction to sort the items.
cursor	query	string	false	Cursor for a multi page request.
pageSize	query	number	false	Number of items to return.
shared	query	boolean	false	Return shared items.

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "created": 0,
      "updated": 0,
      "blobUrn": "string",
      "creator": "string",
      "tenantId": "string"
    }
  ],
  "cursor": "string",
  "pageSize": 0,
  "totalItems": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to list items request.	ItemListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Create an item

Code samples

POST /auditable-item-graph/item HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /auditable-item-graph/item \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "itemId": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item");
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());

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

r = requests.post('/auditable-item-graph/item', headers = headers)

print(r.json())

POST /auditable-item-graph/item

Create an item

Body parameter

{
  "itemId": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ItemCreateRequest	true	Create a new item.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

Get an item

Code samples

GET /auditable-item-graph/item/{itemId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}

Get an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id for an item.

Example responses

200 Response

{
  "id": "string",
  "created": 0,
  "updated": 0,
  "blobUrn": "string",
  "creator": "string",
  "tenantId": "string",
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "resources": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "relationships": [
    {
      "id": "string",
      "type": "child",
      "start": 0,
      "end": 0,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "permissions": [
    {
      "identity": "string",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for an item get request.	Item
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Update an item

Code samples

PUT /auditable-item-graph/item/{itemId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /auditable-item-graph/item/{itemId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}");
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());

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

r = requests.put('/auditable-item-graph/item/{itemId}', headers = headers)

print(r.json())

PUT /auditable-item-graph/item/{itemId}

Update an item

Body parameter

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The primary id for the item.
body	body	ItemUpdateRequest	true	Update an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Add permissions to an item

Code samples

POST /auditable-item-graph/item/{itemId}/permissions HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /auditable-item-graph/item/{itemId}/permissions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/permissions',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/permissions");
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());

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

r = requests.post('/auditable-item-graph/item/{itemId}/permissions', headers = headers)

print(r.json())

POST /auditable-item-graph/item/{itemId}/permissions

Add permissions to an item

Body parameter

{
  "identity": "string",
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id of the item to add the permission to.
body	body	Permission	true	Add permission request.

Example responses

200 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Update item permission

Code samples

PUT /auditable-item-graph/item/{itemId}/permissions/{identity} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /auditable-item-graph/item/{itemId}/permissions/{identity} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/permissions/{identity}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/permissions/{identity}");
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());

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

r = requests.put('/auditable-item-graph/item/{itemId}/permissions/{identity}', headers = headers)

print(r.json())

PUT /auditable-item-graph/item/{itemId}/permissions/{identity}

Update item permission

Body parameter

{
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id of the item to add the permission to.
identity	path	string	true	The identity to update the permission for.
body	body	ItemUpdatePermissionRequest	true	Update permission request.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Remove a permission from an item

Code samples

DELETE /auditable-item-graph/item/{itemId}/permissions/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /auditable-item-graph/item/{itemId}/permissions/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/permissions/{identity}',
{
  method: 'DELETE',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/permissions/{identity}");
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());

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

r = requests.delete('/auditable-item-graph/item/{itemId}/permissions/{identity}', headers = headers)

print(r.json())

DELETE /auditable-item-graph/item/{itemId}/permissions/{identity}

Remove a permission from an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id of the item to add the permission to.
identity	path	string	true	The identity to update the permission for.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get an items history

Code samples

GET /auditable-item-graph/item/{itemId}/history HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/history \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/history',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/history', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/history

Get an items history

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id for an item.
limit	query	number	false	Limit the number of items.
cursor	query	string	false	Cursor to get next chunk.

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "created": 0,
      "updated": 0,
      "blobUrn": "string",
      "creator": "string",
      "tenantId": "string",
      "aliasIds": [
        {
          "id": "string",
          "properties": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ]
        }
      ],
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "resources": [
        {
          "id": "string",
          "properties": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ]
        }
      ],
      "relationships": [
        {
          "id": "string",
          "type": "child",
          "start": 0,
          "end": 0,
          "properties": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ]
        }
      ],
      "permissions": [
        {
          "identity": "string",
          "properties": [
            {
              "type": "string",
              "value": null,
              "ttl": 0
            }
          ]
        }
      ]
    }
  ],
  "totalItems": 0,
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for an item history request.	ItemHistoryResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add an alias id to an item

Code samples

POST /auditable-item-graph/item/{itemId}/alias-id HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /auditable-item-graph/item/{itemId}/alias-id \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/alias-id',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/alias-id");
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());

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

r = requests.post('/auditable-item-graph/item/{itemId}/alias-id', headers = headers)

print(r.json())

POST /auditable-item-graph/item/{itemId}/alias-id

Add an alias id to an item

Body parameter

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
body	body	AliasId	true	Add a new alias id for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Merge new alias ids for an item

Code samples

PATCH /auditable-item-graph/item/{itemId}/alias-id HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PATCH /auditable-item-graph/item/{itemId}/alias-id \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/alias-id',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/alias-id");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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());

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

r = requests.patch('/auditable-item-graph/item/{itemId}/alias-id', headers = headers)

print(r.json())

PATCH /auditable-item-graph/item/{itemId}/alias-id

Merge new alias ids for an item

Body parameter

{
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
body	body	AliasIdMergeRequest	true	Merge alias ids for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get all the alias ids for an item

Code samples

GET /auditable-item-graph/item/{itemId}/alias-id HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/alias-id \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/alias-id',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/alias-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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/alias-id', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/alias-id

Get all the alias ids for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.

Example responses

200 Response

[
  {
    "id": "string",
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The list of all resources for an item.	ResourceListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get an alias id for an item

Code samples

GET /auditable-item-graph/item/{itemId}/alias-id/{aliasId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/alias-id/{aliasId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/alias-id/{aliasId}',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/alias-id/{aliasId}");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/alias-id/{aliasId}', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/alias-id/{aliasId}

Get an alias id for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
aliasId	path	string	true	The alias id.

Example responses

200 Response

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a resource get response.	ResourceGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Update an alias id for an item

Code samples

PUT /auditable-item-graph/item/{itemId}/alias-id/{aliasId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /auditable-item-graph/item/{itemId}/alias-id/{aliasId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/alias-id/{aliasId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/alias-id/{aliasId}");
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());

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

r = requests.put('/auditable-item-graph/item/{itemId}/alias-id/{aliasId}', headers = headers)

print(r.json())

PUT /auditable-item-graph/item/{itemId}/alias-id/{aliasId}

Update an alias id for an item

Body parameter

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
aliasId	path	string	true	The alias id.
body	body	AliasIdUpdateRequest	true	Update an alias id for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Add a resource to an item

Code samples

POST /auditable-item-graph/item/{itemId}/resource HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /auditable-item-graph/item/{itemId}/resource \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/resource',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/resource");
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());

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

r = requests.post('/auditable-item-graph/item/{itemId}/resource', headers = headers)

print(r.json())

POST /auditable-item-graph/item/{itemId}/resource

Add a resource to an item

Body parameter

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
body	body	ResourceAddRequest	true	Add a new resource for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get all the resources for an item

Code samples

GET /auditable-item-graph/item/{itemId}/resource HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/resource \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/resource',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/resource");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/resource', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/resource

Get all the resources for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.

Example responses

200 Response

[
  {
    "id": "string",
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The list of all resources for an item.	ResourceListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get a resource for an item

Code samples

GET /auditable-item-graph/item/{itemId}/resource/{resourceId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/resource/{resourceId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/resource/{resourceId}',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/resource/{resourceId}");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/resource/{resourceId}', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/resource/{resourceId}

Get a resource for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
resourceId	path	string	true	The resource id.

Example responses

200 Response

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a resource get response.	ResourceGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Update a resource for an item

Code samples

PUT /auditable-item-graph/item/{itemId}/resource/{resourceId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /auditable-item-graph/item/{itemId}/resource/{resourceId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/resource/{resourceId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/resource/{resourceId}");
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());

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

r = requests.put('/auditable-item-graph/item/{itemId}/resource/{resourceId}', headers = headers)

print(r.json())

PUT /auditable-item-graph/item/{itemId}/resource/{resourceId}

Update a resource for an item

Body parameter

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
resourceId	path	string	true	The resource id.
body	body	ResourceUpdateRequest	true	Update a resource for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Add a relationship to an item

Code samples

POST /auditable-item-graph/item/{itemId}/relationship HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /auditable-item-graph/item/{itemId}/relationship \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "type": "child",
  "start": 0,
  "end": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/relationship',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/relationship");
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());

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

r = requests.post('/auditable-item-graph/item/{itemId}/relationship', headers = headers)

print(r.json())

POST /auditable-item-graph/item/{itemId}/relationship

Add a relationship to an item

Body parameter

{
  "id": "string",
  "type": "child",
  "start": 0,
  "end": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
body	body	Relationship	true	Add a new relationship for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get all the relationships for an item

Code samples

GET /auditable-item-graph/item/{itemId}/relationship HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/relationship \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/relationship',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/relationship");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/relationship', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/relationship

Get all the relationships for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
type	query	any	false	Type of relationships to filter by.

Example responses

200 Response

[
  {
    "id": "string",
    "type": "child",
    "start": 0,
    "end": 0,
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The list of all relationships for an item.	RelationshipListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get a relationship for an item

Code samples

GET /auditable-item-graph/item/{itemId}/relationship/{relationshipId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/relationship/{relationshipId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/relationship/{relationshipId}',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/relationship/{relationshipId}");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/relationship/{relationshipId}', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/relationship/{relationshipId}

Get a relationship for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
relationshipId	path	string	true	The relationship id.

Example responses

200 Response

{
  "id": "string",
  "type": "child",
  "start": 0,
  "end": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a relationship get response.	Relationship
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Update a relationship for an item

Code samples

PUT /auditable-item-graph/item/{itemId}/relationship/{relationshipId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /auditable-item-graph/item/{itemId}/relationship/{relationshipId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "start": 0,
  "end": 0,
  "type": "child",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/relationship/{relationshipId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/relationship/{relationshipId}");
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());

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

r = requests.put('/auditable-item-graph/item/{itemId}/relationship/{relationshipId}', headers = headers)

print(r.json())

PUT /auditable-item-graph/item/{itemId}/relationship/{relationshipId}

Update a relationship for an item

Body parameter

{
  "start": 0,
  "end": 0,
  "type": "child",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
relationshipId	path	string	true	The relationship id.
body	body	RelationshipUpdateRequest	true	Update a relationship for an item.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Full text search for items

Code samples

GET /auditable-item-graph HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph");
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());

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

r = requests.get('/auditable-item-graph', headers = headers)

print(r.json())

GET /auditable-item-graph

Full text search for items

Parameters

Name	In	Type	Required	Description
search	query	string	false	The search string.

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "created": 0,
      "updated": 0,
      "blobUrn": "string",
      "creator": "string",
      "tenantId": "string"
    }
  ],
  "cursor": "string",
  "pageSize": 0,
  "totalItems": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to list items request.	ItemListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add a blob to an item

Code samples

POST /auditable-item-graph/item/{itemId}/blob HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /auditable-item-graph/item/{itemId}/blob \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "blobId": "string",
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/blob',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/blob");
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());

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

r = requests.post('/auditable-item-graph/item/{itemId}/blob', headers = headers)

print(r.json())

POST /auditable-item-graph/item/{itemId}/blob

Add a blob to an item

Body parameter

{
  "blobId": "string",
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
body	body	BlobAddRequest	true	Add a blob to an item.

Example responses

200 Response

[
  {
    "key": "string",
    "type": "string",
    "value": null
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	The response from adding a blob to an item.	BlobAddResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Update a blob for an item

Code samples

PUT /auditable-item-graph/item/{itemId}/blob/{blobId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /auditable-item-graph/item/{itemId}/blob/{blobId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/auditable-item-graph/item/{itemId}/blob/{blobId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/auditable-item-graph/item/{itemId}/blob/{blobId}");
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());

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

r = requests.put('/auditable-item-graph/item/{itemId}/blob/{blobId}', headers = headers)

print(r.json())

PUT /auditable-item-graph/item/{itemId}/blob/{blobId}

Update a blob for an item

Body parameter

{
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
blobId	path	string	true	The blob id.
body	body	BlobUpdateRequest	true	Update a blob for an item.

Example responses

200 Response

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "revisions": [
    {
      "storageId": "string",
      "fingerPrint": "string",
      "ts": 0,
      "blobSize": 0,
      "mimeType": "string",
      "reason": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response from updating a blob to an item.	BlobUpdateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get a blob for an item

Code samples

GET /auditable-item-graph/item/{itemId}/blob/{blobId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/blob/{blobId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/blob/{blobId}',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/blob/{blobId}");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/blob/{blobId}', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/blob/{blobId}

Get a blob for an item

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
blobId	path	string	true	The blob id.
revision	query	number	false	Optional revison, index 0 for the original to n revisions.

Example responses

200 Response

{
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "revisions": [
    {
      "storageId": "string",
      "fingerPrint": "string",
      "ts": 0,
      "blobSize": 0,
      "mimeType": "string",
      "reason": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a blob get response.	BlobGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get a url to view a blob

Code samples

GET /auditable-item-graph/item/{itemId}/blob/{blobId}/url HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/blob/{blobId}/url \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/blob/{blobId}/url',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/blob/{blobId}/url");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/blob/{blobId}/url', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/blob/{blobId}/url

Get a url to view a blob

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
blobId	path	string	true	The blob id.
revision	query	number	false	Optional revison, index 0 for the original to n revisions.
inline	query	boolean	false	Return the content as inline.

Example responses

200 Response

{
  "url": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a blob get response.	BlobUrlResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse
503	Service Unavailable	The service you requested it currently unavailable, see the error field for more details.	ServiceUnavailableResponse

View the blob

Code samples

GET /auditable-item-graph/item/{itemId}/blob/{blobId}/view HTTP/1.1

Accept: application/octet

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/blob/{blobId}/view \
  -H 'Accept: application/octet'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/blob/{blobId}/view',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/blob/{blobId}/view");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/blob/{blobId}/view', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/blob/{blobId}/view

View the blob

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.
blobId	path	string	true	The blob id.
revision	query	number	false	Optional revison, index 0 for the original to n revisions.
inline	query	boolean	false	Return the content as inline.

Example responses

200 Response

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The mime type may differ depending on the actual mime type of the blob	string
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get the item properties as JSON LD

Code samples

GET /auditable-item-graph/item/{itemId}/json-ld HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /auditable-item-graph/item/{itemId}/json-ld \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/auditable-item-graph/item/{itemId}/json-ld',
{
  method: 'GET',

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

URL obj = new URL("/auditable-item-graph/item/{itemId}/json-ld");
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());

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

r = requests.get('/auditable-item-graph/item/{itemId}/json-ld', headers = headers)

print(r.json())

GET /auditable-item-graph/item/{itemId}/json-ld

Get the item properties as JSON LD

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.

Example responses

200 Response

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a Json LD get response.	JsonLdObject
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Logger

Endpoints which are part of the Logger building block.

Create a log entry

Code samples

POST /logger HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /logger \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "level": "info",
  "source": "string",
  "ts": 0,
  "message": "string",
  "error": null,
  "data": null
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

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

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

r = requests.post('/logger', headers = headers)

print(r.json())

POST /logger

Create a log entry

Body parameter

{
  "level": "info",
  "source": "string",
  "ts": 0,
  "message": "string",
  "error": null,
  "data": null
}

Parameters

Name	In	Type	Required	Description
body	body	LogEntry	true	Create a new log entry.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get a list of the log entries

Code samples

GET /logger HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /logger \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/logger',
{
  method: 'GET',

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

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

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

r = requests.get('/logger', headers = headers)

print(r.json())

GET /logger

Get a list of the log entries

Parameters

Name	In	Type	Required	Description
level	query	any	false	The level of the log entries to retrieve.
source	query	string	false	The source of the log entries to retrieve.
timeStart	query	number	false	The start time of the metrics to retrieve.
timeEnd	query	number	false	The end time of the metrics to retrieve.
cursor	query	string	false	The optional cursor to get next chunk.

Example responses

200 Response

{
  "entries": [
    {
      "level": "info",
      "source": "string",
      "ts": 0,
      "message": "string",
      "error": null,
      "data": null
    }
  ],
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for log entry list request.	LoggerListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Indexing

Endpoints which are part of the Indexing building block.

Create an indexing alias

Code samples

POST /indexing/alias HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /indexing/alias \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "primaryUrn": "string",
  "aliasUrn": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/indexing/alias',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/indexing/alias', headers = headers)

print(r.json())

POST /indexing/alias

Create an indexing alias

Body parameter

{
  "primaryUrn": "string",
  "aliasUrn": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	IndexingAliasCreateRequest	true	Create a new alias for a primary urn.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Remove an indexing alias

Code samples

DELETE /indexing/alias HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X DELETE /indexing/alias \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "primaryUrn": "string",
  "aliasUrn": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/indexing/alias',
{
  method: 'DELETE',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.delete('/indexing/alias', headers = headers)

print(r.json())

DELETE /indexing/alias

Remove an indexing alias

Body parameter

{
  "primaryUrn": "string",
  "aliasUrn": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	IndexingAliasRemoveRequest	true	Remove an alias for a primary urn.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Search for an alias

Code samples

GET /indexing/alias HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /indexing/alias \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/indexing/alias',
{
  method: 'GET',

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

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

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

r = requests.get('/indexing/alias', headers = headers)

print(r.json())

GET /indexing/alias

Search for an alias

Parameters

Name	In	Type	Required	Description
search	query	string	false	The search string.

Example responses

200 Response

[]

Responses

Status	Meaning	Description	Schema
200	OK	none	ListOfstring
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get an indexing alias

Code samples

GET /indexing/alias/{alias} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /indexing/alias/{alias} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/indexing/alias/{alias}',
{
  method: 'GET',

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

URL obj = new URL("/indexing/alias/{alias}");
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());

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

r = requests.get('/indexing/alias/{alias}', headers = headers)

print(r.json())

GET /indexing/alias/{alias}

Get an indexing alias

Parameters

Name	In	Type	Required	Description
alias	path	string	true	The alias to lookup.

Example responses

200 Response

{
  "indexes": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for an indexing get alias request.	IndexingAliasGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Counters

Endpoints which are part of the Counters building block.

Create a counter

Code samples

POST /counters HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /counters \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "value": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

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

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

r = requests.post('/counters', headers = headers)

print(r.json())

POST /counters

Create a counter

Body parameter

{
  "value": 0
}

Parameters

Name	In	Type	Required	Description
body	body	CounterCreateRequest	true	Create a new counter.

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a counter creation.	CounterCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Remove a counter

Code samples

DELETE /counters/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /counters/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/counters/{id}',
{
  method: 'DELETE',

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

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

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

r = requests.delete('/counters/{id}', headers = headers)

print(r.json())

DELETE /counters/{id}

Remove a counter

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the counter to remove.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Update a counter

Code samples

PUT /counters/{id} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /counters/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "amount": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/counters/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

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

print(r.json())

PUT /counters/{id}

Update a counter

Body parameter

{
  "amount": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the counter to update.
body	body	CounterUpdateRequest	true	Update a counter.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get a counter

Code samples

GET /counters/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /counters/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/counters/{id}',
{
  method: 'GET',

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

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

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

r = requests.get('/counters/{id}', headers = headers)

print(r.json())

GET /counters/{id}

Get a counter

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the counter to get.

Example responses

200 Response

{
  "value": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a counter get.	CounterGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Reset a counter

Code samples

PUT /counters/{id}/reset HTTP/1.1

Accept: application/json

# You can also use wget
curl -X PUT /counters/{id}/reset \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/counters/{id}/reset',
{
  method: 'PUT',

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

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

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

r = requests.put('/counters/{id}/reset', headers = headers)

print(r.json())

PUT /counters/{id}/reset

Reset a counter

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the counter to reset.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Catalog Location

The catalog building block allows for the provision of reference data for use by other components.

Features

• Create/read/update/delete reference data
• Lookup reference data

Extensions

• Location - specific data type which allows lookups by GPS coords

Use Cases

• Organization maintaining a set of locations relevant to the supply chain
• Map status codes to descriptions

Create a catalog entity.

Code samples

POST /catalog-location HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /catalog-location \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "site": "string",
  "sst": "201",
  "ssa": "401",
  "ssd": "string",
  "name": "string",
  "streetAddressOne": "string",
  "streetAddressTwo": "string",
  "streetAddressThree": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string",
  "latitude": 0,
  "longitude": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/catalog-location',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/catalog-location', headers = headers)

print(r.json())

POST /catalog-location

Create a catalog entity.

Body parameter

{
  "id": "string",
  "site": "string",
  "sst": "201",
  "ssa": "401",
  "ssd": "string",
  "name": "string",
  "streetAddressOne": "string",
  "streetAddressTwo": "string",
  "streetAddressThree": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string",
  "latitude": 0,
  "longitude": 0
}

Parameters

Name	In	Type	Required	Description
body	body	Location	true	Create an item in the catalog.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

Get catalog entities by query.

Code samples

GET /catalog-location HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /catalog-location \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/catalog-location',
{
  method: 'GET',

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

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

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

r = requests.get('/catalog-location', headers = headers)

print(r.json())

GET /catalog-location

Get catalog entities by query.

Parameters

Name	In	Type	Required	Description
latitude	query	number	false	none
longitude	query	number	false	none

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "site": "string",
      "sst": "201",
      "ssa": "401",
      "ssd": "string",
      "name": "string",
      "streetAddressOne": "string",
      "streetAddressTwo": "string",
      "streetAddressThree": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for a catalog entity query request.	CatalogLocationFindResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get an entity from the catalog.

Code samples

GET /catalog-location/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /catalog-location/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/catalog-location/{id}',
{
  method: 'GET',

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

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

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

r = requests.get('/catalog-location/{id}', headers = headers)

print(r.json())

GET /catalog-location/{id}

Get an entity from the catalog.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id to be used to get the entity.

Example responses

200 Response

{
  "id": "string",
  "site": "string",
  "sst": "201",
  "ssa": "401",
  "ssd": "string",
  "name": "string",
  "streetAddressOne": "string",
  "streetAddressTwo": "string",
  "streetAddressThree": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string",
  "latitude": 0,
  "longitude": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for a catalog entity get request.	Location
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Update an entity in the catalog.

Code samples

PUT /catalog-location/{id} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /catalog-location/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "site": "string",
  "sst": "201",
  "ssa": "401",
  "ssd": "string",
  "name": "string",
  "streetAddressOne": "string",
  "streetAddressTwo": "string",
  "streetAddressThree": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string",
  "latitude": 0,
  "longitude": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/catalog-location/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.put('/catalog-location/{id}', headers = headers)

print(r.json())

PUT /catalog-location/{id}

Update an entity in the catalog.

Body parameter

{
  "id": "string",
  "site": "string",
  "sst": "201",
  "ssa": "401",
  "ssd": "string",
  "name": "string",
  "streetAddressOne": "string",
  "streetAddressTwo": "string",
  "streetAddressThree": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string",
  "latitude": 0,
  "longitude": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the entity to update.
body	body	Location	true	Update an entity in the catalog.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Remove an entity from the catalog.

Code samples

DELETE /catalog-location/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /catalog-location/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/catalog-location/{id}',
{
  method: 'DELETE',

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

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

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

r = requests.delete('/catalog-location/{id}', headers = headers)

print(r.json())

DELETE /catalog-location/{id}

Remove an entity from the catalog.

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id to be used to delete an entity.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Metrics

Endpoints which supply metrics information about the system.

Create a new metric

Code samples

POST /metrics HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /metrics \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "component": "string",
  "ts": 0,
  "type": "string",
  "data": null,
  "tenantId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

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

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

r = requests.post('/metrics', headers = headers)

print(r.json())

POST /metrics

Create a new metric

Body parameter

{
  "component": "string",
  "ts": 0,
  "type": "string",
  "data": null,
  "tenantId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	MetricsCreateRequest	true	Create a new metric.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get all the metrics with the filters specified

Code samples

GET /metrics HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /metrics \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/metrics',
{
  method: 'GET',

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

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

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

r = requests.get('/metrics', headers = headers)

print(r.json())

GET /metrics

Get all the metrics with the filters specified

Parameters

Name	In	Type	Required	Description
component	query	string	false	The component to get the metrics for.
timeStart	query	number	false	The start time of the metrics to retrieve.
timeEnd	query	number	false	The end time of the metrics to retrieve.
type	query	string	false	The type of the metrics to retrieve.
cursor	query	string	false	Cursor for paged lookups.

Example responses

200 Response

{
  "metrics": [
    {
      "id": "string",
      "component": "string",
      "ts": 0,
      "type": "string",
      "data": null,
      "tenantId": "string"
    }
  ],
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a metrics get.	MetricsGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Authentication

Endpoints which provide authentication features.

Create a login with an identity

Code samples

POST /authentication/login/create HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "emailAddress": "string",
  "password": "string",
  "role": "organization",
  "verifyEmail": true,
  "organizationId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/create',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/create");
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());

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

r = requests.post('/authentication/login/create', headers = headers)

print(r.json())

POST /authentication/login/create

Create a login with an identity

Body parameter

{
  "name": "string",
  "emailAddress": "string",
  "password": "string",
  "role": "organization",
  "verifyEmail": true,
  "organizationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginCreateRequest	true	Request to create a login.

Example responses

200 Response

{
  "recoveryPhrase": "string",
  "identity": "string",
  "publicKey": "string",
  "privateKey": "string",
  "token": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a create login request.	LoginCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Send verification for a created login

Code samples

POST /authentication/login/verify HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/verify \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "verificationType": "email"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/verify',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/verify");
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());

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

r = requests.post('/authentication/login/verify', headers = headers)

print(r.json())

POST /authentication/login/verify

Send verification for a created login

Body parameter

{
  "identity": "string",
  "verificationType": "email"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginVerifySendRequest	true	Request to verify some login information.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Confirm verification details for a created login

Code samples

GET /authentication/login/verify HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /authentication/login/verify \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/authentication/login/verify',
{
  method: 'GET',

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

URL obj = new URL("/authentication/login/verify");
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());

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

r = requests.get('/authentication/login/verify', headers = headers)

print(r.json())

GET /authentication/login/verify

Confirm verification details for a created login

Parameters

Name	In	Type	Required	Description
identity	query	string	false	The identity verify the login with.
type	query	any	false	The type of verification being performed.
confirm	query	string	false	The data to confirm the verification.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Check if a verification for a login is complete

Code samples

POST /authentication/login/verify/check HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/verify/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "verificationType": "email"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/verify/check',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/verify/check");
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());

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

r = requests.post('/authentication/login/verify/check', headers = headers)

print(r.json())

POST /authentication/login/verify/check

Check if a verification for a login is complete

Body parameter

{
  "identity": "string",
  "verificationType": "email"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginVerifyCheckRequest	true	Request to check if a verification has completed.

Example responses

200 Response

{
  "verified": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to check if a verification has completed.	LoginVerifyCheckResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Login with an identity

Code samples

POST /authentication/login HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string",
  "passwordHash": "string",
  "pin": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/authentication/login', headers = headers)

print(r.json())

POST /authentication/login

Login with an identity

Body parameter

{
  "emailAddress": "string",
  "passwordHash": "string",
  "pin": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginRequest	true	Request to login.

Example responses

200 Response

{
  "identity": "string",
  "twoFactorRequired": true,
  "twoFactorEnabled": true,
  "verifiedEmail": true,
  "token": "string",
  "accessGroups": [
    {
      "name": "string",
      "accessRights": [
        {
          "type": "READ",
          "properties": [
            {
              "type": "string",
              "value": null,
              "ttl": 0
            }
          ]
        }
      ],
      "identities": [
        "string"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a login request.	LoginResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Refresh the current login token

Code samples

POST /authentication/login/refresh HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/refresh',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/refresh");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

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

r = requests.post('/authentication/login/refresh', headers = headers)

print(r.json())

POST /authentication/login/refresh

Refresh the current login token

Body parameter

{
  "identity": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginRefreshRequest	true	Request to refresh with login.

Example responses

200 Response

{
  "identity": "string",
  "twoFactorEnabled": true,
  "verifiedEmail": true,
  "token": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a refresh login.	LoginRefreshResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Logout the current identity

Code samples

POST /authentication/logout HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/logout \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/logout',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/authentication/logout', headers = headers)

print(r.json())

POST /authentication/logout

Logout the current identity

Body parameter

{
  "identity": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LogoutRequest	true	Request to logout.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Create two-factor authentication for a login

Code samples

POST /authentication/login/2fa/create HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/2fa/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/2fa/create',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/2fa/create");
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());

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

r = requests.post('/authentication/login/2fa/create', headers = headers)

print(r.json())

POST /authentication/login/2fa/create

Create two-factor authentication for a login

Body parameter

{
  "identity": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginTwoFactorCreateRequest	true	Request to create a login.

Example responses

200 Response

{
  "twoFactorSecret": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a create login request.	LoginTwoFactorCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Enable or disable the two factor authentication

Code samples

POST /authentication/login/2fa/toggle HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/2fa/toggle \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "enableDisable": true,
  "pin": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/2fa/toggle',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/2fa/toggle");
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());

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

r = requests.post('/authentication/login/2fa/toggle', headers = headers)

print(r.json())

POST /authentication/login/2fa/toggle

Enable or disable the two factor authentication

Body parameter

{
  "identity": "string",
  "enableDisable": true,
  "pin": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginTwoFactorToggleRequest	true	Request to enable or disable two factor authentication.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update identity profile

Code samples

POST /authentication/account/profile HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/account/profile \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "emailAddress": "string",
  "taxPin": "string",
  "name": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/account/profile',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/account/profile");
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());

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

r = requests.post('/authentication/account/profile', headers = headers)

print(r.json())

POST /authentication/account/profile

Update identity profile

Body parameter

{
  "identity": "string",
  "emailAddress": "string",
  "taxPin": "string",
  "name": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ProfileUpdateRequest	true	Update identity profile.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update the password for the login

Code samples

POST /authentication/login/password HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "enableDisable": true,
  "pin": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/password',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/password");
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());

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

r = requests.post('/authentication/login/password', headers = headers)

print(r.json())

POST /authentication/login/password

Update the password for the login

Body parameter

{
  "identity": "string",
  "enableDisable": true,
  "pin": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginTwoFactorToggleRequest	true	Request to enable or disable two factor authentication.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Create an authentication token

Code samples

POST /authentication/token HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "name": "string",
  "ttl": 0
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/token',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/authentication/token', headers = headers)

print(r.json())

POST /authentication/token

Create an authentication token

Body parameter

{
  "identity": "string",
  "name": "string",
  "ttl": 0
}

Parameters

Name	In	Type	Required	Description
body	body	TokenCreateRequest	true	Request to create an access token.

Example responses

201 Response

{
  "id": "string",
  "created": 0,
  "token": "string",
  "expires": 0
}

Responses

Status	Meaning	Description	Schema
201	Created	The response to a create token request.	TokenCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Revoke an authentication token

Code samples

DELETE /authentication/token/{identity}/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /authentication/token/{identity}/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/authentication/token/{identity}/{id}',
{
  method: 'DELETE',

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

URL obj = new URL("/authentication/token/{identity}/{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());

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

r = requests.delete('/authentication/token/{identity}/{id}', headers = headers)

print(r.json())

DELETE /authentication/token/{identity}/{id}

Revoke an authentication token

Parameters

Name	In	Type	Required	Description
identity	path	string	true	none
id	path	string	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

List the authentication tokens

Code samples

GET /authentication/token/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /authentication/token/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/authentication/token/{identity}',
{
  method: 'GET',

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

URL obj = new URL("/authentication/token/{identity}");
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());

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

r = requests.get('/authentication/token/{identity}', headers = headers)

print(r.json())

GET /authentication/token/{identity}

List the authentication tokens

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to list the tokens for.
cursor	query	string	false	The cursor for paging.

Example responses

200 Response

{
  "tokens": [
    {
      "id": "string",
      "created": 0,
      "name": "string",
      "expires": 0
    }
  ],
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a list token request.	TokenListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Invite user to an organization

Code samples

POST /authentication/invite/user HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/invite/user \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/invite/user',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/invite/user");
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());

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

r = requests.post('/authentication/invite/user', headers = headers)

print(r.json())

POST /authentication/invite/user

Invite user to an organization

Body parameter

{
  "emailAddress": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	UserInviteRequest	true	Request to send an email invite.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Invite an autority to join TLIP

Code samples

POST /authentication/invite/authority HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/invite/authority \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string",
  "name": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/invite/authority',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/invite/authority");
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());

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

r = requests.post('/authentication/invite/authority', headers = headers)

print(r.json())

POST /authentication/invite/authority

Invite an autority to join TLIP

Body parameter

{
  "emailAddress": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AuthorityInviteRequest	true	Request to invite an authority.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

List pending user invites in an organization

Code samples

GET /authentication/organization/{identity}/pending-invites HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /authentication/organization/{identity}/pending-invites \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/authentication/organization/{identity}/pending-invites',
{
  method: 'GET',

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

URL obj = new URL("/authentication/organization/{identity}/pending-invites");
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());

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

r = requests.get('/authentication/organization/{identity}/pending-invites', headers = headers)

print(r.json())

GET /authentication/organization/{identity}/pending-invites

List pending user invites in an organization

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to get users for.
cursor	query	string	false	The cursor for paged requests.

Example responses

200 Response

{
  "nextPageCursor": "string",
  "pendingInvites": [
    {
      "email": "string",
      "status": "string",
      "timeToExpiry": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The request to list organization users.	ListOrganizationUsersResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Decode an authentication token

Code samples

POST /authentication/token/decode HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/token/decode \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "token": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/token/decode',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/token/decode");
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());

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

r = requests.post('/authentication/token/decode', headers = headers)

print(r.json())

POST /authentication/token/decode

Decode an authentication token

Body parameter

{
  "token": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	TokenDecodeRequest	true	Request to decode an access token.

Example responses

200 Response

{
  "sub": "string",
  "tenantId": "string",
  "iat": 0,
  "exp": 0,
  "tokenId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Request to decode an access token.	JwtToken
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Send password reset email

Code samples

POST /authentication/account/send-password-reset HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/account/send-password-reset \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/account/send-password-reset',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/account/send-password-reset");
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());

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

r = requests.post('/authentication/account/send-password-reset', headers = headers)

print(r.json())

POST /authentication/account/send-password-reset

Send password reset email

Body parameter

{
  "emailAddress": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	PasswordResetEmailRequest	true	Request to send password reset email.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Reset password

Code samples

POST /authentication/account/reset-password HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/account/reset-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string",
  "password": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/account/reset-password',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/account/reset-password");
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());

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

r = requests.post('/authentication/account/reset-password', headers = headers)

print(r.json())

POST /authentication/account/reset-password

Reset password

Body parameter

{
  "emailAddress": "string",
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ResetPasswordRequest	true	Request to reset password.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get organisation's api key

Code samples

GET /authentication/apiKey/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /authentication/apiKey/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/authentication/apiKey/{identity}',
{
  method: 'GET',

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

URL obj = new URL("/authentication/apiKey/{identity}");
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());

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

r = requests.get('/authentication/apiKey/{identity}', headers = headers)

print(r.json())

GET /authentication/apiKey/{identity}

Get organisation's api key

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to get api key for.

Example responses

200 Response

{
  "apiKey": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The request to get an api key.	ApiKeyResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Activate_Deactivate profile

Code samples

POST /authentication/account/profile/{identity}/toggleStatus HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/account/profile/{identity}/toggleStatus \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "active": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/account/profile/{identity}/toggleStatus',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/account/profile/{identity}/toggleStatus");
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());

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

r = requests.post('/authentication/account/profile/{identity}/toggleStatus', headers = headers)

print(r.json())

POST /authentication/account/profile/{identity}/toggleStatus

Activate/Deactivate profile

Body parameter

{
  "active": true
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity of the login.
body	body	ToggleProfileRequest	true	Toggle profile request.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Recover two-factor authentication for a login

Code samples

POST /authentication/login/2fa/recovery HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/2fa/recovery \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string",
  "recoveryCode": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/2fa/recovery',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/2fa/recovery");
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());

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

r = requests.post('/authentication/login/2fa/recovery', headers = headers)

print(r.json())

POST /authentication/login/2fa/recovery

Recover two-factor authentication for a login

Body parameter

{
  "emailAddress": "string",
  "recoveryCode": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	TwoFactorRecoveryRequest	true	Recover 2fa.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Unlock an authentication account

Code samples

POST /authentication/login/unlock HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /authentication/login/unlock \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/authentication/login/unlock',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/authentication/login/unlock");
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());

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

r = requests.post('/authentication/login/unlock', headers = headers)

print(r.json())

POST /authentication/login/unlock

Unlock an authentication account

Body parameter

{
  "emailAddress": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	UnlockAuthAccountRequest	true	Unlock account request.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Identity

Building block to provide all features related to digital identity in an organizational scenario.

Features

• Create/update DID with associated verification methods (public/private key pairs) - stored immutably
• Create/update/delete a profile associated with a DID (e.g. Organization/User/Device) - stored in regular storage so PPI (personal identifiable information) can be removed for GDPR compliance
• Create/update verifiable credential type requirements, specifies what claims data is needed to create a specific verifiable credential type. Requirements can be public or private - public is stored in the verifiable credential, private is stored in mutable storage for PII, GDPR compliance,
• Create/update a verifiable credential application for an identity (e.g. User applying to become a member of organization)
• Retrieve verifiable credentials by state (e.g. organization getting list of users applying to join)
• Issue a verifiable credential (e.g. User joining organization approved)
• Check the validity of a verifiable credential (e.g. User is a member of an organization)

Extensions

• Authentication - provides login facilities based on DIDs
• E-mail/Password/Two Factor authentication

Use Cases

• Organizations with users who can enroll to become a member of the organization
• Organizations offering some other kind of verification of an entity
• Associating a device with an organization

Create a new identity

Code samples

POST /identity HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /identity \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "role": "organization",
  "emailAddress": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

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

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

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

r = requests.post('/identity', headers = headers)

print(r.json())

POST /identity

Create a new identity

Body parameter

{
  "role": "organization",
  "emailAddress": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	IdentityCreateRequest	true	Create a new identity.

Example responses

200 Response

{
  "identity": "string",
  "recoveryPhrase": "string",
  "privateKey": "string",
  "publicKey": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Create a new identity.	IdentityCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update an identity

Code samples

PUT /identity/{identity} HTTP/1.1

Content-Type: application/json
Accept: application/json

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

const fetch = require('node-fetch');
const inputBody = {
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/{identity}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.put('/identity/{identity}', headers = headers)

print(r.json())

PUT /identity/{identity}

Update an identity

Body parameter

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to update.
body	body	IdentityUpdateRequest	true	Update an identity.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Set the profile for an identity

Code samples

PUT /identity/profile/{identity} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /identity/profile/{identity} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string",
  "taxPin": "string",
  "imageBase64": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/profile/{identity}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/identity/profile/{identity}");
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());

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

r = requests.put('/identity/profile/{identity}', headers = headers)

print(r.json())

PUT /identity/profile/{identity}

Set the profile for an identity

Body parameter

{
  "emailAddress": "string",
  "taxPin": "string",
  "imageBase64": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to update the profile.
body	body	ProfileSetRequest	true	Request to update a profile.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get the profile for an identity

Code samples

GET /identity/profile/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/profile/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/profile/{identity}',
{
  method: 'GET',

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

URL obj = new URL("/identity/profile/{identity}");
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());

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

r = requests.get('/identity/profile/{identity}', headers = headers)

print(r.json())

GET /identity/profile/{identity}

Get the profile for an identity

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to get the profile for.

Example responses

200 Response

{
  "role": "organization",
  "emailAddress": "string",
  "name": "string",
  "imageBase64": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to get a profile.	ProfileGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get the list of organizations

Code samples

GET /identity/organizations HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/organizations \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/organizations',
{
  method: 'GET',

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

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

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

r = requests.get('/identity/organizations', headers = headers)

print(r.json())

GET /identity/organizations

Get the list of organizations

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	The cursor for paged requests.
pageSize	query	number	false	Number of items to return.

Example responses

200 Response

{
  "cursor": "string",
  "organizations": [
    {
      "identity": "string",
      "name": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to get a list of organizations.	OrganizationsGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get the list of organization users

Code samples

GET /identity/organization/{identity}/users HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/organization/{identity}/users \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/organization/{identity}/users',
{
  method: 'GET',

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

URL obj = new URL("/identity/organization/{identity}/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

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

r = requests.get('/identity/organization/{identity}/users', headers = headers)

print(r.json())

GET /identity/organization/{identity}/users

Get the list of organization users

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity of the organization.
cursor	query	string	false	The cursor for paged requests.

Example responses

200 Response

{
  "cursor": "string",
  "organizations": [
    {
      "identity": "string",
      "name": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to get a list of organizations.	OrganizationsGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get an organization

Code samples

GET /identity/organization/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/organization/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/organization/{identity}',
{
  method: 'GET',

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

URL obj = new URL("/identity/organization/{identity}");
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());

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

r = requests.get('/identity/organization/{identity}', headers = headers)

print(r.json())

GET /identity/organization/{identity}

Get an organization

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity of the organization.

Example responses

200 Response

{
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to get an organization.	OrganizationGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Set the requirements for a verifiable credential

Code samples

PUT /identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "matchDomains": "string",
  "requiredClaims": [
    {
      "key": "string",
      "type": "string",
      "isPublic": true
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}");
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());

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

r = requests.put('/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}', headers = headers)

print(r.json())

PUT /identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}

Set the requirements for a verifiable credential

Body parameter

{
  "matchDomains": "string",
  "requiredClaims": [
    {
      "key": "string",
      "type": "string",
      "isPublic": true
    }
  ]
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity of the verifiable credential requirements.
verifiableCredentialType	path	string	true	The type of verifiable credential requirements being stored.
body	body	VerifiableCredentialRequirementsSetRequest	true	Request to set the requirements for a verifiable credential.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get the requirements for a verifiable credential

Code samples

GET /identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}',
{
  method: 'GET',

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

URL obj = new URL("/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}");
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());

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

r = requests.get('/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}', headers = headers)

print(r.json())

GET /identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}

Get the requirements for a verifiable credential

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity of the verifiable credential requirements.
verifiableCredentialType	path	string	true	The type of verifiable credential requirements being requested.

Example responses

200 Response

{
  "matchDomains": "string",
  "requiredClaims": [
    {
      "key": "string",
      "type": "string",
      "isPublic": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to get the requirements for a verifiable credential.	VerifiableCredentialRequirementsGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Create a verifiable credential

Code samples

POST /identity/verifiable-credentials HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /identity/verifiable-credentials \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "issuer": "string",
  "subject": "string",
  "verifiableCredentialType": "string",
  "claims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/verifiable-credentials',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/identity/verifiable-credentials");
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());

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

r = requests.post('/identity/verifiable-credentials', headers = headers)

print(r.json())

POST /identity/verifiable-credentials

Create a verifiable credential

Body parameter

{
  "issuer": "string",
  "subject": "string",
  "verifiableCredentialType": "string",
  "claims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	VerifiableCredentialCreateRequest	true	Create a verifiable credential.

Example responses

200 Response

{
  "id": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to creating a verifiable credential.	VerifiableCredentialCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get the verifiable credential applications for an identity

Code samples

GET /identity/verifiable-credentials/applications/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/verifiable-credentials/applications/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/verifiable-credentials/applications/{identity}',
{
  method: 'GET',

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

URL obj = new URL("/identity/verifiable-credentials/applications/{identity}");
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());

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

r = requests.get('/identity/verifiable-credentials/applications/{identity}', headers = headers)

print(r.json())

GET /identity/verifiable-credentials/applications/{identity}

Get the verifiable credential applications for an identity

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to get the verifiable credentials for.
identityIsIssuer	query	boolean	false	The identity is the issuer not the subject.
state	query	any	false	The state of the verifiable credential applications to get.
cursor	query	string	false	The cursor for paged requests.

Example responses

200 Response

{
  "cursor": "string",
  "applications": [
    {
      "id": "string",
      "issuer": "string",
      "subject": "string",
      "state": "pendingVerification",
      "created": 0,
      "updated": 0,
      "verifiableCredentialType": "string",
      "privateClaims": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "publicClaims": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "verifiableCredential": {
        "@context": "string",
        "id": "string",
        "type": [
          "string"
        ],
        "credentialSubject": null,
        "credentialStatus": {
          "id": "string",
          "type": "string",
          "property1": null,
          "property2": null
        },
        "issuer": "string",
        "issuanceDate": "string",
        "proof": {
          "type": "string",
          "verificationMethod": "string",
          "signatureValue": "string"
        }
      },
      "rejectedCode": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to get verifiable credential applications request.	VerifiableCredentialApplicationsGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update a verifiable credential

Code samples

PUT /identity/verifiable-credentials/{verifiableCredentialId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /identity/verifiable-credentials/{verifiableCredentialId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "state": "pendingVerification",
  "rejectedCode": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/verifiable-credentials/{verifiableCredentialId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/identity/verifiable-credentials/{verifiableCredentialId}");
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());

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

r = requests.put('/identity/verifiable-credentials/{verifiableCredentialId}', headers = headers)

print(r.json())

PUT /identity/verifiable-credentials/{verifiableCredentialId}

Update a verifiable credential

Body parameter

{
  "state": "pendingVerification",
  "rejectedCode": "string"
}

Parameters

Name	In	Type	Required	Description
verifiableCredentialId	path	string	true	The verifiable credential to update.
body	body	VerifiableCredentialUpdateRequest	true	Update a verifiable credential.

Example responses

200 Response

{
  "id": "string",
  "issuer": "string",
  "subject": "string",
  "state": "pendingVerification",
  "created": 0,
  "updated": 0,
  "verifiableCredentialType": "string",
  "privateClaims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "publicClaims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "verifiableCredential": {
    "@context": "string",
    "id": "string",
    "type": [
      "string"
    ],
    "credentialSubject": null,
    "credentialStatus": {
      "id": "string",
      "type": "string",
      "property1": null,
      "property2": null
    },
    "issuer": "string",
    "issuanceDate": "string",
    "proof": {
      "type": "string",
      "verificationMethod": "string",
      "signatureValue": "string"
    }
  },
  "rejectedCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response to an update of a verifiable credential.	IdentityVerifiableCredentialApplication
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get a verifiable credential

Code samples

GET /identity/verifiable-credentials/{verifiableCredentialId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /identity/verifiable-credentials/{verifiableCredentialId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/verifiable-credentials/{verifiableCredentialId}',
{
  method: 'GET',

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

URL obj = new URL("/identity/verifiable-credentials/{verifiableCredentialId}");
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());

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

r = requests.get('/identity/verifiable-credentials/{verifiableCredentialId}', headers = headers)

print(r.json())

GET /identity/verifiable-credentials/{verifiableCredentialId}

Get a verifiable credential

Parameters

Name	In	Type	Required	Description
verifiableCredentialId	path	string	true	The id of the verifiable credentials.

Example responses

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Check a verifiable credential

Code samples

POST /identity/verifiable-credentials/check HTTP/1.1

Accept: application/json

# You can also use wget
curl -X POST /identity/verifiable-credentials/check \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/identity/verifiable-credentials/check',
{
  method: 'POST',

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

URL obj = new URL("/identity/verifiable-credentials/check");
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());

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

r = requests.post('/identity/verifiable-credentials/check', headers = headers)

print(r.json())

POST /identity/verifiable-credentials/check

Check a verifiable credential

Example responses

200 Response

{
  "isVerified": true,
  "issuer": {
    "id": "string",
    "isVerified": true,
    "document": {
      "id": "string",
      "alsoKnownAs": "string",
      "controller": "string",
      "verificationMethod": [
        "string"
      ],
      "authentication": [
        "string"
      ],
      "assertionMethod": [
        "string"
      ],
      "keyAgreement": [
        "string"
      ],
      "capabilityInvocation": [
        "string"
      ],
      "capabilityDelegation": [
        "string"
      ],
      "service": [
        {
          "id": "string",
          "type": "string",
          "serviceEndpoint": "string"
        }
      ]
    }
  },
  "subjects": [
    {
      "id": "string",
      "isVerified": true,
      "document": {
        "id": "string",
        "alsoKnownAs": "string",
        "controller": "string",
        "verificationMethod": [
          "string"
        ],
        "authentication": [
          "string"
        ],
        "assertionMethod": [
          "string"
        ],
        "keyAgreement": [
          "string"
        ],
        "capabilityInvocation": [
          "string"
        ],
        "capabilityDelegation": [
          "string"
        ],
        "service": [
          {
            "id": "string",
            "type": "string",
            "serviceEndpoint": "string"
          }
        ]
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to get verifiable credential applications request.	DidCredentialVerification
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Sign data with the verification method for an identity

Code samples

POST /identity/data/sign/{identity} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /identity/data/sign/{identity} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "bytes": "string",
  "verificationMethod": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/data/sign/{identity}',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/identity/data/sign/{identity}");
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());

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

r = requests.post('/identity/data/sign/{identity}', headers = headers)

print(r.json())

POST /identity/data/sign/{identity}

Sign data with the verification method for an identity

Body parameter

{
  "bytes": "string",
  "verificationMethod": "string"
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to sign the data with.
body	body	SignDataRequest	true	Sign the requested data.

Example responses

200 Response

{
  "signatureType": "string",
  "signatureValue": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a sign data request.	SignDataResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Verify the data signed by an identity

Code samples

POST /identity/data/verify/{identity} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /identity/data/verify/{identity} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "bytes": "string",
  "verificationMethod": "string",
  "signatureType": "string",
  "signatureValue": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/identity/data/verify/{identity}',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/identity/data/verify/{identity}");
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());

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

r = requests.post('/identity/data/verify/{identity}', headers = headers)

print(r.json())

POST /identity/data/verify/{identity}

Verify the data signed by an identity

Body parameter

{
  "bytes": "string",
  "verificationMethod": "string",
  "signatureType": "string",
  "signatureValue": "string"
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to verify the data for.
body	body	VerifyDataRequest	true	Verify some signed data.

Example responses

200 Response

{
  "verified": true
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a data verification request.	VerifyDataResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Document Management

Building block to provide a simple mechanism for storing and verifying documents, with optional association as a resource to existing items.

Features

• Add a document
• Store the hash of the document and the DID of the entity adding the document
• Retrieve a document and verify its authenticity and author

Use Cases

• Adding a phyto-sanitary certificate to a consignment
• Associating a certificate of provenance with an item
• Creating a verifiable purchase order for sharing

Create a signed document

Code samples

POST /document-management HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /document-management \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "documentId": "string",
  "identity": "string",
  "bytes": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "auditableItemGraphId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/document-management',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/document-management', headers = headers)

print(r.json())

POST /document-management

Create a signed document

Body parameter

{
  "documentId": "string",
  "identity": "string",
  "bytes": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "auditableItemGraphId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	DocumentManagementCreateRequest	true	Create a new document.

Example responses

201 Response

{
  "proof": {
    "type": "DataIntegrityProof",
    "cryptosuite": "string",
    "created": "string",
    "verificationMethod": "string",
    "proofPurpose": "assertionMethod",
    "proofValue": "string"
  },
  "version": 0,
  "identity": "string",
  "blobStorageId": "string",
  "fileFormat": "string",
  "dateCreated": 0,
  "contentSize": 0,
  "fingerPrint": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "matrix": {
    "property1": null,
    "property2": null
  },
  "id": "string",
  "itemId": "string",
  "tenantId": "string",
  "history": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	The response to a document management creation.	DocumentOverview
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

Update and sign a document revision

Code samples

PUT /document-management/document/{documentId} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /document-management/document/{documentId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "documentId": "string",
  "identity": "string",
  "bytes": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "auditableItemGraphId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/document-management/document/{documentId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/document-management/document/{documentId}");
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());

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

r = requests.put('/document-management/document/{documentId}', headers = headers)

print(r.json())

PUT /document-management/document/{documentId}

Update and sign a document revision

Body parameter

{
  "documentId": "string",
  "identity": "string",
  "bytes": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "auditableItemGraphId": "string"
}

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	none
body	body	DocumentManagementCreateRequest	true	Create a new document.

Example responses

200 Response

{
  "proof": {
    "type": "DataIntegrityProof",
    "cryptosuite": "string",
    "created": "string",
    "verificationMethod": "string",
    "proofPurpose": "assertionMethod",
    "proofValue": "string"
  },
  "version": 0,
  "identity": "string",
  "blobStorageId": "string",
  "fileFormat": "string",
  "dateCreated": 0,
  "contentSize": 0,
  "fingerPrint": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "matrix": {
    "property1": null,
    "property2": null
  },
  "id": "string",
  "itemId": "string",
  "tenantId": "string",
  "history": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a document management creation.	DocumentOverview
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

Verify a document and get its details

Code samples

GET /document-management/document/{documentId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /document-management/document/{documentId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}");
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());

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

r = requests.get('/document-management/document/{documentId}', headers = headers)

print(r.json())

GET /document-management/document/{documentId}

Verify a document and get its details

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to verify.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
includeBytes	query	boolean	false	Include the bytes in the response.

Example responses

200 Response

{
  "overview": {
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "string",
      "created": "string",
      "verificationMethod": "string",
      "proofPurpose": "assertionMethod",
      "proofValue": "string"
    },
    "version": 0,
    "identity": "string",
    "blobStorageId": "string",
    "fileFormat": "string",
    "dateCreated": 0,
    "contentSize": 0,
    "fingerPrint": "string",
    "metadata": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "matrix": {
      "property1": null,
      "property2": null
    }
  },
  "verified": true,
  "bytes": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a document management verify request.	DocumentManagementVerifyResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Verify a document revision and get its details

Code samples

GET /document-management/document/{documentId}/revision/{revision} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /document-management/document/{documentId}/revision/{revision} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}/revision/{revision}',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}/revision/{revision}");
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());

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

r = requests.get('/document-management/document/{documentId}/revision/{revision}', headers = headers)

print(r.json())

GET /document-management/document/{documentId}/revision/{revision}

Verify a document revision and get its details

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to verify.
revision	path	string	true	The document revision to verify.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
includeBytes	query	boolean	false	Include the bytes in the response.
context	query	string	false	Include the signatures in the response.

Example responses

200 Response

{
  "overview": {
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "string",
      "created": "string",
      "verificationMethod": "string",
      "proofPurpose": "assertionMethod",
      "proofValue": "string"
    },
    "version": 0,
    "identity": "string",
    "blobStorageId": "string",
    "fileFormat": "string",
    "dateCreated": 0,
    "contentSize": 0,
    "fingerPrint": "string",
    "metadata": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "matrix": {
      "property1": null,
      "property2": null
    }
  },
  "verified": true,
  "bytes": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a document management verify request.	DocumentManagementVerifyResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get a list of all the documents for the identity

Code samples

GET /document-management/identity/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /document-management/identity/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/document-management/identity/{identity}',
{
  method: 'GET',

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

URL obj = new URL("/document-management/identity/{identity}");
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());

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

r = requests.get('/document-management/identity/{identity}', headers = headers)

print(r.json())

GET /document-management/identity/{identity}

Get a list of all the documents for the identity

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to list the documents for.
auditableItemGraphId	query	string	false	Id for auditable item graph to get the resources from.
cursor	query	string	false	Cursor for pages requests.

Example responses

200 Response

{
  "items": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      },
      "id": "string",
      "itemId": "string",
      "tenantId": "string",
      "history": [
        {
          "proof": {
            "type": "DataIntegrityProof",
            "cryptosuite": "string",
            "created": "string",
            "verificationMethod": "string",
            "proofPurpose": "assertionMethod",
            "proofValue": "string"
          },
          "version": 0,
          "identity": "string",
          "blobStorageId": "string",
          "fileFormat": "string",
          "dateCreated": 0,
          "contentSize": 0,
          "fingerPrint": "string",
          "metadata": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ],
          "matrix": {
            "property1": null,
            "property2": null
          }
        }
      ]
    }
  ],
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a document management list request.	DocumentManagementListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get a view url for the document

Code samples

GET /document-management/document/{documentId}/url HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /document-management/document/{documentId}/url \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}/url',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}/url");
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());

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

r = requests.get('/document-management/document/{documentId}/url', headers = headers)

print(r.json())

GET /document-management/document/{documentId}/url

Get a view url for the document

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to verify.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
inline	query	boolean	false	Return the content as inline.
ttl	query	number	false	The TTL of the URL in milliseconds.
revision	query	number	false	The document version.

Example responses

200 Response

{
  "url": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a document management url get response.	DocumentManagementViewUrlResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

View the document

Code samples

GET /document-management/document/{documentId}/view HTTP/1.1

Accept: application/octet

# You can also use wget
curl -X GET /document-management/document/{documentId}/view \
  -H 'Accept: application/octet'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}/view',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}/view");
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());

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

r = requests.get('/document-management/document/{documentId}/view', headers = headers)

print(r.json())

GET /document-management/document/{documentId}/view

View the document

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to view.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
inline	query	boolean	false	Return the content as inline.

Example responses

200 Response

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The mime type may differ depending on the actual mime type of the document	string
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

View the document revision

Code samples

GET /document-management/document/{documentId}/revision/{revision}/view HTTP/1.1

Accept: application/octet

# You can also use wget
curl -X GET /document-management/document/{documentId}/revision/{revision}/view \
  -H 'Accept: application/octet'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}/revision/{revision}/view',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}/revision/{revision}/view");
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());

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

r = requests.get('/document-management/document/{documentId}/revision/{revision}/view', headers = headers)

print(r.json())

GET /document-management/document/{documentId}/revision/{revision}/view

View the document revision

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to view.
revision	path	string	true	The document revision to view.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
inline	query	boolean	false	Return the content as inline.

Example responses

200 Response

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The mime type may differ depending on the actual mime type of the document	string
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Share the document via email

Code samples

POST /document-management/document/{documentId}/share HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /document-management/document/{documentId}/share \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddresses": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/document-management/document/{documentId}/share',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/document-management/document/{documentId}/share");
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());

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

r = requests.post('/document-management/document/{documentId}/share', headers = headers)

print(r.json())

POST /document-management/document/{documentId}/share

Share the document via email

Body parameter

{
  "emailAddresses": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to verify.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
documentType	query	string	false	Document Type.
revision	query	string,number	false	The revision of the document.
body	body	DocumentManagementShareRequest	true	none

Example responses

202 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
202	Accepted	The rest request ended in accepted response.	AcceptedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

View shared document

Code samples

GET /document-management/document/{documentId}/share/view HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /document-management/document/{documentId}/share/view \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}/share/view',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}/share/view");
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());

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

r = requests.get('/document-management/document/{documentId}/share/view', headers = headers)

print(r.json())

GET /document-management/document/{documentId}/share/view

View shared document

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to verify.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
documentType	query	string	false	Document Type.
revision	query	string,number	false	The revision of the document.

Example responses

200 Response

{
  "document": {
    "verified": true,
    "bytes": {
      "BYTES_PER_ELEMENT": 0,
      "buffer": {
        "byteLength": 0
      },
      "byteLength": 0,
      "byteOffset": 0,
      "length": 0,
      "property1": 0,
      "property2": 0
    },
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "string",
      "created": "string",
      "verificationMethod": "string",
      "proofPurpose": "assertionMethod",
      "proofValue": "string"
    },
    "version": 0,
    "identity": "string",
    "blobStorageId": "string",
    "fileFormat": "string",
    "dateCreated": 0,
    "contentSize": 0,
    "fingerPrint": "string",
    "metadata": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "matrix": {
      "property1": null,
      "property2": null
    }
  },
  "documentType": {
    "uri": "string",
    "name": "string",
    "code": "string",
    "identifierField": "string",
    "isStandardType": true,
    "isOpenGtsc": true
  },
  "documentViewUrl": "string",
  "documentDownloadUrl": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Get the view data for the document.	DocumentManagementViewShareResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Generate document sharing url

Code samples

GET /document-management/document/{documentId}/sharing-url HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /document-management/document/{documentId}/sharing-url \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/document-management/document/{documentId}/sharing-url',
{
  method: 'GET',

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

URL obj = new URL("/document-management/document/{documentId}/sharing-url");
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());

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

r = requests.get('/document-management/document/{documentId}/sharing-url', headers = headers)

print(r.json())

GET /document-management/document/{documentId}/sharing-url

Generate document sharing url

Parameters

Name	In	Type	Required	Description
documentId	path	string	true	The id of the document to verify.
auditableItemGraphId	query	string	false	Id for auditable item graph to add as a resource.
documentType	query	string	false	Document Type.
revision	query	string,number	false	The revision of the document.

Example responses

200 Response

{
  "documentSharingUrl": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Interface to define the response to get document sharing url.	DocumentManagementSharingUrlResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Inventory

Endpoints which are part of the Inventory building block.

Get inventory

Code samples

GET /inventory HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /inventory \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/inventory',
{
  method: 'GET',

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

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

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

r = requests.get('/inventory', headers = headers)

print(r.json())

GET /inventory

Get inventory

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	Cursor for paged lookups.
status	query	any	false	The item status.
location	query	string	false	The item location.
groupBy	query	string	false	The items grouping.
itemId	query	string	false	The item id.

Example responses

200 Response

{
  "items": [
    {
      "id": "string",
      "type": [
        "string"
      ],
      "inventoryLevel": [
        {
          "inventoryStatus": "commisioned",
          "value": 0,
          "location": "string"
        }
      ]
    }
  ],
  "cursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Interface describing inventory get response.	InventoryGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get item inventory

Code samples

GET /inventory/items/{itemId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /inventory/items/{itemId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/inventory/items/{itemId}',
{
  method: 'GET',

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

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

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

r = requests.get('/inventory/items/{itemId}', headers = headers)

print(r.json())

GET /inventory/items/{itemId}

Get item inventory

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The item id.

Example responses

200 Response

{
  "id": "string",
  "type": [
    "string"
  ],
  "inventoryLevel": [
    {
      "inventoryStatus": "commisioned",
      "value": 0,
      "location": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Interface for Item Inventory get response.	InventoryEntity
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

TLIP

Provides business-layer APIs for TLIP Bridge and UI.

Create a login with an identity

Code samples

POST /tlip/signup HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/signup \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "emailAddress": "string",
  "password": "string",
  "role": "organization",
  "verifyEmail": true,
  "organizationId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/signup',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/tlip/signup', headers = headers)

print(r.json())

POST /tlip/signup

Create a login with an identity

Body parameter

{
  "name": "string",
  "emailAddress": "string",
  "password": "string",
  "role": "organization",
  "verifyEmail": true,
  "organizationId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginCreateRequest	true	Request to create a login.

Example responses

200 Response

{
  "recoveryPhrase": "string",
  "identity": "string",
  "publicKey": "string",
  "privateKey": "string",
  "token": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a create login request.	LoginCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Login with an identity

Code samples

POST /tlip/login HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "emailAddress": "string",
  "passwordHash": "string",
  "pin": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/login',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/tlip/login', headers = headers)

print(r.json())

POST /tlip/login

Login with an identity

Body parameter

{
  "emailAddress": "string",
  "passwordHash": "string",
  "pin": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LoginRequest	true	Request to login.

Example responses

200 Response

{
  "identity": "string",
  "twoFactorRequired": true,
  "twoFactorEnabled": true,
  "verifiedEmail": true,
  "token": "string",
  "accessGroups": [
    {
      "name": "string",
      "accessRights": [
        {
          "type": "READ",
          "properties": [
            {
              "type": "string",
              "value": null,
              "ttl": 0
            }
          ]
        }
      ],
      "identities": [
        "string"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a login request.	LoginResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Create a new consignment

Code samples

POST /tlip/consignment HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/consignment \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identifiers": [
    {
      "type": "string",
      "id": "string"
    }
  ],
  "documents": [
    {
      "issuingCompany": "string",
      "data": {
        "binaryData": "string",
        "completionStatus": "complete",
        "issuer": "string"
      }
    }
  ],
  "items": [
    {
      "type": "string",
      "id": "string"
    }
  ],
  "consignmentType": "consignment",
  "itemsToShipment": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/consignment',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

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

r = requests.post('/tlip/consignment', headers = headers)

print(r.json())

POST /tlip/consignment

Create a new consignment

Body parameter

{
  "identifiers": [
    {
      "type": "string",
      "id": "string"
    }
  ],
  "documents": [
    {
      "issuingCompany": "string",
      "data": {
        "binaryData": "string",
        "completionStatus": "complete",
        "issuer": "string"
      }
    }
  ],
  "items": [
    {
      "type": "string",
      "id": "string"
    }
  ],
  "consignmentType": "consignment",
  "itemsToShipment": true
}

Parameters

Name	In	Type	Required	Description
body	body	ConsignmentCreateRequest	true	Create a new consignment.

Example responses

200 Response

{
  "consignmentId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a consignment creation.	ConsignmentCreateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Add consignments or commodities to a consignment

Code samples

POST /tlip/consignments/{itemId}/items HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/consignments/{itemId}/items \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "consignmentType": "consignment",
  "items": [
    {
      "type": "string",
      "id": "string"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/consignments/{itemId}/items',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/consignments/{itemId}/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());

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

r = requests.post('/tlip/consignments/{itemId}/items', headers = headers)

print(r.json())

POST /tlip/consignments/{itemId}/items

Add consignments or commodities to a consignment

Body parameter

{
  "consignmentType": "consignment",
  "items": [
    {
      "type": "string",
      "id": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id of the consignment.
body	body	ConsignmentAddItemsRequest	true	Add alias id to a consignment.

Example responses

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Add shared or existing consignments to a shipment.

Code samples

POST /tlip/consignments/{itemId}/add HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/consignments/{itemId}/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "consignments": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/consignments/{itemId}/add',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/consignments/{itemId}/add");
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());

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

r = requests.post('/tlip/consignments/{itemId}/add', headers = headers)

print(r.json())

POST /tlip/consignments/{itemId}/add

Add shared or existing consignments to a shipment.

Body parameter

{
  "consignments": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id of the consignment.
body	body	ConsignmentsAddRequest	true	Add consignments to a shipment.

Example responses

401 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get a consignment

Code samples

GET /tlip/consignments/{consignmentId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/consignments/{consignmentId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/consignments/{consignmentId}',
{
  method: 'GET',

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

URL obj = new URL("/tlip/consignments/{consignmentId}");
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());

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

r = requests.get('/tlip/consignments/{consignmentId}', headers = headers)

print(r.json())

GET /tlip/consignments/{consignmentId}

Get a consignment

Parameters

Name	In	Type	Required	Description
consignmentId	path	string	true	none
globalId	query	string	false	The consignment global identification id. Consignment UCR as per WCO standard.
customsId	query	string	false	The consignment customs declaration identification id. Consignment customs declaration number as per WCO standard.

Example responses

200 Response

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Consignment get response.	JsonLdObject
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get a consignment as JSON-LD

Code samples

GET /tlip/consignments/{consignmentId}/json-ld HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/consignments/{consignmentId}/json-ld \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/consignments/{consignmentId}/json-ld',
{
  method: 'GET',

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

URL obj = new URL("/tlip/consignments/{consignmentId}/json-ld");
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());

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

r = requests.get('/tlip/consignments/{consignmentId}/json-ld', headers = headers)

print(r.json())

GET /tlip/consignments/{consignmentId}/json-ld

Get a consignment as JSON-LD

Parameters

Name	In	Type	Required	Description
consignmentId	path	string	true	none

Example responses

200 Response

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	The details for a Json LD get response.	JsonLdObject
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add an identifier to a consignment

Code samples

POST /tlip/consignments/{itemId}/identifiers HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/consignments/{itemId}/identifiers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "aliasType": "string",
  "aliasId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/consignments/{itemId}/identifiers',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/consignments/{itemId}/identifiers");
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());

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

r = requests.post('/tlip/consignments/{itemId}/identifiers', headers = headers)

print(r.json())

POST /tlip/consignments/{itemId}/identifiers

Add an identifier to a consignment

Body parameter

{
  "aliasType": "string",
  "aliasId": "string"
}

Parameters

Name	In	Type	Required	Description
itemId	path	string	true	The id of the consignment.
body	body	ConsignmentAddIdentifierRequest	true	Add alias id to a consignment.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get consignments

Code samples

GET /tlip/consignments HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/consignments \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/consignments',
{
  method: 'GET',

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

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

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

r = requests.get('/tlip/consignments', headers = headers)

print(r.json())

GET /tlip/consignments

Get consignments

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Upload and associate a binary document with a consignment

Code samples

PUT /tlip/consignment/{consignmentId}/document/{documentType} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /tlip/consignment/{consignmentId}/document/{documentType} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "issuingCompany": "string",
  "data": {
    "binaryData": "string",
    "completionStatus": "complete",
    "issuer": "string"
  }
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/consignment/{consignmentId}/document/{documentType}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/consignment/{consignmentId}/document/{documentType}");
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());

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

r = requests.put('/tlip/consignment/{consignmentId}/document/{documentType}', headers = headers)

print(r.json())

PUT /tlip/consignment/{consignmentId}/document/{documentType}

Upload and associate a binary document with a consignment

Body parameter

{
  "issuingCompany": "string",
  "data": {
    "binaryData": "string",
    "completionStatus": "complete",
    "issuer": "string"
  }
}

Parameters

Name	In	Type	Required	Description
consignmentId	path	string	true	The consignment id or alias.
documentType	path	string	true	The type of document being stored.
body	body	ConsignmentDocumentCreateUpdateRequest	true	Create or update a consignment document.

Example responses

200 Response

{
  "id": "string",
  "revision": 0,
  "fingerPrint": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "identifiers": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "events": [
    {
      "itemId": "string",
      "type": "string",
      "identity": "string",
      "startTime": 0,
      "endTime": 0,
      "completionStatus": "complete",
      "action": "Request",
      "customTitle": "string",
      "fail": true,
      "code": 0,
      "location": {
        "name": "string",
        "longitude": 0,
        "latitude": 0
      },
      "documentRevision": 0,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "id": "string",
      "name": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to a document upload.	ConsignmentDocumentCreateUpdateResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Add an identifier type

Code samples

POST /tlip/identifier-types HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/identifier-types \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "uri": "string",
  "name": "string",
  "code": "string",
  "isStandardType": true,
  "isOpenGtsc": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/identifier-types',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/identifier-types");
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());

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

r = requests.post('/tlip/identifier-types', headers = headers)

print(r.json())

POST /tlip/identifier-types

Add an identifier type

Body parameter

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "isStandardType": true,
  "isOpenGtsc": true
}

Parameters

Name	In	Type	Required	Description
body	body	IdentifierType	true	Add identifier type to entity storage.

Example responses

201 Response

{}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

List identifier types

Code samples

GET /tlip/identifier-types HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/identifier-types \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/identifier-types',
{
  method: 'GET',

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

URL obj = new URL("/tlip/identifier-types");
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());

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

r = requests.get('/tlip/identifier-types', headers = headers)

print(r.json())

GET /tlip/identifier-types

List identifier types

Parameters

Name	In	Type	Required	Description
search	query	string	false	The search string.

Example responses

200 Response

{
  "items": [
    {
      "uri": "string",
      "name": "string",
      "code": "string",
      "isStandardType": true,
      "isOpenGtsc": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The identifier types list response.	IdentifierTypesListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Add document type

Code samples

POST /tlip/document-types HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/document-types \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "uri": "string",
  "name": "string",
  "code": "string",
  "identifierField": "string",
  "isStandardType": true,
  "isOpenGtsc": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/document-types',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/document-types");
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());

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

r = requests.post('/tlip/document-types', headers = headers)

print(r.json())

POST /tlip/document-types

Add document type

Body parameter

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "identifierField": "string",
  "isStandardType": true,
  "isOpenGtsc": true
}

Parameters

Name	In	Type	Required	Description
body	body	DocumentType	true	Update document type in entity storage.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

List of document types

Code samples

GET /tlip/document-types HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/document-types \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/document-types',
{
  method: 'GET',

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

URL obj = new URL("/tlip/document-types");
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());

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

r = requests.get('/tlip/document-types', headers = headers)

print(r.json())

GET /tlip/document-types

List of document types

Parameters

Name	In	Type	Required	Description
nextPageCursor	query	string	false	The cursor offset to get identitifer types from.
search	query	string	false	The search string.

Example responses

200 Response

{
  "items": [
    {
      "uri": "string",
      "name": "string",
      "code": "string",
      "identifierField": "string",
      "isStandardType": true,
      "isOpenGtsc": true,
      "defaultReaders": [
        "string"
      ],
      "defaultWriters": [
        "string"
      ]
    }
  ],
  "nextPageCursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Document types list response.	DocumentTypesListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update identifier type

Code samples

PUT /tlip/identifier-types/{code} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /tlip/identifier-types/{code} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "uri": "string",
  "name": "string",
  "code": "string",
  "isStandardType": true,
  "isOpenGtsc": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/identifier-types/{code}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/identifier-types/{code}");
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());

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

r = requests.put('/tlip/identifier-types/{code}', headers = headers)

print(r.json())

PUT /tlip/identifier-types/{code}

Update identifier type

Body parameter

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "isStandardType": true,
  "isOpenGtsc": true
}

Parameters

Name	In	Type	Required	Description
code	path	string	true	The code of the identifier type.
body	body	IdentifierType	true	Update identifier type in entity storage.

Example responses

201 Response

{}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in success with no data.	SuccessResponse
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Delete identifier type

Code samples

DELETE /tlip/identifier-types/{code} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /tlip/identifier-types/{code} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/identifier-types/{code}',
{
  method: 'DELETE',

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

URL obj = new URL("/tlip/identifier-types/{code}");
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());

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

r = requests.delete('/tlip/identifier-types/{code}', headers = headers)

print(r.json())

DELETE /tlip/identifier-types/{code}

Delete identifier type

Parameters

Name	In	Type	Required	Description
code	path	string	true	The code of the identifier type.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Update document type

Code samples

PUT /tlip/document-types/{code} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /tlip/document-types/{code} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "uri": "string",
  "name": "string",
  "code": "string",
  "identifierField": "string",
  "isStandardType": true,
  "isOpenGtsc": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/document-types/{code}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/document-types/{code}");
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());

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

r = requests.put('/tlip/document-types/{code}', headers = headers)

print(r.json())

PUT /tlip/document-types/{code}

Update document type

Body parameter

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "identifierField": "string",
  "isStandardType": true,
  "isOpenGtsc": true
}

Parameters

Name	In	Type	Required	Description
code	path	string	true	none
body	body	DocumentType	true	Update document type in entity storage.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Delete a document type

Code samples

DELETE /tlip/document-types/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /tlip/document-types/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/document-types/{id}',
{
  method: 'DELETE',

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

URL obj = new URL("/tlip/document-types/{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());

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

r = requests.delete('/tlip/document-types/{id}', headers = headers)

print(r.json())

DELETE /tlip/document-types/{id}

Delete a document type

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the document type locally defined by TLIP.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add an event type

Code samples

POST /tlip/event-types HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/event-types \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "name": "string",
  "uri": {},
  "createName": "string",
  "inProgressName": "string",
  "documentType": "string",
  "code": 0,
  "isOpenGtsc": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/event-types',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/event-types");
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());

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

r = requests.post('/tlip/event-types', headers = headers)

print(r.json())

POST /tlip/event-types

Add an event type

Body parameter

{
  "id": "string",
  "name": "string",
  "uri": {},
  "createName": "string",
  "inProgressName": "string",
  "documentType": "string",
  "code": 0,
  "isOpenGtsc": true
}

Parameters

Name	In	Type	Required	Description
body	body	TLIPEventType	true	Add event type to entity storage.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

List event types

Code samples

GET /tlip/event-types HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/event-types \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/event-types',
{
  method: 'GET',

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

URL obj = new URL("/tlip/event-types");
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());

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

r = requests.get('/tlip/event-types', headers = headers)

print(r.json())

GET /tlip/event-types

List event types

Parameters

Name	In	Type	Required	Description
nextPageCursor	query	string	false	The cursor offset to get event types from.
search	query	string	false	The search string.

Example responses

200 Response

{
  "eventTypes": [
    {
      "id": "string",
      "name": "string",
      "uri": {},
      "createName": "string",
      "inProgressName": "string",
      "documentType": "string",
      "code": 0,
      "isOpenGtsc": true
    }
  ],
  "nextPageCursor": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The event types list response.	EventTypesListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update event type

Code samples

PUT /tlip/event-types/{id} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /tlip/event-types/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "id": "string",
  "name": "string",
  "uri": {},
  "createName": "string",
  "inProgressName": "string",
  "documentType": "string",
  "code": 0,
  "isOpenGtsc": true
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/event-types/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/event-types/{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());

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

r = requests.put('/tlip/event-types/{id}', headers = headers)

print(r.json())

PUT /tlip/event-types/{id}

Update event type

Body parameter

{
  "id": "string",
  "name": "string",
  "uri": {},
  "createName": "string",
  "inProgressName": "string",
  "documentType": "string",
  "code": 0,
  "isOpenGtsc": true
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	TLIPEventType	true	Add event type to entity storage.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Delete event type

Code samples

DELETE /tlip/event-types/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /tlip/event-types/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/event-types/{id}',
{
  method: 'DELETE',

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

URL obj = new URL("/tlip/event-types/{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());

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

r = requests.delete('/tlip/event-types/{id}', headers = headers)

print(r.json())

DELETE /tlip/event-types/{id}

Delete event type

Parameters

Name	In	Type	Required	Description
id	path	string	true	The id of the event type.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add an event

Code samples

POST /tlip/consignments/{consignmentId}/events HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/consignments/{consignmentId}/events \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/consignments/{consignmentId}/events',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/consignments/{consignmentId}/events");
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());

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

r = requests.post('/tlip/consignments/{consignmentId}/events', headers = headers)

print(r.json())

POST /tlip/consignments/{consignmentId}/events

Add an event

Body parameter

{
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
consignmentId	path	string	true	Id of the consignment to add events to.
body	body	SimpleEventData	true	The event request.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
422	Unprocessable Entity	The operation could not be processed, see the error field for more details.	UnprocessableEntityResponse

List events

Code samples

GET /tlip/consignments/{consignmentId}/events HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/consignments/{consignmentId}/events \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/consignments/{consignmentId}/events',
{
  method: 'GET',

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

URL obj = new URL("/tlip/consignments/{consignmentId}/events");
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());

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

r = requests.get('/tlip/consignments/{consignmentId}/events', headers = headers)

print(r.json())

GET /tlip/consignments/{consignmentId}/events

List events

Parameters

Name	In	Type	Required	Description
consignmentId	path	string	true	The id of the consignment.

Example responses

200 Response

{
  "events": [
    {
      "itemId": "string",
      "type": "string",
      "identity": "string",
      "startTime": 0,
      "endTime": 0,
      "completionStatus": "complete",
      "action": "Request",
      "customTitle": "string",
      "fail": true,
      "code": 0,
      "location": {
        "name": "string",
        "longitude": 0,
        "latitude": 0
      },
      "documentRevision": 0,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "id": "string",
      "name": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response of list events.	EventsListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

List documents

Code samples

GET /tlip/consignments/{consignmentId}/documents HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/consignments/{consignmentId}/documents \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/consignments/{consignmentId}/documents',
{
  method: 'GET',

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

URL obj = new URL("/tlip/consignments/{consignmentId}/documents");
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());

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

r = requests.get('/tlip/consignments/{consignmentId}/documents', headers = headers)

print(r.json())

GET /tlip/consignments/{consignmentId}/documents

List documents

Parameters

Name	In	Type	Required	Description
consignmentId	path	string	true	The id of the consignment.

Example responses

200 Response

{
  "items": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      },
      "id": "string",
      "itemId": "string",
      "tenantId": "string",
      "history": [
        {
          "proof": {
            "type": "DataIntegrityProof",
            "cryptosuite": "string",
            "created": "string",
            "verificationMethod": "string",
            "proofPurpose": "assertionMethod",
            "proofValue": "string"
          },
          "version": 0,
          "identity": "string",
          "blobStorageId": "string",
          "fileFormat": "string",
          "dateCreated": 0,
          "contentSize": 0,
          "fingerPrint": "string",
          "metadata": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ],
          "matrix": {
            "property1": null,
            "property2": null
          }
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List documents response.	DocumentsListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

List organization users

Code samples

GET /tlip/users HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/users \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/users',
{
  method: 'GET',

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

URL obj = new URL("/tlip/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

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

r = requests.get('/tlip/users', headers = headers)

print(r.json())

GET /tlip/users

List organization users

Parameters

Name	In	Type	Required	Description
cursor	query	string	false	The cursor for paged requests.

Example responses

200 Response

{
  "nextPageCursor": "string",
  "users": [
    {
      "email": "string",
      "name": "string",
      "accountLocked": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to list organization users.	OrganizationUsersListResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Get display matrix

Code samples

GET /tlip/matrix-display HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X GET /tlip/matrix-display \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/matrix-display',
{
  method: 'GET',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/matrix-display");
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());

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

r = requests.get('/tlip/matrix-display', headers = headers)

print(r.json())

GET /tlip/matrix-display

Get display matrix

Body parameter

{}

Parameters

Name	In	Type	Required	Description
body	body	MatrixDisplayGetRequest	true	The request to get display matrix.

Example responses

200 Response

{
  "groups": [
    {
      "label": "string",
      "arrayField": "string",
      "fields": [
        {
          "label": "string",
          "id": "string",
          "format": "linebreak",
          "fields": [
            {}
          ]
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The response to get display matrix.	MatrixDisplayGetResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Check the health of services that tlip depend on

Code samples

GET /tlip/health HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/health \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/health',
{
  method: 'GET',

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

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

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

r = requests.get('/tlip/health', headers = headers)

print(r.json())

GET /tlip/health

Check the health of services that tlip depend on

Example responses

200 Response

{
  "entityStorage": "string",
  "blobStorage": "string",
  "immutableStorage": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Health check response.	HealthCheckServices
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Full text search for consignments

Code samples

GET /tlip/consignment/search HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/consignment/search \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/consignment/search',
{
  method: 'GET',

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

URL obj = new URL("/tlip/consignment/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

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

r = requests.get('/tlip/consignment/search', headers = headers)

print(r.json())

GET /tlip/consignment/search

Full text search for consignments

Parameters

Name	In	Type	Required	Description
value	query	string	false	The search string.

Example responses

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add an access group

Code samples

POST /tlip/access-groups HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip/access-groups \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "accessRights": [
    {
      "type": "READ",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ],
  "identities": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/access-groups',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/access-groups");
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());

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

r = requests.post('/tlip/access-groups', headers = headers)

print(r.json())

POST /tlip/access-groups

Add an access group

Body parameter

{
  "name": "string",
  "accessRights": [
    {
      "type": "READ",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ],
  "identities": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	AccessGroup	true	Add access group.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

List access groups

Code samples

GET /tlip/access-groups HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X GET /tlip/access-groups \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/access-groups',
{
  method: 'GET',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/access-groups");
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());

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

r = requests.get('/tlip/access-groups', headers = headers)

print(r.json())

GET /tlip/access-groups

List access groups

Body parameter

{}

Parameters

Name	In	Type	Required	Description
body	body	NoContentResponse	true	The rest request ended in success with no data.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update an access group

Code samples

PUT /tlip/access-groups/{name} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /tlip/access-groups/{name} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "accessRights": [
    {
      "type": "READ",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ],
  "identities": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/access-groups/{name}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/access-groups/{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());

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

r = requests.put('/tlip/access-groups/{name}', headers = headers)

print(r.json())

PUT /tlip/access-groups/{name}

Update an access group

Body parameter

{
  "name": "string",
  "accessRights": [
    {
      "type": "READ",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ],
  "identities": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the access group.
body	body	AccessGroup	true	Update access group.

Example responses

201 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The rest request ended in created response.	CreatedResponse
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Delete an access group

Code samples

DELETE /tlip/access-groups/{name} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /tlip/access-groups/{name} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/access-groups/{name}',
{
  method: 'DELETE',

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

URL obj = new URL("/tlip/access-groups/{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());

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

r = requests.delete('/tlip/access-groups/{name}', headers = headers)

print(r.json())

DELETE /tlip/access-groups/{name}

Delete an access group

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the access group.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add profile to an access group

Code samples

PUT /tlip/access-groups/{name}/add HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /tlip/access-groups/{name}/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identities": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/access-groups/{name}/add',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/access-groups/{name}/add");
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());

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

r = requests.put('/tlip/access-groups/{name}/add', headers = headers)

print(r.json())

PUT /tlip/access-groups/{name}/add

Add profile to an access group

Body parameter

{
  "identities": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the access group..
body	body	ModifyAccessToGroupRequest	true	Modify access request.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Remove profile from an access group

Code samples

DELETE /tlip/access-groups/{name}/remove HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X DELETE /tlip/access-groups/{name}/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identities": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip/access-groups/{name}/remove',
{
  method: 'DELETE',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip/access-groups/{name}/remove");
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());

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

r = requests.delete('/tlip/access-groups/{name}/remove', headers = headers)

print(r.json())

DELETE /tlip/access-groups/{name}/remove

Remove profile from an access group

Body parameter

{
  "identities": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
name	path	string	true	none
body	body	ModifyAccessToGroupRequest	true	Modify access request.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	SuccessResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

List organization activity logs

Code samples

GET /tlip/activity-logs HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip/activity-logs \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip/activity-logs',
{
  method: 'GET',

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

URL obj = new URL("/tlip/activity-logs");
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());

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

r = requests.get('/tlip/activity-logs', headers = headers)

print(r.json())

GET /tlip/activity-logs

List organization activity logs

Parameters

Name	In	Type	Required	Description
nextPageCursor	query	string	false	The cursor offset to get identitifer types from.
pageSize	query	number	false	Maximum mumber of items to return per page.
search	query	string	false	The search string.
includeBytes	query	boolean	false	Include the bytes in the response.

Example responses

200 Response

{
  "metrics": [
    {
      "id": "string",
      "component": "string",
      "ts": 0,
      "type": "string",
      "data": null,
      "tenantId": "string"
    }
  ],
  "cursor": "string",
  "bytes": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for getting organization activity logs.	ActivityLogs
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

SimpleEvents

Record events for an item, events could be status updates, EPCIS events, location events etc . The events will be stored immutably.

Features

• Create/update events associated with an item
• Hash the events and create an immutable record for them
• Retrieve timeline of current events

Extensions

• JSON-LD read endpoint

Use Cases

• Record documents requests, location changes etc for a consignment

Get Event By Id

Code samples

GET /simple-event-repository/events/{id} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /simple-event-repository/events/{id} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/simple-event-repository/events/{id}',
{
  method: 'GET',

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

URL obj = new URL("/simple-event-repository/events/{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());

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

r = requests.get('/simple-event-repository/events/{id}', headers = headers)

print(r.json())

GET /simple-event-repository/events/{id}

Get Event By Id

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
eventId	query	any	false	Event Id.

Example responses

200 Response

{
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "id": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response for getting event by id.	SimpleEvent
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get Events

Code samples

GET /simple-event-repository/events HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /simple-event-repository/events \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/simple-event-repository/events',
{
  method: 'GET',

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

URL obj = new URL("/simple-event-repository/events");
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());

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

r = requests.get('/simple-event-repository/events', headers = headers)

print(r.json())

GET /simple-event-repository/events

Get Events

Parameters

Name	In	Type	Required	Description
itemId	query	string	false	Item Id.

Example responses

200 Response

[
  {
    "itemId": "string",
    "type": "string",
    "identity": "string",
    "startTime": 0,
    "endTime": 0,
    "completionStatus": "complete",
    "action": "Request",
    "customTitle": "string",
    "fail": true,
    "code": 0,
    "location": {
      "name": "string",
      "longitude": 0,
      "latitude": 0
    },
    "documentRevision": 0,
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "id": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	ListOfSimpleEvent
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Capture an event

Code samples

POST /simple-event-repository/events HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /simple-event-repository/events \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/simple-event-repository/events',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/simple-event-repository/events");
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());

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

r = requests.post('/simple-event-repository/events', headers = headers)

print(r.json())

POST /simple-event-repository/events

Capture an event

Body parameter

{
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	SimpleEventData	true	Simple Event.

Example responses

201 Response

{
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "id": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Simple Event.	SimpleEvent
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

TLIP Connector

Endpoints which are part of the TLIP Connector building block.

Webhook notification endpoint

Code samples

POST /tlip-connector/notify HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /tlip-connector/notify \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "@context": "string",
  "id": "string",
  "type": "Create",
  "generator": "string",
  "actor": {
    "id": "string",
    "name": "string",
    "type": "Organization",
    "identificationType": "string",
    "identificationId": "string"
  },
  "object": {
    "type": "Document",
    "code": 0,
    "versionId": "string",
    "issueDateTime": "string",
    "mediaType": [
      "string"
    ],
    "href": "string",
    "provider": "string",
    "issuerParty": {
      "id": "string",
      "type": [
        "string"
      ],
      "identificationType": "string",
      "identificationId": "string"
    },
    "documentBinaryData": "string"
  },
  "target": {
    "type": "Consignment",
    "globalId": "string",
    "identificationType": "string",
    "identificationId": "string",
    "customsId": "string",
    "exporterParty": {
      "exportTypecode": "string",
      "exporterParty": "string",
      "destinationCountry": "string"
    },
    "importerParty": {
      "importTypecode": "string",
      "importerParty": "string",
      "importCountry": "string"
    }
  },
  "updated": "string",
  "to": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/tlip-connector/notify',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/tlip-connector/notify");
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());

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

r = requests.post('/tlip-connector/notify', headers = headers)

print(r.json())

POST /tlip-connector/notify

Webhook notification endpoint

Body parameter

{
  "@context": "string",
  "id": "string",
  "type": "Create",
  "generator": "string",
  "actor": {
    "id": "string",
    "name": "string",
    "type": "Organization",
    "identificationType": "string",
    "identificationId": "string"
  },
  "object": {
    "type": "Document",
    "code": 0,
    "versionId": "string",
    "issueDateTime": "string",
    "mediaType": [
      "string"
    ],
    "href": "string",
    "provider": "string",
    "issuerParty": {
      "id": "string",
      "type": [
        "string"
      ],
      "identificationType": "string",
      "identificationId": "string"
    },
    "documentBinaryData": "string"
  },
  "target": {
    "type": "Consignment",
    "globalId": "string",
    "identificationType": "string",
    "identificationId": "string",
    "customsId": "string",
    "exporterParty": {
      "exportTypecode": "string",
      "exporterParty": "string",
      "destinationCountry": "string"
    },
    "importerParty": {
      "importTypecode": "string",
      "importerParty": "string",
      "importCountry": "string"
    }
  },
  "updated": "string",
  "to": {}
}

Parameters

Name	In	Type	Required	Description
body	body	ActivityStream	true	Activity Stream interface.

Example responses

202 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
202	Accepted	The rest request ended in accepted response.	AcceptedResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse
409	Conflict	The request resulted in a conflicting operation, see the error field for more details.	ConflictResponse

Get Activity Log Entry

Code samples

GET /tlip-connector/activity-logs/{logEntryId} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip-connector/activity-logs/{logEntryId} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip-connector/activity-logs/{logEntryId}',
{
  method: 'GET',

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

URL obj = new URL("/tlip-connector/activity-logs/{logEntryId}");
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());

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

r = requests.get('/tlip-connector/activity-logs/{logEntryId}', headers = headers)

print(r.json())

GET /tlip-connector/activity-logs/{logEntryId}

Get Activity Log Entry

Parameters

Name	In	Type	Required	Description
logEntryId	path	string	true	The id for the Activity Log Entry.

Example responses

200 Response

{
  "id": "string",
  "generator": "string",
  "jobData": {
    "property1": null,
    "property2": null
  },
  "status": "pending",
  "created": 0,
  "started": 0,
  "finished": 0,
  "result": null,
  "error": {
    "name": "string",
    "message": "string",
    "stack": "string"
  },
  "to": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	An Activity Log Entry to allow TLIP Connector clients to know the status of activity processing.	JobDetails
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Get Consignment Document

Code samples

GET /tlip-connector/consignment-documents HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip-connector/consignment-documents \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip-connector/consignment-documents',
{
  method: 'GET',

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

URL obj = new URL("/tlip-connector/consignment-documents");
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());

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

r = requests.get('/tlip-connector/consignment-documents', headers = headers)

print(r.json())

GET /tlip-connector/consignment-documents

Get Consignment Document

Example responses

200 Response

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "proof": {
    "type": "DataIntegrityProof",
    "cryptosuite": "string",
    "created": "string",
    "verificationMethod": "string",
    "proofPurpose": "assertionMethod",
    "proofValue": "string"
  },
  "version": 0,
  "identity": "string",
  "blobStorageId": "string",
  "fileFormat": "string",
  "dateCreated": 0,
  "contentSize": 0,
  "fingerPrint": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "matrix": {
    "property1": null,
    "property2": null
  },
  "code": 0,
  "verified": true,
  "contentUrl": "string",
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Consignment document get response.	RevisionOverviewHarmonized
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

List Activity Log Entries

Code samples

GET /tlip-connector/activity-logs HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip-connector/activity-logs \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip-connector/activity-logs',
{
  method: 'GET',

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

URL obj = new URL("/tlip-connector/activity-logs");
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());

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

r = requests.get('/tlip-connector/activity-logs', headers = headers)

print(r.json())

GET /tlip-connector/activity-logs

List Activity Log Entries

Parameters

Name	In	Type	Required	Description
status	query	any	false	Job statuses.
cursor	query	string	false	The cursor for paged requests.

Example responses

400 Response

{
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Get the details for an item.	None
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Response Schema

Get consignment as JSON-LD

Code samples

GET /tlip-connector/consignments HTTP/1.1

Accept: application/json

# You can also use wget
curl -X GET /tlip-connector/consignments \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/tlip-connector/consignments',
{
  method: 'GET',

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

URL obj = new URL("/tlip-connector/consignments");
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());

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

r = requests.get('/tlip-connector/consignments', headers = headers)

print(r.json())

GET /tlip-connector/consignments

Get consignment as JSON-LD

Example responses

200 Response

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Consignment get response.	JsonLdObject
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Platform Directory

Endpoints which are part of the platform-directory building block.

Register system

Code samples

POST /platform-directory/system HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /platform-directory/system \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "endpoint": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/platform-directory/system',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/platform-directory/system");
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());

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

r = requests.post('/platform-directory/system', headers = headers)

print(r.json())

POST /platform-directory/system

Register system

Body parameter

{
  "identity": "string",
  "endpoint": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RegisterSystemRequest	true	Register system request.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Unregister system

Code samples

DELETE /platform-directory/system/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /platform-directory/system/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/platform-directory/system/{identity}',
{
  method: 'DELETE',

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

URL obj = new URL("/platform-directory/system/{identity}");
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());

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

r = requests.delete('/platform-directory/system/{identity}', headers = headers)

print(r.json())

DELETE /platform-directory/system/{identity}

Unregister system

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity to the system to remove.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Update system

Code samples

PUT /platform-directory/system/{identity} HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT /platform-directory/system/{identity} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "endpoint": "string",
  "apiKey": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/platform-directory/system/{identity}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/platform-directory/system/{identity}");
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());

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

r = requests.put('/platform-directory/system/{identity}', headers = headers)

print(r.json())

PUT /platform-directory/system/{identity}

Update system

Body parameter

{
  "endpoint": "string",
  "apiKey": "string"
}

Parameters

Name	In	Type	Required	Description
identity	path	string	true	The identity of the system to update.
body	body	UpdateSystemRequest	true	Update system request.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse
404	Not Found	The resource you tried to access does not exist, see the error field for more details.	NotFoundResponse

Add trusted identity

Code samples

POST /platform-directory/peers HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /platform-directory/peers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "emailAddress": "string",
  "name": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/platform-directory/peers',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/platform-directory/peers");
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());

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

r = requests.post('/platform-directory/peers', headers = headers)

print(r.json())

POST /platform-directory/peers

Add trusted identity

Body parameter

{
  "identity": "string",
  "emailAddress": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AddTrustedIdentityRequest	true	Add trusted identity request.

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Remove a peer

Code samples

DELETE /platform-directory/peers/{identity} HTTP/1.1

Accept: application/json

# You can also use wget
curl -X DELETE /platform-directory/peers/{identity} \
  -H 'Accept: application/json'

const fetch = require('node-fetch');

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

fetch('/platform-directory/peers/{identity}',
{
  method: 'DELETE',

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

URL obj = new URL("/platform-directory/peers/{identity}");
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());

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

r = requests.delete('/platform-directory/peers/{identity}', headers = headers)

print(r.json())

DELETE /platform-directory/peers/{identity}

Remove a peer

Parameters

Name	In	Type	Required	Description
identity	path	string	true	none

Example responses

204 Response

{}

Responses

Status	Meaning	Description	Schema
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Process access

Code samples

POST /platform-directory/process-access HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /platform-directory/process-access \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string",
  "emailAddress": "string",
  "name": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/platform-directory/process-access',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/platform-directory/process-access");
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());

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

r = requests.post('/platform-directory/process-access', headers = headers)

print(r.json())

POST /platform-directory/process-access

Process access

Body parameter

{
  "identity": "string",
  "emailAddress": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ProcessAccessRequest	true	Process access request.

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in success with no data.	SuccessResponse
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Request access

Code samples

POST /platform-directory/request-access HTTP/1.1

Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST /platform-directory/request-access \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const fetch = require('node-fetch');
const inputBody = {
  "identity": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/platform-directory/request-access',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

URL obj = new URL("/platform-directory/request-access");
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());

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

r = requests.post('/platform-directory/request-access', headers = headers)

print(r.json())

POST /platform-directory/request-access

Request access

Body parameter

{
  "identity": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	AccessRequest	true	Access request.

Example responses

200 Response

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The rest request ended in created response.	CreatedResponse
204	No Content	The rest request ended in success with no data.	NoContentResponse
400	Bad Request	Something went wrong with the request see the error field for more details.	BadRequestResponse
401	Unauthorized	You are not authorized to use the API or no credentials were supplied.	UnauthorizedResponse

Schemas

SuccessResponse

{}

The rest request ended in success with no data.

Properties

None

CreatedResponse

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

The rest request ended in created response.

Properties

Name	Type	Required	Restrictions	Description
statusCode	number	true	none	Alternative response status code.
headers	object	true	none	Additional response headers.
» location	string	true	none	The location where the resource was created.

AcceptedResponse

{
  "statusCode": 0,
  "headers": {
    "location": "string"
  }
}

The rest request ended in accepted response.

Properties

Name	Type	Required	Restrictions	Description
statusCode	number	true	none	Alternative response status code.
headers	object	true	none	Additional response headers.
» location	string	true	none	The location where the resource was accepted.

NoContentResponse

{}

The rest request ended in success with no data.

Properties

None

BadRequestResponse

{
  "error": "string"
}

Something went wrong with the request see the error field for more details.

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	A message for the response.

UnauthorizedResponse

{
  "error": "string"
}

You are not authorized to use the API or no credentials were supplied.

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	A message for the response.

NotFoundResponse

{
  "error": "string",
  "notFoundId": "string"
}

The resource you tried to access does not exist, see the error field for more details.

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	A message for the response.
notFoundId	string	false	none	The id if the item that was not found.

ConflictResponse

{
  "error": "string",
  "conflicts": [
    "string"
  ]
}

The request resulted in a conflicting operation, see the error field for more details.

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	A message for the response.
conflicts	[string]	true	none	The conflicting items.

UnprocessableEntityResponse

{
  "error": "string",
  "existingId": "string"
}

The operation could not be processed, see the error field for more details.

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	A message for the response.
existingId	string	false	none	The id which caused the unprocessable entity response.

ServiceUnavailableResponse

{
  "error": "string"
}

The service you requested it currently unavailable, see the error field for more details.

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	A message for the response.

ItemListResponse

{
  "items": [
    {
      "id": "string",
      "created": 0,
      "updated": 0,
      "blobUrn": "string",
      "creator": "string",
      "tenantId": "string"
    }
  ],
  "cursor": "string",
  "pageSize": 0,
  "totalItems": 0
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[ItemOverview]	true	none	The list of items.
cursor	string	false	none	Cursor for a multi page request.
pageSize	number	false	none	Maximum mumber of items to return per page.
totalItems	number	true	none	The length of the total items.

ItemOverview

{
  "id": "string",
  "created": 0,
  "updated": 0,
  "blobUrn": "string",
  "creator": "string",
  "tenantId": "string"
}

Interface representing an item.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	A unique identifier for the item.
created	number	true	none	Timestamp of when the item was created.
updated	number	true	none	Timestamp of when the item was last updated.
blobUrn	string	false	none	The urn to use to retrieve the blob.
creator	string	false	none	A identity of the creator.
tenantId	string	false	none	The tenant Id.

ItemCreateRequest

{
  "itemId": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
}

The data to be used in the create.

Properties

Name	Type	Required	Restrictions	Description
itemId	string	true	none	The primary id for the item.
properties	[Property]	false	none	Additional properties for the item.
aliasIds	[AliasId]	false	none	Alias Ids for the item.

Property

{
  "key": "string",
  "type": "string",
  "value": null
}

Interface describing a property.

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	The key for the item.
type	string	true	none	The type for the item as a urn.
value	any	true	none	The value for the item.

AliasId

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Interface describing a alias.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id for the alias.
properties	[Property]	false	none	List of additional properties for the alias.

Item

{
  "id": "string",
  "created": 0,
  "updated": 0,
  "blobUrn": "string",
  "creator": "string",
  "tenantId": "string",
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "resources": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "relationships": [
    {
      "id": "string",
      "type": "child",
      "start": 0,
      "end": 0,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "permissions": [
    {
      "identity": "string",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ]
}

Interface representing an item.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	A unique identifier for the item.
created	number	true	none	Timestamp of when the item was created.
updated	number	true	none	Timestamp of when the item was last updated.
blobUrn	string	false	none	The urn to use to retrieve the blob.
creator	string	false	none	A identity of the creator.
tenantId	string	false	none	The tenant Id.
aliasIds	[AliasId]	false	none	Alias identifiers for the item.
properties	[Property]	false	none	List of additional properties for the item.
resources	[Resource]	false	none	A list of resources associated with the item.
relationships	[Relationship]	false	none	A list of relationships for the item.
permissions	[Permission]	false	none	The permissions for the item.

Resource

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Interface describing a resource.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id for the resource.
properties	[Property]	false	none	List of additional properties for the resource.

Relationship

{
  "id": "string",
  "type": "child",
  "start": 0,
  "end": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Interface describing a relationship.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	A unique identifier for the item being related to.
type	RelationshipType	true	none	Types for the relationships.
start	number	true	none	A timestamp for when the relationship was made.
end	number	false	none	A timestamp for when the relationship was removed, empty if still related.
properties	[Property]	false	none	List of additional properties for the relationship.

RelationshipType

"child"

Types for the relationships.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Types for the relationships.

Enumerated Values

Property	Value
anonymous	child
anonymous	parent
anonymous	inherits

Permission

{
  "identity": "string",
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
}

Interface for Permission.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity to grant permission to.
properties	[PermissionProperty]	true	none	The properties of the permission.

PermissionProperty

{
  "type": "string",
  "value": null,
  "ttl": 0
}

Permission property interface.

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	The type of the property.
value	any	true	none	The value of the property.
ttl	number	false	none	The ttl of the property.

ItemUpdatePermissionRequest

{
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
}

The data to be used to create the permission.

Properties

Name	Type	Required	Restrictions	Description
properties	[PermissionProperty]	true	none	The permission properties.

ItemHistoryResponse

{
  "items": [
    {
      "id": "string",
      "created": 0,
      "updated": 0,
      "blobUrn": "string",
      "creator": "string",
      "tenantId": "string",
      "aliasIds": [
        {
          "id": "string",
          "properties": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ]
        }
      ],
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "resources": [
        {
          "id": "string",
          "properties": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ]
        }
      ],
      "relationships": [
        {
          "id": "string",
          "type": "child",
          "start": 0,
          "end": 0,
          "properties": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ]
        }
      ],
      "permissions": [
        {
          "identity": "string",
          "properties": [
            {
              "type": "string",
              "value": null,
              "ttl": 0
            }
          ]
        }
      ]
    }
  ],
  "totalItems": 0,
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[Item]	true	none	The items in the history.
totalItems	number	true	none	The total number of items in the history.
cursor	string	false	none	Cursor to use to get next chunk.

ItemUpdateRequest

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
}

The data to be used in the update.

Properties

Name	Type	Required	Restrictions	Description
properties	[Property]	false	none	Additional properties for the item.
aliasIds	[AliasId]	false	none	Updated aliases for the item.

ResourceGetResponse

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id for the resource.
properties	[Property]	false	none	List of additional properties values for the resource.

AliasIdUpdateRequest

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data to be used in the update.

Properties

Name	Type	Required	Restrictions	Description
properties	[Property]	false	none	List of additional properties for the alias id.

AliasIdMergeRequest

{
  "aliasIds": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ]
}

The data to be used in the update.

Properties

Name	Type	Required	Restrictions	Description
aliasIds	[AliasId]	false	none	List of alias ids to merge.

ResourceListResponse

[
  {
    "id": "string",
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ]
  }
]

The item resources.

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Resource]	false	none	The item resources.

ResourceAddRequest

{
  "id": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data to be used in the add.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The resource id.
properties	[Property]	false	none	The resource properties.

ResourceUpdateRequest

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data to be used in the update.

Properties

Name	Type	Required	Restrictions	Description
properties	[Property]	false	none	The resource properties.

RelationshipUpdateRequest

{
  "start": 0,
  "end": 0,
  "type": "child",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data to be used in the update.

Properties

Name	Type	Required	Restrictions	Description
start	number	true	none	The relationship start timestamp.
end	number	false	none	The relationship end timestamp.
type	RelationshipType	true	none	Types for the relationships.
properties	[Property]	false	none	List of additional properties for the relationship.

RelationshipListResponse

[
  {
    "id": "string",
    "type": "child",
    "start": 0,
    "end": 0,
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ]
  }
]

The item relationships.

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Relationship]	false	none	The item relationships.

BlobAddRequest

{
  "blobId": "string",
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data to be used in the add.

Properties

Name	Type	Required	Restrictions	Description
blobId	string	true	none	The blob id.
blob	string	true	none	The data encoded as base64.
properties	[Property]	false	none	The resource properties.

BlobAddResponse

[
  {
    "key": "string",
    "type": "string",
    "value": null
  }
]

The updated properties.

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Property]	false	none	The updated properties.

BlobUpdateRequest

{
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data to be used in the add.

Properties

Name	Type	Required	Restrictions	Description
blob	string	false	none	The data encoded as base64.
properties	[Property]	false	none	The resource properties.

BlobUpdateResponse

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "revisions": [
    {
      "storageId": "string",
      "fingerPrint": "string",
      "ts": 0,
      "blobSize": 0,
      "mimeType": "string",
      "reason": "string"
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
properties	[Property]	false	none	The updated properties.
revisions	[BlobRevision]	false	none	List of additional revisions values for the blob.

BlobRevision

{
  "storageId": "string",
  "fingerPrint": "string",
  "ts": 0,
  "blobSize": 0,
  "mimeType": "string",
  "reason": "string"
}

Interface describing a blob revision.

Properties

Name	Type	Required	Restrictions	Description
storageId	string	true	none	The storage id for the item.
fingerPrint	string	true	none	The finger print for the item.
ts	number	true	none	The timestamp for the item.
blobSize	number	true	none	The size for the item.
mimeType	string	true	none	The mime type for the item.
reason	string	false	none	The reason the document was updated.

BlobGetResponse

{
  "blob": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "revisions": [
    {
      "storageId": "string",
      "fingerPrint": "string",
      "ts": 0,
      "blobSize": 0,
      "mimeType": "string",
      "reason": "string"
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
blob	string	true	none	The base64 data for the blob.
properties	[Property]	false	none	List of additional properties values for the blob.
revisions	[BlobRevision]	false	none	List of additional revisions values for the blob.

BlobUrlResponse

{
  "url": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
url	string	true	none	The url to view the blob.

JsonLdObject

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "property1": null,
  "property2": null
}

JSON-LD document.

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	none
@context	LdContext	true	none	JSON-LD @context.
type	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
id	string	true	none	none

LdContext

"string"

JSON-LD @context.

Properties

anyOf

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
anonymous	[anyOf]	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» additionalProperties	any	false	none	none

LogEntry

{
  "level": "info",
  "source": "string",
  "ts": 0,
  "message": "string",
  "error": null,
  "data": null
}

Interface describing a log entry.

Properties

Name	Type	Required	Restrictions	Description
level	LogLevel	true	none	Log level.
source	string	true	none	The source of the log entry.
ts	number	true	none	The timestamp of the log entry.
message	string	true	none	The message.
error	any	false	none	Optional error details.
data	any	false	none	Optional data for the message.

LogLevel

"info"

Log level.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Log level.

Enumerated Values

Property	Value
anonymous	info
anonymous	warn
anonymous	error

LoggerListResponse

{
  "entries": [
    {
      "level": "info",
      "source": "string",
      "ts": 0,
      "message": "string",
      "error": null,
      "data": null
    }
  ],
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
entries	[LogEntry]	true	none	The log entries.
cursor	string	false	none	The cursor for the next chunk.

IndexingAliasCreateRequest

{
  "primaryUrn": "string",
  "aliasUrn": "string"
}

The data to be used in the create.

Properties

Name	Type	Required	Restrictions	Description
primaryUrn	string	true	none	The primary urn to alias.
aliasUrn	string	true	none	The alias urn to assign to the primary urn.

IndexingAliasRemoveRequest

{
  "primaryUrn": "string",
  "aliasUrn": "string"
}

The data to be used in the removal.

Properties

Name	Type	Required	Restrictions	Description
primaryUrn	string	true	none	The primary urn for which to remove the alias.
aliasUrn	string	true	none	The alias urn to disassociate with the primary urn.

IndexingAliasGetResponse

{
  "indexes": [
    "string"
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
indexes	[string]	true	none	The indexes the alias points to.

CounterCreateRequest

{
  "value": 0
}

The data to be used in the create.

Properties

Name	Type	Required	Restrictions	Description
value	number	true	none	The value.

CounterCreateResponse

{
  "id": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the counter created.

CounterUpdateRequest

{
  "amount": 0
}

The data to be used in the update.

Properties

Name	Type	Required	Restrictions	Description
amount	number	true	none	The amount to update the value.

CounterGetResponse

{
  "value": 0
}

The data for the response.

Properties

Name	Type	Required	Restrictions	Description
value	number	true	none	The value of the counter.

Location

{
  "id": "string",
  "site": "string",
  "sst": "201",
  "ssa": "401",
  "ssd": "string",
  "name": "string",
  "streetAddressOne": "string",
  "streetAddressTwo": "string",
  "streetAddressThree": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "string",
  "latitude": 0,
  "longitude": 0
}

Interface describing a GS1 Location master data. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.2 .

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The GS1 sgln identifier.
site	string	false	none	Identifies the site in which the location is contained.
sst	SubSiteTypes	false	none	Sub Site Identifier Types. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.3.1 .
ssa	SubSiteAttributes	false	none	Sub Site Attributes. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.3.2 .
ssd	string	false	none	Sub site detail provides additional proprietary information.
name	string	false	none	The name of the location.
streetAddressOne	string	false	none	The street address line 1.
streetAddressTwo	string	false	none	The street address line 2.
streetAddressThree	string	false	none	The street address line 3.
city	string	false	none	City.
state	string	false	none	State.
postalCode	string	false	none	Postal Code.
countryCode	string	false	none	Country Code The ISO 3166-1 alpha-2 code specifying the country for the address.
latitude	number	false	none	The latitude of the location in degrees.
longitude	number	false	none	The longitude of the location in degrees.

SubSiteTypes

"201"

Sub Site Identifier Types. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.3.1 .

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Sub Site Identifier Types. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.3.1 .

Enumerated Values

Property	Value
anonymous	201
anonymous	202
anonymous	203
anonymous	207
anonymous	208
anonymous	209
anonymous	210
anonymous	211
anonymous	212
anonymous	213
anonymous	214
anonymous	215
anonymous	251
anonymous	252
anonymous	253
anonymous	299

SubSiteAttributes

"401"

Sub Site Attributes. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.3.2 .

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Sub Site Attributes. Spec https://www.gs1.org/sites/default/files/docs/epc/CBV-Standard-1-2-1-r-2017-05-05.pdf . Section 10.3.2 .

Enumerated Values

Property	Value
anonymous	401
anonymous	402
anonymous	403
anonymous	404
anonymous	405
anonymous	406
anonymous	407
anonymous	408
anonymous	409
anonymous	411
anonymous	412
anonymous	413
anonymous	414
anonymous	415
anonymous	416
anonymous	417
anonymous	418
anonymous	419
anonymous	420
anonymous	421
anonymous	422
anonymous	423
anonymous	424
anonymous	425
anonymous	426
anonymous	427
anonymous	428
anonymous	429
anonymous	431
anonymous	432
anonymous	433
anonymous	434

CatalogLocationFindResponse

{
  "items": [
    {
      "id": "string",
      "site": "string",
      "sst": "201",
      "ssa": "401",
      "ssd": "string",
      "name": "string",
      "streetAddressOne": "string",
      "streetAddressTwo": "string",
      "streetAddressThree": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[Location]	true	none	The list of items.
cursor	string	false	none	Cursor for a multi page request.

MetricsCreateRequest

{
  "component": "string",
  "ts": 0,
  "type": "string",
  "data": null,
  "tenantId": "string"
}

The data to be used in the create.

Properties

Name	Type	Required	Restrictions	Description
component	string	true	none	The component reporting its metrics.
ts	number	true	none	The timestamp for the report.
type	string	true	none	The type for the metric.
data	any	false	none	The data for the metric.
tenantId	string	false	none	Optional tenantId when included.

MetricsGetResponse

{
  "metrics": [
    {
      "id": "string",
      "component": "string",
      "ts": 0,
      "type": "string",
      "data": null,
      "tenantId": "string"
    }
  ],
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
metrics	[ComponentMetric]	true	none	The metrics.
cursor	string	false	none	Cursor for paged lookups.

ComponentMetric

{
  "id": "string",
  "component": "string",
  "ts": 0,
  "type": "string",
  "data": null,
  "tenantId": "string"
}

Details of a metric for a component.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	Unique id for the entry.
component	string	true	none	The component reporting its metrics.
ts	number	true	none	The timestamp for the report.
type	string	true	none	The type for the metric.
data	any	false	none	The data for the metric.
tenantId	string	false	none	Optional tenantId when included.

LoginCreateRequest

{
  "name": "string",
  "emailAddress": "string",
  "password": "string",
  "role": "organization",
  "verifyEmail": true,
  "organizationId": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
emailAddress	string	true	none	The email address to create the login with.
password	string	true	none	The password to create login with.
role	IdentityRole	true	none	The roles that an identity can have.
verifyEmail	boolean	true	none	Whether to send email verification or not.
organizationId	string	false	none	The identity of the organization.

IdentityRole

"organization"

The roles that an identity can have.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The roles that an identity can have.

Enumerated Values

Property	Value
anonymous	organization
anonymous	user
anonymous	system
anonymous	borderAgent

LoginCreateResponse

{
  "recoveryPhrase": "string",
  "identity": "string",
  "publicKey": "string",
  "privateKey": "string",
  "token": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
recoveryPhrase	string	true	none	The recovery phrase used to regenerate the identity.
identity	string	true	none	The identity.
publicKey	string	true	none	The public key for the identity.
privateKey	string	true	none	The private key for the identity.
token	string	false	none	The auth token for future requests.

LoginVerifySendRequest

{
  "identity": "string",
  "verificationType": "email"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity verify the login with.
verificationType	VerificationType	true	none	The verification types.

VerificationType

"email"

The verification types.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The verification types.

Enumerated Values

Property	Value
anonymous	email
anonymous	not-used

LoginVerifyCheckRequest

{
  "identity": "string",
  "verificationType": "email"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity verify the login with.
verificationType	VerificationType	true	none	The verification types.

LoginVerifyCheckResponse

{
  "verified": true
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
verified	boolean	true	none	The verification is complete.

LoginRequest

{
  "emailAddress": "string",
  "passwordHash": "string",
  "pin": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The email address to login with.
passwordHash	string	true	none	The hash of the password to login with.
pin	string	false	none	The two factor authentication pin if required.

LoginResponse

{
  "identity": "string",
  "twoFactorRequired": true,
  "twoFactorEnabled": true,
  "verifiedEmail": true,
  "token": "string",
  "accessGroups": [
    {
      "name": "string",
      "accessRights": [
        {
          "type": "READ",
          "properties": [
            {
              "type": "string",
              "value": null,
              "ttl": 0
            }
          ]
        }
      ],
      "identities": [
        "string"
      ]
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
identity	string	false	none	The identity associated with the login.
twoFactorRequired	boolean	false	none	Is the two factor authentication required.
twoFactorEnabled	boolean	false	none	Is the two factor authentication enabled.
verifiedEmail	boolean	false	none	Is this email address verified.
token	string	false	none	The auth token to use in future requests.
accessGroups	[AccessGroup]	false	none	List of access groups the user belongs to.

AccessGroup

{
  "name": "string",
  "accessRights": [
    {
      "type": "READ",
      "properties": [
        {
          "type": "string",
          "value": null,
          "ttl": 0
        }
      ]
    }
  ],
  "identities": [
    "string"
  ]
}

Interface for Access group.

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the access group.
accessRights	[AccessRight]	true	none	List of access accessRight.
identities	[string]	false	none	Identities of profiles in the group.

AccessRight

{
  "type": "READ",
  "properties": [
    {
      "type": "string",
      "value": null,
      "ttl": 0
    }
  ]
}

Interface for IAccessRight.

Properties

Name	Type	Required	Restrictions	Description
type	PermissionType	true	none	Permission type enum.
properties	[PermissionProperty]	true	none	The properties of the accessRight.

PermissionType

"READ"

Permission type enum.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Permission type enum.

Enumerated Values

Property	Value
anonymous	READ
anonymous	WRITE
anonymous	SHARE

LoginRefreshRequest

{
  "identity": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity being refreshed.

LoginRefreshResponse

{
  "identity": "string",
  "twoFactorEnabled": true,
  "verifiedEmail": true,
  "token": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity associated with the login.
twoFactorEnabled	boolean	true	none	Is the two factor authentication enabled.
verifiedEmail	boolean	true	none	Is this email address verified.
token	string	true	none	The auth token to use in future requests.

LogoutRequest

{
  "identity": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity to logout.

LoginTwoFactorCreateRequest

{
  "identity": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity to create the two factor authentication for.

LoginTwoFactorCreateResponse

{
  "twoFactorSecret": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
twoFactorSecret	string	true	none	The two factor authentication secret.

LoginTwoFactorToggleRequest

{
  "identity": "string",
  "enableDisable": true,
  "pin": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity of the login.
enableDisable	boolean	true	none	Enable or disable the two factor authentication for the login.
pin	string	true	none	The pin for the two factor authentication.

ProfileUpdateRequest

{
  "identity": "string",
  "emailAddress": "string",
  "taxPin": "string",
  "name": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity of the login.
emailAddress	string	true	none	The new email address.
taxPin	string	true	none	The tax pin.
name	string	false	none	The profile name.
properties	[Property]	false	none	Other optional fields.

TokenCreateRequest

{
  "identity": "string",
  "name": "string",
  "ttl": 0
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity to create the token for.
name	string	true	none	The name of the token.
ttl	number	false	none	The ttl for the token, or empty for no expiry.

TokenCreateResponse

{
  "id": "string",
  "created": 0,
  "token": "string",
  "expires": 0
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the created token.
created	number	true	none	The time the token was created.
token	string	true	none	The token to use in requests.
expires	number	false	none	The expiry time in milli-seconds since epoch if a ttl was requested.

TokenListResponse

{
  "tokens": [
    {
      "id": "string",
      "created": 0,
      "name": "string",
      "expires": 0
    }
  ],
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
tokens	[object]	true	none	The tokens.
» id	string	true	none	none
» created	number	true	none	none
» name	string	true	none	none
» expires	number	false	none	none
cursor	string	false	none	The cursor for paged requests.

UserInviteRequest

{
  "emailAddress": [
    "string"
  ]
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	[string]	true	none	The email addresses to send invite to.

AuthorityInviteRequest

{
  "emailAddress": "string",
  "name": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The email address to send invite to.
name	string	true	none	The name of the authority.

ListOrganizationUsersResponse

{
  "nextPageCursor": "string",
  "pendingInvites": [
    {
      "email": "string",
      "status": "string",
      "timeToExpiry": 0
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
nextPageCursor	string	false	none	The cursor for paged requests.
pendingInvites	[object]	true	none	The organization users.
» email	string	true	none	The user email.
» status	string	true	none	The user name.
» timeToExpiry	number	false	none	Time to expiry.

TokenDecodeRequest

{
  "token": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
token	string	true	none	The token to decode.

JwtToken

{
  "sub": "string",
  "tenantId": "string",
  "iat": 0,
  "exp": 0,
  "tokenId": "string"
}

The token returned for JWT.

Properties

Name	Type	Required	Restrictions	Description
sub	string	true	none	The subject ie the identity who is logged in.
tenantId	string	false	none	The tenant that issued the token.
iat	number	true	none	The time which the token was generated in seconds since 1970.
exp	number	false	none	The time which the token expires in seconds since 1970.
tokenId	string	false	none	Id of a manually generation auth token to lookup for existence.

PasswordResetEmailRequest

{
  "emailAddress": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The account email address.

ResetPasswordRequest

{
  "emailAddress": "string",
  "password": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The email address representing the account.
password	string	true	none	The new account password.

ApiKeyResponse

{
  "apiKey": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
apiKey	string	true	none	The api key.

ToggleProfileRequest

{
  "active": true
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
active	boolean	true	none	Activate/deactivate.

TwoFactorRecoveryRequest

{
  "emailAddress": "string",
  "recoveryCode": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The new email address.
recoveryCode	string	true	none	The recovery code.

UnlockAuthAccountRequest

{
  "emailAddress": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The email address for the account to unlock.

IdentityCreateRequest

{
  "role": "organization",
  "emailAddress": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
role	IdentityRole	true	none	The roles that an identity can have.
emailAddress	string	true	none	The Email address.
properties	[Property]	false	none	Optional fields.

IdentityCreateResponse

{
  "identity": "string",
  "recoveryPhrase": "string",
  "privateKey": "string",
  "publicKey": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity created.
recoveryPhrase	string	true	none	Recovery phrase mnemonic.
privateKey	string	true	none	Private key.
publicKey	string	true	none	Public key.

IdentityUpdateRequest

{
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
properties	[Property]	false	none	Optional fields.

ProfileSetRequest

{
  "emailAddress": "string",
  "taxPin": "string",
  "imageBase64": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
emailAddress	string	true	none	The email address for the identity.
taxPin	string	false	none	The tax pin for the identity.
imageBase64	string	false	none	The image to update the profile with.
properties	[Property]	false	none	Additional properties for the profile.

ProfileGetResponse

{
  "role": "organization",
  "emailAddress": "string",
  "name": "string",
  "imageBase64": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
role	IdentityRole	true	none	The roles that an identity can have.
emailAddress	string	true	none	The email address for the identity.
name	string	false	none	The name in the profile.
imageBase64	string	false	none	The image in the profile.
properties	[Property]	false	none	Additional properties for the profile.

OrganizationsGetResponse

{
  "cursor": "string",
  "organizations": [
    {
      "identity": "string",
      "name": "string"
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
cursor	string	false	none	The cursor for paged requests.
organizations	[object]	true	none	The organizations.
» identity	string	true	none	none
» name	string	true	none	none

OrganizationGetResponse

{
  "name": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the organization.

VerifiableCredentialRequirementsSetRequest

{
  "matchDomains": "string",
  "requiredClaims": [
    {
      "key": "string",
      "type": "string",
      "isPublic": true
    }
  ]
}

The request payload.

Properties

Name	Type	Required	Restrictions	Description
matchDomains	string	false	none	Verifiable credential applicants must match the users email domain.
requiredClaims	[IdentityClaimRequirement]	false	none	The requisites needed to apply for a verifiable credential.

IdentityClaimRequirement

{
  "key": "string",
  "type": "string",
  "isPublic": true
}

Definitions for verifiable credential claim requirement.

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	The property key for the verifiable credential claim requirement.
type	string	true	none	The data type for the verifiable credential claim requirement.
isPublic	boolean	true	none	Should this property be available in public presentation of the claims.

VerifiableCredentialRequirementsGetResponse

{
  "matchDomains": "string",
  "requiredClaims": [
    {
      "key": "string",
      "type": "string",
      "isPublic": true
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
matchDomains	string	false	none	Verifiable credential applications must match the users email domain.
requiredClaims	[IdentityClaimRequirement]	false	none	The requisites needed to apply for a verifiable credential.

VerifiableCredentialCreateRequest

{
  "issuer": "string",
  "subject": "string",
  "verifiableCredentialType": "string",
  "claims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
issuer	string	true	none	The entity they want to create the verifiable credential with.
subject	string	true	none	The identity of the verifiable credential being created.
verifiableCredentialType	string	true	none	The type of verifiable credential requirements being requested.
claims	[Property]	false	none	The completed claims providing information to the verifiable credential.

VerifiableCredentialCreateResponse

{
  "id": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The identifier for the verifiable credential.

VerifiableCredentialState

"pendingVerification"

The state of a verifiable credential.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The state of a verifiable credential.

Enumerated Values

Property	Value
anonymous	pendingVerification
anonymous	rejected
anonymous	issued
anonymous	revoked

VerifiableCredentialApplicationsGetResponse

{
  "cursor": "string",
  "applications": [
    {
      "id": "string",
      "issuer": "string",
      "subject": "string",
      "state": "pendingVerification",
      "created": 0,
      "updated": 0,
      "verifiableCredentialType": "string",
      "privateClaims": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "publicClaims": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "verifiableCredential": {
        "@context": "string",
        "id": "string",
        "type": [
          "string"
        ],
        "credentialSubject": null,
        "credentialStatus": {
          "id": "string",
          "type": "string",
          "property1": null,
          "property2": null
        },
        "issuer": "string",
        "issuanceDate": "string",
        "proof": {
          "type": "string",
          "verificationMethod": "string",
          "signatureValue": "string"
        }
      },
      "rejectedCode": "string"
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
cursor	string	false	none	The cursor for paged requests.
applications	[IdentityVerifiableCredentialApplication]	true	none	The verifiable credential applications.

IdentityVerifiableCredentialApplication

{
  "id": "string",
  "issuer": "string",
  "subject": "string",
  "state": "pendingVerification",
  "created": 0,
  "updated": 0,
  "verifiableCredentialType": "string",
  "privateClaims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "publicClaims": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "verifiableCredential": {
    "@context": "string",
    "id": "string",
    "type": [
      "string"
    ],
    "credentialSubject": null,
    "credentialStatus": {
      "id": "string",
      "type": "string",
      "property1": null,
      "property2": null
    },
    "issuer": "string",
    "issuanceDate": "string",
    "proof": {
      "type": "string",
      "verificationMethod": "string",
      "signatureValue": "string"
    }
  },
  "rejectedCode": "string"
}

Interface representing the state of an verifiable credential application.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the verifiable credential application.
issuer	string	true	none	The identity that is issuing the verifiable credential.
subject	string	true	none	The identity that is the target of the verifiable credential.
state	VerifiableCredentialState	true	none	The state of a verifiable credential.
created	number	true	none	The timestamp when the verifiable credential application was created.
updated	number	true	none	The timestamp when the verifiable credential application was updated.
verifiableCredentialType	string	true	none	The type of verifiable credential being requested.
privateClaims	[Property]	false	none	Properties supplied for the verifiable credential claims that are private.
publicClaims	[Property]	false	none	Properties supplied for the verifiable credential claims that can be public.
verifiableCredential	DidVerifiableCredential	false	none	Interface describing a verifiable credential.
rejectedCode	string	false	none	The code for why the verifiable credential application was rejected.

DidVerifiableCredential

{
  "@context": "string",
  "id": "string",
  "type": [
    "string"
  ],
  "credentialSubject": null,
  "credentialStatus": {
    "id": "string",
    "type": "string",
    "property1": null,
    "property2": null
  },
  "issuer": "string",
  "issuanceDate": "string",
  "proof": {
    "type": "string",
    "verificationMethod": "string",
    "signatureValue": "string"
  }
}

Interface describing a verifiable credential.

Properties

Name	Type	Required	Restrictions	Description
@context	any	true	none	The context for the verifiable credential.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
id	string	true	none	The identifier for the verifiable credential.
type	[string]	true	none	The types of the data stored in the verifiable credential.
credentialSubject	any	true	none	The data for the verifiable credential.
credentialStatus	DidCredentialStatus	false	none	Interface describing a DID credential status.
issuer	string	true	none	The issuing identity.
issuanceDate	string	true	none	The date the verifiable credential was issued.
proof	DidProof	false	none	Interface describing a DID Proof.

DidCredentialStatus

{
  "id": "string",
  "type": "string",
  "property1": null,
  "property2": null
}

Interface describing a DID credential status.

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	Additional properties.
id	string	true	none	The URI id.
type	string	true	none	The credential status type.

DidProof

{
  "type": "string",
  "verificationMethod": "string",
  "signatureValue": "string"
}

Interface describing a DID Proof.

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	The type of the proof.
verificationMethod	string	true	none	The verification method for the proof.
signatureValue	string	true	none	The signature for the proof.

VerifiableCredentialUpdateRequest

{
  "state": "pendingVerification",
  "rejectedCode": "string"
}

The request payload.

Properties

Name	Type	Required	Restrictions	Description
state	VerifiableCredentialState	true	none	The state of a verifiable credential.
rejectedCode	string	false	none	The reason for the rejection if that is the new state.

DidCredentialVerification

{
  "isVerified": true,
  "issuer": {
    "id": "string",
    "isVerified": true,
    "document": {
      "id": "string",
      "alsoKnownAs": "string",
      "controller": "string",
      "verificationMethod": [
        "string"
      ],
      "authentication": [
        "string"
      ],
      "assertionMethod": [
        "string"
      ],
      "keyAgreement": [
        "string"
      ],
      "capabilityInvocation": [
        "string"
      ],
      "capabilityDelegation": [
        "string"
      ],
      "service": [
        {
          "id": "string",
          "type": "string",
          "serviceEndpoint": "string"
        }
      ]
    }
  },
  "subjects": [
    {
      "id": "string",
      "isVerified": true,
      "document": {
        "id": "string",
        "alsoKnownAs": "string",
        "controller": "string",
        "verificationMethod": [
          "string"
        ],
        "authentication": [
          "string"
        ],
        "assertionMethod": [
          "string"
        ],
        "keyAgreement": [
          "string"
        ],
        "capabilityInvocation": [
          "string"
        ],
        "capabilityDelegation": [
          "string"
        ],
        "service": [
          {
            "id": "string",
            "type": "string",
            "serviceEndpoint": "string"
          }
        ]
      }
    }
  ]
}

Interface describing the result of checking verifiable credential.

Properties

Name	Type	Required	Restrictions	Description
isVerified	boolean	true	none	Is the whole credential verified.
issuer	object	false	none	Who was the issuer.
» id	string	true	none	The id of the issuer.
» isVerified	boolean	true	none	Is the issuer verified.
» document	DidDocument	false	none	Interface describing a DID Document. Spec https://www.w3.org/TR/did-core/#did-document-properties.
subjects	[object]	false	none	The subjects of the verifications.
» id	string	true	none	The if od the subject.
» isVerified	boolean	true	none	Is the subject verified.
» document	DidDocument	false	none	Interface describing a DID Document. Spec https://www.w3.org/TR/did-core/#did-document-properties.

DidDocument

{
  "id": "string",
  "alsoKnownAs": "string",
  "controller": "string",
  "verificationMethod": [
    "string"
  ],
  "authentication": [
    "string"
  ],
  "assertionMethod": [
    "string"
  ],
  "keyAgreement": [
    "string"
  ],
  "capabilityInvocation": [
    "string"
  ],
  "capabilityDelegation": [
    "string"
  ],
  "service": [
    {
      "id": "string",
      "type": "string",
      "serviceEndpoint": "string"
    }
  ]
}

Interface describing a DID Document. Spec https://www.w3.org/TR/did-core/#did-document-properties.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id for the document.
alsoKnownAs	any	false	none	Aliases for the document.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
controller	any	false	none	The controller for the document.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
verificationMethod	[anyOf]	false	none	The verification methods.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	DidDocumentVerificationMethod	false	none	Interface describing a DID document verification method.

continued

Name	Type	Required	Restrictions	Description
authentication	[anyOf]	false	none	The authentication methods.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	DidDocumentVerificationMethod	false	none	Interface describing a DID document verification method.

continued

Name	Type	Required	Restrictions	Description
assertionMethod	[anyOf]	false	none	The assertion methods.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	DidDocumentVerificationMethod	false	none	Interface describing a DID document verification method.

continued

Name	Type	Required	Restrictions	Description
keyAgreement	[anyOf]	false	none	The key agreements.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	DidDocumentVerificationMethod	false	none	Interface describing a DID document verification method.

continued

Name	Type	Required	Restrictions	Description
capabilityInvocation	[anyOf]	false	none	The capability invocations.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	DidDocumentVerificationMethod	false	none	Interface describing a DID document verification method.

continued

Name	Type	Required	Restrictions	Description
capabilityDelegation	[anyOf]	false	none	The capability delegations.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	DidDocumentVerificationMethod	false	none	Interface describing a DID document verification method.

continued

Name	Type	Required	Restrictions	Description
service	[DidService]	false	none	The services.

DidDocumentVerificationMethod

{
  "id": "string",
  "controller": "string",
  "type": "string",
  "publicKeyMultibase": "string",
  "publicKeyJwk": {
    "property1": "string",
    "property2": "string"
  },
  "revocation": "string"
}

Interface describing a DID document verification method.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the entry.
controller	string	true	none	The controller for the entry.
type	string	true	none	The type of the entry.
publicKeyMultibase	string	false	none	The public key for the entry. Spec https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-03 .
publicKeyJwk	object	false	none	The public key for the entry as a JWK. Spec https://datatracker.ietf.org/doc/html/rfc7517 .
» additionalProperties	string	false	none	none
revocation	string	false	none	Multikey partial revocation.

DidService

{
  "id": "string",
  "type": "string",
  "serviceEndpoint": "string"
}

Interface describing a did document service.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the service.
type	any	true	none	The type of the service.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
serviceEndpoint	any	true	none	The endpoint for the service.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

SignDataRequest

{
  "bytes": "string",
  "verificationMethod": "string"
}

The data to be used in the signing.

Properties

Name	Type	Required	Restrictions	Description
bytes	string	true	none	The bytes for the document encoded as hex.
verificationMethod	string	true	none	The verification method to use for signing.

SignDataResponse

{
  "signatureType": "string",
  "signatureValue": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
signatureType	string	true	none	The type of signature generated.
signatureValue	string	true	none	The value of the signature.

VerifyDataRequest

{
  "bytes": "string",
  "verificationMethod": "string",
  "signatureType": "string",
  "signatureValue": "string"
}

The data to be used in the verification.

Properties

Name	Type	Required	Restrictions	Description
bytes	string	true	none	The bytes for the document encoded as hex.
verificationMethod	string	true	none	The verification method to use for verification.
signatureType	string	true	none	The type of the signature.
signatureValue	string	true	none	The value of the signature.

VerifyDataResponse

{
  "verified": true
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
verified	boolean	true	none	Is the signature verified.

DocumentManagementCreateRequest

{
  "documentId": "string",
  "identity": "string",
  "bytes": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "auditableItemGraphId": "string"
}

The data to be used in the create.

Properties

Name	Type	Required	Restrictions	Description
documentId	string	true	none	The id of the document to create.
identity	string	true	none	The identity to sign the document.
bytes	string	true	none	The bytes for the document encoded as hex.
metadata	[Property]	false	none	Additional properties to storewith the document.
auditableItemGraphId	string	false	none	Id for auditable item graph to add the document as a resource.

DocumentOverview

{
  "proof": {
    "type": "DataIntegrityProof",
    "cryptosuite": "string",
    "created": "string",
    "verificationMethod": "string",
    "proofPurpose": "assertionMethod",
    "proofValue": "string"
  },
  "version": 0,
  "identity": "string",
  "blobStorageId": "string",
  "fileFormat": "string",
  "dateCreated": 0,
  "contentSize": 0,
  "fingerPrint": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "matrix": {
    "property1": null,
    "property2": null
  },
  "id": "string",
  "itemId": "string",
  "tenantId": "string",
  "history": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

Entity to store information about a document.

Properties

Name	Type	Required	Restrictions	Description
proof	DocumentProof	true	none	Interface describing the data document proof.
version	number	true	none	The document version. (https://schema.org/version).
identity	string	true	none	The signer of the document.
blobStorageId	string	true	none	The id of the document in the blob storage.
fileFormat	string	true	none	Media type, typically MIME format of the content. (https://schema.org/fileFormat).
dateCreated	number	true	none	The timestamp for the created.
contentSize	number	true	none	File size in (mega/kilo)bytes. (https://schema.org/contentSize).
fingerPrint	string	true	none	Fingerprint of the document data.
metadata	[Property]	false	none	The custom metadata.
matrix	object	false	none	The document matrix.
» additionalProperties	any	false	none	none
id	string	true	none	The id of the document.
itemId	string	false	none	The item Id.
tenantId	string	false	none	The tenant Id.
history	[RevisionOverview]	false	none	The document revisions.

DocumentProof

{
  "type": "DataIntegrityProof",
  "cryptosuite": "string",
  "created": "string",
  "verificationMethod": "string",
  "proofPurpose": "assertionMethod",
  "proofValue": "string"
}

Interface describing the data document proof.

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	The data document proof type.
cryptosuite	string	true	none	The data document proof crypto suite.
created	string	true	none	The data document proof created at timestamp (ISO8601 string).
verificationMethod	string	true	none	The data document proof verification method.
proofPurpose	string	true	none	The data document proof purpose.
proofValue	string	true	none	The data document proof value.

RevisionOverview

{
  "proof": {
    "type": "DataIntegrityProof",
    "cryptosuite": "string",
    "created": "string",
    "verificationMethod": "string",
    "proofPurpose": "assertionMethod",
    "proofValue": "string"
  },
  "version": 0,
  "identity": "string",
  "blobStorageId": "string",
  "fileFormat": "string",
  "dateCreated": 0,
  "contentSize": 0,
  "fingerPrint": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "matrix": {
    "property1": null,
    "property2": null
  }
}

Entity to store information about a document revision.

Properties

Name	Type	Required	Restrictions	Description
proof	DocumentProof	true	none	Interface describing the data document proof.
version	number	true	none	The document version. (https://schema.org/version).
identity	string	true	none	The signer of the document.
blobStorageId	string	true	none	The id of the document in the blob storage.
fileFormat	string	true	none	Media type, typically MIME format of the content. (https://schema.org/fileFormat).
dateCreated	number	true	none	The timestamp for the created.
contentSize	number	true	none	File size in (mega/kilo)bytes. (https://schema.org/contentSize).
fingerPrint	string	true	none	Fingerprint of the document data.
metadata	[Property]	false	none	The custom metadata.
matrix	object	false	none	The document matrix.
» additionalProperties	any	false	none	none

DocumentManagementVerifyResponse

{
  "overview": {
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "string",
      "created": "string",
      "verificationMethod": "string",
      "proofPurpose": "assertionMethod",
      "proofValue": "string"
    },
    "version": 0,
    "identity": "string",
    "blobStorageId": "string",
    "fileFormat": "string",
    "dateCreated": 0,
    "contentSize": 0,
    "fingerPrint": "string",
    "metadata": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "matrix": {
      "property1": null,
      "property2": null
    }
  },
  "verified": true,
  "bytes": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
overview	RevisionOverview	true	none	Entity to store information about a document revision.
verified	boolean	true	none	Is the document verified.
bytes	string	false	none	The bytes for the document, included if includeBytes was set in the request.

DocumentManagementListResponse

{
  "items": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      },
      "id": "string",
      "itemId": "string",
      "tenantId": "string",
      "history": [
        {
          "proof": {
            "type": "DataIntegrityProof",
            "cryptosuite": "string",
            "created": "string",
            "verificationMethod": "string",
            "proofPurpose": "assertionMethod",
            "proofValue": "string"
          },
          "version": 0,
          "identity": "string",
          "blobStorageId": "string",
          "fileFormat": "string",
          "dateCreated": 0,
          "contentSize": 0,
          "fingerPrint": "string",
          "metadata": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ],
          "matrix": {
            "property1": null,
            "property2": null
          }
        }
      ]
    }
  ],
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[DocumentOverview]	true	none	The items.
cursor	string	false	none	Cursor for paged requests.

DocumentManagementViewUrlResponse

{
  "url": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
url	string	true	none	The url to view the document.

DocumentManagementShareRequest

{
  "emailAddresses": [
    "string"
  ]
}

The request data.

Properties

Name	Type	Required	Restrictions	Description
emailAddresses	[string]	true	none	The email addresses to share the document with.

DocumentManagementViewShareResponse

{
  "document": {
    "verified": true,
    "bytes": {
      "BYTES_PER_ELEMENT": 0,
      "buffer": {
        "byteLength": 0
      },
      "byteLength": 0,
      "byteOffset": 0,
      "length": 0,
      "property1": 0,
      "property2": 0
    },
    "proof": {
      "type": "DataIntegrityProof",
      "cryptosuite": "string",
      "created": "string",
      "verificationMethod": "string",
      "proofPurpose": "assertionMethod",
      "proofValue": "string"
    },
    "version": 0,
    "identity": "string",
    "blobStorageId": "string",
    "fileFormat": "string",
    "dateCreated": 0,
    "contentSize": 0,
    "fingerPrint": "string",
    "metadata": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "matrix": {
      "property1": null,
      "property2": null
    }
  },
  "documentType": {
    "uri": "string",
    "name": "string",
    "code": "string",
    "identifierField": "string",
    "isStandardType": true,
    "isOpenGtsc": true
  },
  "documentViewUrl": "string",
  "documentDownloadUrl": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
document	object	true	none	Verified document.
» verified	boolean	true	none	none
» bytes	object	false	none	none
»» additionalProperties	number	false	none	none
»» BYTES_PER_ELEMENT	number	true	none	none
»» buffer	object	true	none	none
»»» byteLength	number	true	none	none
»» byteLength	number	true	none	none
»» byteOffset	number	true	none	none
»» length	number	true	none	none
» proof	DocumentProof	true	none	Interface describing the data document proof.
» version	number	true	none	The document version. (https://schema.org/version).
» identity	string	true	none	The signer of the document.
» blobStorageId	string	true	none	The id of the document in the blob storage.
» fileFormat	string	true	none	Media type, typically MIME format of the content. (https://schema.org/fileFormat).
» dateCreated	number	true	none	The timestamp for the created.
» contentSize	number	true	none	File size in (mega/kilo)bytes. (https://schema.org/contentSize).
» fingerPrint	string	true	none	Fingerprint of the document data.
» metadata	[Property]	false	none	The custom metadata.
» matrix	object	false	none	The document matrix.
»» additionalProperties	any	false	none	none
documentType	DocumentType	false	none	The response to get a document type.
documentViewUrl	string	true	none	The document view url.
documentDownloadUrl	string	true	none	The document download url.

DocumentType

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "identifierField": "string",
  "isStandardType": true,
  "isOpenGtsc": true
}

The response to get a document type.

Properties

Name	Type	Required	Restrictions	Description
uri	string	true	none	The uri of the reference code.
name	string	true	none	The name of the reference code.
code	string,number	true	none	The value of the reference code.
identifierField	string	false	none	The identifier field used for the document type.
isStandardType	boolean	false	none	Standard Type.
isOpenGtsc	boolean	false	none	Open GTSC Type.

DocumentManagementSharingUrlResponse

{
  "documentSharingUrl": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
documentSharingUrl	string	true	none	The document sharing url.

InventoryStatus

"commisioned"

The inventory status properties.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	The inventory status properties.

Enumerated Values

Property	Value
anonymous	commisioned
anonymous	stocked
anonymous	faulty
anonymous	shipped
anonymous	delivered
anonymous	received
anonymous	sold
anonymous	installed
anonymous	recalled
anonymous	returned
anonymous	recycled

InventoryGetResponse

{
  "items": [
    {
      "id": "string",
      "type": [
        "string"
      ],
      "inventoryLevel": [
        {
          "inventoryStatus": "commisioned",
          "value": 0,
          "location": "string"
        }
      ]
    }
  ],
  "cursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[InventoryEntity]	true	none	The response data.
cursor	string	false	none	Cursor for paged lookups.

InventoryEntity

{
  "id": "string",
  "type": [
    "string"
  ],
  "inventoryLevel": [
    {
      "inventoryStatus": "commisioned",
      "value": 0,
      "location": "string"
    }
  ]
}

The inventory entity.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The item id.
type	[string]	true	none	The item type.
inventoryLevel	[InventoryLevel]	true	none	The item inventory level.

InventoryLevel

{
  "inventoryStatus": "commisioned",
  "value": 0,
  "location": "string"
}

The inventory level summary.

Properties

Name	Type	Required	Restrictions	Description
inventoryStatus	InventoryStatus	true	none	The inventory status properties.
value	number	true	none	The item's inventory value.
location	string	true	none	The item's inventory location.

ItemInventoryQuery

{
  "status": "commisioned",
  "location": "string",
  "groupBy": "string"
}

Interface for item inventory query.

Properties

Name	Type	Required	Restrictions	Description
status	InventoryStatus	false	none	The inventory status properties.
location	string	false	none	The item location.
groupBy	string	false	none	The items grouping.

ConsignmentCreateRequest

{
  "identifiers": [
    {
      "type": "string",
      "id": "string"
    }
  ],
  "documents": [
    {
      "issuingCompany": "string",
      "data": {
        "binaryData": "string",
        "completionStatus": "complete",
        "issuer": "string"
      }
    }
  ],
  "items": [
    {
      "type": "string",
      "id": "string"
    }
  ],
  "consignmentType": "consignment",
  "itemsToShipment": true
}

The data to be used in the create.

Properties

Name	Type	Required	Restrictions	Description
identifiers	[Identifier]	true	none	The consignment identifiers.
documents	[ConsignmentDocumentCreateUpdateRequest]	true	none	The consignment's documents.
items	[Identifier]	false	none	The consignment's commodities or consignments.
consignmentType	string	true	none	The consignment type.
itemsToShipment	boolean	false	none	Whether to add consignments to shipment?

Enumerated Values

Property	Value
consignmentType	consignment
consignmentType	shipment

Identifier

{
  "type": "string",
  "id": "string"
}

Identifier response.

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	Identifier type.
id	string	true	none	Identifier value.

ConsignmentDocumentCreateUpdateRequest

{
  "issuingCompany": "string",
  "data": {
    "binaryData": "string",
    "completionStatus": "complete",
    "issuer": "string"
  }
}

Create or update a consignment document.

Properties

Name	Type	Required	Restrictions	Description
issuingCompany	string	true	none	The organization generating and issuing the document.
data	object	true	none	The data to be used in the operation.
» binaryData	string	true	none	Base 64 encoded version of the document.
» completionStatus	string	true	none	Completion state for any associated event.
» issuer	string	false	none	The issuer of the document.

Enumerated Values

Property	Value
completionStatus	complete
completionStatus	issued
completionStatus	approved
completionStatus	rejected
completionStatus	failed
completionStatus	other

ConsignmentCreateResponse

{
  "consignmentId": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
consignmentId	string	true	none	The identifier of the created consignment.

ConsignmentAddItemsRequest

{
  "consignmentType": "consignment",
  "items": [
    {
      "type": "string",
      "id": "string"
    }
  ]
}

The data to be used in creating an alias.

Properties

Name	Type	Required	Restrictions	Description
consignmentType	ConsignmentType	true	none	Consignment Types.
items	[Identifier]	true	none	The commodities or consignments associated to the consignment.

ConsignmentType

"consignment"

Consignment Types.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Consignment Types.

Enumerated Values

Property	Value
anonymous	consignment
anonymous	shipment
anonymous	commodity

ConsignmentsAddRequest

{
  "consignments": [
    "string"
  ]
}

The data to be used in adding relationships.

Properties

Name	Type	Required	Restrictions	Description
consignments	[string]	true	none	The consignments to be associated to the shipment.

ConsignmentAddIdentifierRequest

{
  "aliasType": "string",
  "aliasId": "string"
}

The data to be used in creating an alias.

Properties

Name	Type	Required	Restrictions	Description
aliasType	string	true	none	Alias type.
aliasId	string	true	none	The alias id.

ConsignmentDocumentCreateUpdateResponse

{
  "id": "string",
  "revision": 0,
  "fingerPrint": "string",
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "identifiers": [
    {
      "id": "string",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ]
    }
  ],
  "events": [
    {
      "itemId": "string",
      "type": "string",
      "identity": "string",
      "startTime": 0,
      "endTime": 0,
      "completionStatus": "complete",
      "action": "Request",
      "customTitle": "string",
      "fail": true,
      "code": 0,
      "location": {
        "name": "string",
        "longitude": 0,
        "latitude": 0
      },
      "documentRevision": 0,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "id": "string",
      "name": "string"
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The document id.
revision	number	true	none	The new revision number of the updated document.
fingerPrint	string	true	none	The fingerprint for the document.
properties	[Property]	false	none	Field matrix values added during the processing.
identifiers	[AliasId]	false	none	Identifiers added during the processing.
events	[SimpleEvent]	false	none	Events extracted during processing.

SimpleEvent

{
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "id": "string",
  "name": "string"
}

Simple Event.

Properties

Name	Type	Required	Restrictions	Description
itemId	string	true	none	The event subject (the itemId).
type	string	true	none	Event type.
identity	string	true	none	The identity of the organization or user that issued the event.
startTime	number	true	none	Start time.
endTime	number	false	none	End time.
completionStatus	string	false	none	Completion Status.
action	string	false	none	Event action.
customTitle	string	false	none	If the event type is custom, this is the title to display.
fail	boolean	false	none	If completion was a success or failure.
code	number,string	false	none	The document code associated with the event as in https://vocabulary.uncefact.org/DocumentCodeList.
location	EventLocationData	false	none	Location options.
documentRevision	number	false	none	The revision of the document if there is one.
properties	[Property]	false	none	Extended data.
id	string	true	none	ID of the event.
name	string	false	none	The display name.

Enumerated Values

Property	Value
completionStatus	complete
completionStatus	issued
completionStatus	approved
completionStatus	rejected
completionStatus	failed
completionStatus	other
action	Request
action	Add

EventLocationData

{
  "name": "string",
  "longitude": 0,
  "latitude": 0
}

Location options.

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Location name.
longitude	number	false	none	Location longitude.
latitude	number	false	none	Location latitude.

IdentifierType

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "isStandardType": true,
  "isOpenGtsc": true
}

Identifier type.

Properties

Name	Type	Required	Restrictions	Description
uri	string	true	none	The uri of the reference code.
name	string	true	none	The name of the reference code.
code	string,number	true	none	The value of the reference code.
isStandardType	boolean	false	none	Standard Type.
isOpenGtsc	boolean	false	none	Open GTSC Type.

IdentifierTypesListResponse

{
  "items": [
    {
      "uri": "string",
      "name": "string",
      "code": "string",
      "isStandardType": true,
      "isOpenGtsc": true
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[IdentifierType]	true	none	The identifier type items.

DocumentTypesListResponse

{
  "items": [
    {
      "uri": "string",
      "name": "string",
      "code": "string",
      "identifierField": "string",
      "isStandardType": true,
      "isOpenGtsc": true,
      "defaultReaders": [
        "string"
      ],
      "defaultWriters": [
        "string"
      ]
    }
  ],
  "nextPageCursor": "string"
}

The response data.

Properties

Name	Type	Required	Restrictions	Description
items	[DocumentTypesList]	true	none	Document types list.
nextPageCursor	string	false	none	Cursor pointing to the next set of results in a paged request.

DocumentTypesList

{
  "uri": "string",
  "name": "string",
  "code": "string",
  "identifierField": "string",
  "isStandardType": true,
  "isOpenGtsc": true,
  "defaultReaders": [
    "string"
  ],
  "defaultWriters": [
    "string"
  ]
}

Document types list.

Properties

Name	Type	Required	Restrictions	Description
uri	string	true	none	The uri of the reference code.
name	string	true	none	The name of the reference code.
code	string,number	true	none	The value of the reference code.
identifierField	string	false	none	The identifier field used for the document type.
isStandardType	boolean	false	none	Standard Type.
isOpenGtsc	boolean	false	none	Open GTSC Type.
defaultReaders	[string]	true	none	List of default readers for the document type.
defaultWriters	[string]	true	none	List of default writers for the document type.

TLIPEventType

{
  "id": "string",
  "name": "string",
  "uri": {},
  "createName": "string",
  "inProgressName": "string",
  "documentType": "string",
  "code": 0,
  "isOpenGtsc": true
}

Event type.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The event type id.
name	string	true	none	The event type name e.g Goods Delivered.
uri	any	true	none	Event type URI defined in Linked Data Vocabularies e.g https://w3id.org/open-gtsc/kra_release_event.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Url	false	none	Class to help with urls.

or

Name	Type	Required	Restrictions	Description
» anonymous	Urn	false	none	Class to help with urns.

continued

Name	Type	Required	Restrictions	Description
createName	string	true	none	Event creation name e.g Request Export Certificate.
inProgressName	string	true	none	In progess name e.g Export Certificate Requested.
documentType	string	false	none	The type of document associated with the event.
code	number,string	false	none	The document code associated with the event as in https://vocabulary.uncefact.org/DocumentCodeList.
isOpenGtsc	boolean	false	none	Whether is a gtsc internal event type.

Url

{}

Class to help with urls.

Properties

None

Urn

{}

Class to help with urns.

Properties

None

EventTypesListResponse

{
  "eventTypes": [
    {
      "id": "string",
      "name": "string",
      "uri": {},
      "createName": "string",
      "inProgressName": "string",
      "documentType": "string",
      "code": 0,
      "isOpenGtsc": true
    }
  ],
  "nextPageCursor": "string"
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
eventTypes	[TLIPEventType]	true	none	The event type items.
nextPageCursor	string	false	none	The next page cursor.

SimpleEventData

{
  "itemId": "string",
  "type": "string",
  "identity": "string",
  "startTime": 0,
  "endTime": 0,
  "completionStatus": "complete",
  "action": "Request",
  "customTitle": "string",
  "fail": true,
  "code": 0,
  "location": {
    "name": "string",
    "longitude": 0,
    "latitude": 0
  },
  "documentRevision": 0,
  "properties": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ]
}

Simple Event.

Properties

Name	Type	Required	Restrictions	Description
itemId	string	true	none	The event subject (the itemId).
type	string	true	none	Event type.
identity	string	true	none	The identity of the organization or user that issued the event.
startTime	number	true	none	Start time.
endTime	number	false	none	End time.
completionStatus	string	false	none	Completion Status.
action	string	false	none	Event action.
customTitle	string	false	none	If the event type is custom, this is the title to display.
fail	boolean	false	none	If completion was a success or failure.
code	number,string	false	none	The document code associated with the event as in https://vocabulary.uncefact.org/DocumentCodeList.
location	EventLocationData	false	none	Location options.
documentRevision	number	false	none	The revision of the document if there is one.
properties	[Property]	false	none	Extended data.

Enumerated Values

Property	Value
completionStatus	complete
completionStatus	issued
completionStatus	approved
completionStatus	rejected
completionStatus	failed
completionStatus	other
action	Request
action	Add

EventsListResponse

{
  "events": [
    {
      "itemId": "string",
      "type": "string",
      "identity": "string",
      "startTime": 0,
      "endTime": 0,
      "completionStatus": "complete",
      "action": "Request",
      "customTitle": "string",
      "fail": true,
      "code": 0,
      "location": {
        "name": "string",
        "longitude": 0,
        "latitude": 0
      },
      "documentRevision": 0,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "id": "string",
      "name": "string"
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
events	[SimpleEvent]	true	none	The events list.

DocumentsListResponse

{
  "items": [
    {
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "assertionMethod",
        "proofValue": "string"
      },
      "version": 0,
      "identity": "string",
      "blobStorageId": "string",
      "fileFormat": "string",
      "dateCreated": 0,
      "contentSize": 0,
      "fingerPrint": "string",
      "metadata": [
        {
          "key": "string",
          "type": "string",
          "value": null
        }
      ],
      "matrix": {
        "property1": null,
        "property2": null
      },
      "id": "string",
      "itemId": "string",
      "tenantId": "string",
      "history": [
        {
          "proof": {
            "type": "DataIntegrityProof",
            "cryptosuite": "string",
            "created": "string",
            "verificationMethod": "string",
            "proofPurpose": "assertionMethod",
            "proofValue": "string"
          },
          "version": 0,
          "identity": "string",
          "blobStorageId": "string",
          "fileFormat": "string",
          "dateCreated": 0,
          "contentSize": 0,
          "fingerPrint": "string",
          "metadata": [
            {
              "key": "string",
              "type": "string",
              "value": null
            }
          ],
          "matrix": {
            "property1": null,
            "property2": null
          }
        }
      ]
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
items	[DocumentOverview]	true	none	The documents list.

OrganizationUsersListResponse

{
  "nextPageCursor": "string",
  "users": [
    {
      "email": "string",
      "name": "string",
      "accountLocked": true
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
nextPageCursor	string	false	none	The cursor for paged requests.
users	[object]	true	none	Organization users.
» email	string	true	none	The user email.
» name	string	true	none	The user name.
» accountLocked	boolean	true	none	Whether the auth login account is locked.

MatrixDisplayGetRequest

{}

The request to get display matrix.

Properties

None

MatrixDisplayGetResponse

{
  "groups": [
    {
      "label": "string",
      "arrayField": "string",
      "fields": [
        {
          "label": "string",
          "id": "string",
          "format": "linebreak",
          "fields": [
            {}
          ]
        }
      ]
    }
  ]
}

The response payload.

Properties

Name	Type	Required	Restrictions	Description
groups	[MatrixDisplayGroup]	false	none	Matrix display groups.

MatrixDisplayGroup

{
  "label": "string",
  "arrayField": "string",
  "fields": [
    {
      "label": "string",
      "id": "string",
      "format": "linebreak",
      "fields": [
        {}
      ]
    }
  ]
}

Matrix display goup.

Properties

Name	Type	Required	Restrictions	Description
label	string	true	none	The label for the group.
arrayField	string	false	none	If this is an array.
fields	[MatrixDisplayGroupField]	true	none	The fields for the items in the group.

MatrixDisplayGroupField

{
  "label": "string",
  "id": "string",
  "format": "linebreak",
  "fields": [
    {
      "label": "string",
      "id": "string",
      "format": "linebreak",
      "fields": []
    }
  ]
}

Matrix display group field.

Properties

Name	Type	Required	Restrictions	Description
label	string	true	none	The label of the field.
id	any	true	none	The id of the group item.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
format	MatrixDisplayGroupFieldFormat	false	none	Matrix display group field format.
fields	[MatrixDisplayGroupField]	false	none	Fields used if format is list.

MatrixDisplayGroupFieldFormat

"linebreak"

Matrix display group field format.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Matrix display group field format.

Enumerated Values

Property	Value
anonymous	linebreak
anonymous	hyphen
anonymous	space
anonymous	date
anonymous	list

HealthCheckServices

{
  "entityStorage": "string",
  "blobStorage": "string",
  "immutableStorage": "string"
}

Services on which we perform health check on.

Properties

Name	Type	Required	Restrictions	Description
entityStorage	string	true	none	Health check performed on entity storage.
blobStorage	string	true	none	Health check performed on blob storage.
immutableStorage	string	true	none	Health check performed on the immutable storage.

ModifyAccessToGroupRequest

{
  "identities": [
    "string"
  ]
}

Request data.

Properties

Name	Type	Required	Restrictions	Description
identities	[string]	true	none	Identities of the profiles to add.

ActivityLogs

{
  "metrics": [
    {
      "id": "string",
      "component": "string",
      "ts": 0,
      "type": "string",
      "data": null,
      "tenantId": "string"
    }
  ],
  "cursor": "string",
  "bytes": "string"
}

Activity logs.

Properties

Name	Type	Required	Restrictions	Description
metrics	[ComponentMetric]	true	none	The activity logs.
cursor	string	false	none	The cursor offset to get identitifer types from.
bytes	string	false	none	Document Bytes.

ActivityStream

{
  "@context": "string",
  "id": "string",
  "type": "Create",
  "generator": "string",
  "actor": {
    "id": "string",
    "name": "string",
    "type": "Organization",
    "identificationType": "string",
    "identificationId": "string"
  },
  "object": {
    "type": "Document",
    "code": 0,
    "versionId": "string",
    "issueDateTime": "string",
    "mediaType": [
      "string"
    ],
    "href": "string",
    "provider": "string",
    "issuerParty": {
      "id": "string",
      "type": [
        "string"
      ],
      "identificationType": "string",
      "identificationId": "string"
    },
    "documentBinaryData": "string"
  },
  "target": {
    "type": "Consignment",
    "globalId": "string",
    "identificationType": "string",
    "identificationId": "string",
    "customsId": "string",
    "exporterParty": {
      "exportTypecode": "string",
      "exporterParty": "string",
      "destinationCountry": "string"
    },
    "importerParty": {
      "importTypecode": "string",
      "importerParty": "string",
      "importCountry": "string"
    }
  },
  "updated": "string",
  "to": {}
}

Activity Stream interface.

Properties

Name	Type	Required	Restrictions	Description
@context	LdContext	true	none	JSON-LD @context.
id	string	false	none	LD @id.
type	string	true	none	LD @type.
generator	string	true	none	Activity's Generator.
actor	OrganizationActor	true	none	Activity actor.
object	ActivityObject	true	none	Activity's actor.
target	UneceConsignment	false	none	UN/CEFACT Consignment.
updated	string	true	none	Updated.
to	Url	true	none	Class to help with urls.

Enumerated Values

Property	Value
type	Create
type	Add
type	Request
type	Update

OrganizationActor

{
  "id": "string",
  "name": "string",
  "type": "Organization",
  "identificationType": "string",
  "identificationId": "string"
}

Activity actor.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	LD @id.
name	string	false	none	Org name.
type	any	true	none	LD @type.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
identificationType	string	true	none	Identification Type.
identificationId	string	true	none	The identification id.

ActivityObject

{
  "type": "Document",
  "code": 0,
  "versionId": "string",
  "issueDateTime": "string",
  "mediaType": [
    "string"
  ],
  "href": "string",
  "provider": "string",
  "issuerParty": {
    "id": "string",
    "type": [
      "string"
    ],
    "identificationType": "string",
    "identificationId": "string"
  },
  "documentBinaryData": "string"
}

Activity's actor.

Properties

anyOf

Name	Type	Required	Restrictions	Description
anonymous	UneceDocument	false	none	UN/CEFACT Document.

or

Name	Type	Required	Restrictions	Description
anonymous	UneceConsignment	false	none	UN/CEFACT Consignment.

UneceDocument

{
  "type": "Document",
  "code": 0,
  "versionId": "string",
  "issueDateTime": "string",
  "mediaType": [
    "string"
  ],
  "href": "string",
  "provider": "string",
  "issuerParty": {
    "id": "string",
    "type": [
      "string"
    ],
    "identificationType": "string",
    "identificationId": "string"
  },
  "documentBinaryData": "string"
}

UN/CEFACT Document.

Properties

Name	Type	Required	Restrictions	Description
type	any	true	none	LD @ type.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
code	number,string	true	none	Document type code.
versionId	string	false	none	Version Id.
issueDateTime	string	false	none	Issue datetime.
mediaType	[string]	false	none	Media Type.
href	string	false	none	URL.
provider	string	false	none	Document provider.
issuerParty	UneceParty	false	none	UN/CEFACT Party.
documentBinaryData	string	false	none	Binary data for the document.

UneceParty

{
  "id": "string",
  "type": [
    "string"
  ],
  "identificationType": "string",
  "identificationId": "string"
}

UN/CEFACT Party.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The party id.
type	any	true	none	LD @type.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
identificationType	string	true	none	Identification Type.
identificationId	string	true	none	Identification Id.

UneceConsignment

{
  "type": "Consignment",
  "globalId": "string",
  "identificationType": "string",
  "identificationId": "string",
  "customsId": "string",
  "exporterParty": {
    "exportTypecode": "string",
    "exporterParty": "string",
    "destinationCountry": "string"
  },
  "importerParty": {
    "importTypecode": "string",
    "importerParty": "string",
    "importCountry": "string"
  }
}

UN/CEFACT Consignment.

Properties

Name	Type	Required	Restrictions	Description
type	any	true	none	LD @ type.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

continued

Name	Type	Required	Restrictions	Description
globalId	string	false	none	UCR.
identificationType	string	false	none	Identification Type.
identificationId	string	false	none	Identification Id.
customsId	string	false	none	Customs identification id.
exporterParty	UneceExportConsignment	false	none	UN/CEFACT common Consignment.
importerParty	UneceImportConsignment	false	none	UN/CEFACT common Consignment.

UneceExportConsignment

{
  "exportTypecode": "string",
  "exporterParty": "string",
  "destinationCountry": "string"
}

UN/CEFACT common Consignment.

Properties

Name	Type	Required	Restrictions	Description
exportTypecode	string	true	none	Export commodity type code.
exporterParty	string	true	none	Exporter party.
destinationCountry	string	true	none	Destination country.

UneceImportConsignment

{
  "importTypecode": "string",
  "importerParty": "string",
  "importCountry": "string"
}

UN/CEFACT common Consignment.

Properties

Name	Type	Required	Restrictions	Description
importTypecode	string	true	none	Import commodity type code.
importerParty	string	true	none	Importer party.
importCountry	string	true	none	Destination country.

JobDetails

{
  "id": "string",
  "generator": "string",
  "jobData": {
    "property1": null,
    "property2": null
  },
  "status": "pending",
  "created": 0,
  "started": 0,
  "finished": 0,
  "result": null,
  "error": {
    "name": "string",
    "message": "string",
    "stack": "string"
  },
  "to": {}
}

Job Details.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The Job id.
generator	string	true	none	The generator of the job.
jobData	object	false	none	Data associated to the job. It can be params, runnableClass, etc.
» additionalProperties	any	false	none	none
status	JobStatus	true	none	Job statuses.
created	number	true	none	When it was created.
started	number	false	none	When it started.
finished	number	false	none	When it finished.
result	any	false	none	The result.
error	object	false	none	The error if failed.
» name	string	true	none	none
» message	string	true	none	none
» stack	string	false	none	none
to	Url	false	none	Class to help with urls.

JobStatus

"pending"

Job statuses.

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Job statuses.

Enumerated Values

Property	Value
anonymous	pending
anonymous	running
anonymous	completed
anonymous	failed
anonymous	error

DocumentQuery

{
  "code": 0,
  "globalId": "string",
  "customsId": "string",
  "identificationId": "string",
  "identificationType": "string",
  "versionId": "string"
}

Consignment document get request.

Properties

Name	Type	Required	Restrictions	Description
code	number,string	true	none	The document code. (https://vocabulary.uncefact.org/DocumentCodeList).
globalId	string	false	none	The consignment global identification id. Consignment UCR as per WCO standard.
customsId	string	false	none	The consignment customs declaration identification id. Consignment customs declaration number as per WCO standard.
identificationId	string	false	none	The document local identification id. (only mandatory if globalIdentificationId is not provided and ignored otherwise).
identificationType	string	false	none	The consignment local identification type. (optional and it shall be ignored unless identificationId is provided).
versionId	string	false	none	The document version to get.

RevisionOverviewHarmonized

{
  "@context": "string",
  "type": [
    "string"
  ],
  "id": "string",
  "proof": {
    "type": "DataIntegrityProof",
    "cryptosuite": "string",
    "created": "string",
    "verificationMethod": "string",
    "proofPurpose": "assertionMethod",
    "proofValue": "string"
  },
  "version": 0,
  "identity": "string",
  "blobStorageId": "string",
  "fileFormat": "string",
  "dateCreated": 0,
  "contentSize": 0,
  "fingerPrint": "string",
  "metadata": [
    {
      "key": "string",
      "type": "string",
      "value": null
    }
  ],
  "matrix": {
    "property1": null,
    "property2": null
  },
  "code": 0,
  "verified": true,
  "contentUrl": "string",
  "property1": null,
  "property2": null
}

Harmonized revision overview.

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	none
@context	LdContext	true	none	JSON-LD @context.
type	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

continued

Name	Type	Required	Restrictions	Description
id	string	true	none	none
proof	DocumentProof	true	none	Interface describing the data document proof.
version	number	true	none	The document version. (https://schema.org/version).
identity	string	true	none	The signer of the document.
blobStorageId	string	true	none	The id of the document in the blob storage.
fileFormat	string	true	none	Media type, typically MIME format of the content. (https://schema.org/fileFormat).
dateCreated	number	true	none	The timestamp for the created.
contentSize	number	true	none	File size in (mega/kilo)bytes. (https://schema.org/contentSize).
fingerPrint	string	true	none	Fingerprint of the document data.
metadata	[Property]	false	none	The custom metadata.
matrix	object	false	none	The document matrix.
» additionalProperties	any	false	none	none
code	number,string	true	none	The document code.
verified	boolean	true	none	Is the document verified.
contentUrl	string	false	none	The document data url.

ActivityLogEntryListResponse

{
  "jobs": [],
  "cursor": "string"
}

The response data.

Properties

Name	Type	Required	Restrictions	Description
jobs	[JobDetailsSummary]	true	none	none
cursor	string	false	none	none

ActivityLogEntrySummary

{
  "id": "string",
  "created": 0
}

A summary of Activity Log Entries to allow TLIP Connector clients to know the status of activity processing.

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	The id of the job.
created	number	true	none	The date the job was created.

RegisterSystemRequest

{
  "identity": "string",
  "endpoint": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity of the system to communicate with.
endpoint	string	true	none	The endpoint.

UpdateSystemRequest

{
  "endpoint": "string",
  "apiKey": "string"
}

The request data.

Properties

Name	Type	Required	Restrictions	Description
endpoint	string	true	none	The endpoint.
apiKey	string	true	none	The API key.

AddTrustedIdentityRequest

{
  "identity": "string",
  "emailAddress": "string",
  "name": "string"
}

The request data.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The system identity.
emailAddress	string	true	none	The system email address.
name	string	false	none	The optional system name.

ProcessAccessRequest

{
  "identity": "string",
  "emailAddress": "string",
  "name": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity of the requesting system.
emailAddress	string	true	none	The email address for the identity.
name	string	false	none	The name of the system eg. TLIP or iCMS.

AccessRequest

{
  "identity": "string"
}

The data for the request.

Properties

Name	Type	Required	Restrictions	Description
identity	string	true	none	The identity to request access for.

ListOfstring

[]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[string]	false	none	none

ListOfSimpleEvent

[
  {
    "itemId": "string",
    "type": "string",
    "identity": "string",
    "startTime": 0,
    "endTime": 0,
    "completionStatus": "complete",
    "action": "Request",
    "customTitle": "string",
    "fail": true,
    "code": 0,
    "location": {
      "name": "string",
      "longitude": 0,
      "latitude": 0
    },
    "documentRevision": 0,
    "properties": [
      {
        "key": "string",
        "type": "string",
        "value": null
      }
    ],
    "id": "string",
    "name": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[SimpleEvent]	false	none	[Simple Event.]