Skip to content

Instantly share code, notes, and snippets.

@sadick254

sadick254/gist:d449ba774235fea387a3d5c57a156e55

Last active November 25, 2025 12:09
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save sadick254/d449ba774235fea387a3d5c57a156e55 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save sadick254/d449ba774235fea387a3d5c57a156e55 to your computer and use it in GitHub Desktop.
Download ZIP
postman_collection
Raw
gistfile1.txt
{
"openapi": "3.0.2",
"info": {
"title": "Global Trade and Supply Chain",
"description": "REST API for Global Trade and Supply Chain building blocks.",
"version": "0.0.1",
"license": {
"name": "Apache 2.0 License",
"url": "https://opensource.org/licenses/Apache-2.0"
}
},
"tags": [
{
"name": "Core",
"description": "Core endpoints"
},
{
"name": "Auditable Item Graph",
"description": "\nStore items and their associated data, and provide an immutable audit trail for the item. Includes relationships between the items to form a graph.\n\n### Features\n- Create/update/retrieve data for an item\n - Properties\n - Primary Identifier\n - Secondary Identifiers (alternative IDs that can be used to find the item e.g. associated document IDs)\n - Relationships to other items (parent/child/inherits)\n - Resources associated with the item(documents, data feeds)\n- Store the hash of the item data in immutable storage\n- Complete immutable audit trail of all the changes to the item\n- Search for the item by its primary or secondary identifiers\n\n\n### Extensions\n- Blobs - create/update binary items resources (e.g. documents)\n- JSON-LD - readable version of the item for interoperability\n\n\n### Use Cases\n- Store the data for a consignment with associated documents\n- Store the data for an item, related to a parent consignment and inheriting a product type\n"
},
{
"name": "Logger",
"description": "Endpoints which are part of the Logger building block."
},
{
"name": "Indexing",
"description": "Endpoints which are part of the Indexing building block."
},
{
"name": "Counters",
"description": "Endpoints which are part of the Counters building block."
},
{
"name": "Catalog Location",
"description": "The catalog building block allows for the provision of reference data for use by other components.\n\n### Features\n- Create/read/update/delete reference data\n- Lookup reference data\n\n### Extensions\n- Location - specific data type which allows lookups by GPS coords\n\n### Use Cases\n- Organization maintaining a set of locations relevant to the supply chain\n- Map status codes to descriptions\n"
},
{
"name": "Metrics",
"description": "Endpoints which supply metrics information about the system."
},
{
"name": "Authentication",
"description": "Endpoints which provide authentication features."
},
{
"name": "Identity",
"description": "Building block to provide all features related to digital identity in an organizational scenario.\n\n### Features\n- Create/update DID with associated verification methods (public/private key pairs) - stored immutably\n- 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\n- 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,\n- Create/update a verifiable credential application for an identity (e.g. User applying to become a member of organization)\n- Retrieve verifiable credentials by state (e.g. organization getting list of users applying to join)\n- Issue a verifiable credential (e.g. User joining organization approved)\n- Check the validity of a verifiable credential (e.g. User is a member of an organization)\n\n### Extensions\n- Authentication - provides login facilities based on DIDs\n- E-mail/Password/Two Factor authentication\n\n### Use Cases\n- Organizations with users who can enroll to become a member of the organization\n- Organizations offering some other kind of verification of an entity\n- Associating a device with an organization\n"
},
{
"name": "Document Management",
"description": "Building block to provide a simple mechanism for storing and verifying documents, with optional association as a resource to existing items.\n\n### Features\n- Add a document\n- Store the hash of the document and the DID of the entity adding the document\n- Retrieve a document and verify its authenticity and author\n\n### Use Cases\n- Adding a phyto-sanitary certificate to a consignment\n- Associating a certificate of provenance with an item\n- Creating a verifiable purchase order for sharing\n"
},
{
"name": "Inventory",
"description": "Endpoints which are part of the Inventory building block."
},
{
"name": "TLIP",
"description": "Provides business-layer APIs for TLIP Bridge and UI."
},
{
"name": "SimpleEvents",
"description": " Record events for an item, events could be status updates, EPCIS events, location events etc . The events will be stored immutably.\n\n### Features\n- Create/update events associated with an item\n- Hash the events and create an immutable record for them\n- Retrieve timeline of current events\n\n### Extensions\n- JSON-LD read endpoint\n\n### Use Cases\n- Record documents requests, location changes etc for a consignment\n "
},
{
"name": "TLIP Connector",
"description": "Endpoints which are part of the TLIP Connector building block."
},
{
"name": "Platform Directory",
"description": "Endpoints which are part of the platform-directory building block."
}
],
"paths": {
"/": {
"get": {
"operationId": "Get the version of the API running",
"summary": "Get the version of the API running",
"tags": [
"Core"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/bootstrap": {
"get": {
"operationId": "Bootstrap any components that need initialization",
"summary": "Bootstrap any components that need initialization",
"tags": [
"Core"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item": {
"get": {
"operationId": "Get a list of items",
"summary": "Get a list of items",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "orderBy",
"description": "Sort key.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "direction",
"description": "The direction to sort the items.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"description": "Cursor for a multi page request.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"description": "Number of items to return.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "shared",
"description": "Return shared items.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "page",
"description": "The page number to list.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "dateFrom",
"description": "Start date filter.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "dateTo",
"description": "End date filter.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to list items request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
},
"post": {
"operationId": "Create an item",
"summary": "Create an item",
"tags": [
"Auditable Item Graph"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCreateRequest"
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}": {
"get": {
"operationId": "Get an item",
"summary": "Get an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The id for an item.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for an item get request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update an item",
"summary": "Update an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The primary id for the item.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Update an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemUpdateRequest"
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/permissions": {
"post": {
"operationId": "Add permissions to an item",
"summary": "Add permissions to an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the item to add the permission to.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Add permission request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Permission"
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/permissions/{identity}": {
"put": {
"operationId": "Update item permission",
"summary": "Update item permission",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the item to add the permission to.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "identity",
"description": "The identity to update the permission for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
},
"requestBody": {
"description": "Update permission request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemUpdatePermissionRequest"
}
}
}
}
},
"delete": {
"operationId": "Remove a permission from an item",
"summary": "Remove a permission from an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the item to add the permission to.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "identity",
"description": "The identity to update the permission for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/history": {
"get": {
"operationId": "Get an items history",
"summary": "Get an items history",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The id for an item.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "limit",
"description": "Limit the number of items.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "cursor",
"description": "Cursor to get next chunk.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for an item history request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemHistoryResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/alias-id": {
"post": {
"operationId": "Add an alias id to an item",
"summary": "Add an alias id to an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Add a new alias id for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AliasId"
}
}
}
}
},
"patch": {
"operationId": "Merge new alias ids for an item",
"summary": "Merge new alias ids for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Merge alias ids for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AliasIdMergeRequest"
}
}
}
}
},
"get": {
"operationId": "Get all the alias ids for an item",
"summary": "Get all the alias ids for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The list of all resources for an item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/alias-id/{aliasId}": {
"get": {
"operationId": "Get an alias id for an item",
"summary": "Get an alias id for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "aliasId",
"description": "The alias id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a resource get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update an alias id for an item",
"summary": "Update an alias id for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "aliasId",
"description": "The alias id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Update an alias id for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AliasIdUpdateRequest"
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/resource": {
"post": {
"operationId": "Add a resource to an item",
"summary": "Add a resource to an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Add a new resource for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceAddRequest"
}
}
}
}
},
"get": {
"operationId": "Get all the resources for an item",
"summary": "Get all the resources for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The list of all resources for an item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/resource/{resourceId}": {
"get": {
"operationId": "Get a resource for an item",
"summary": "Get a resource for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "resourceId",
"description": "The resource id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a resource get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update a resource for an item",
"summary": "Update a resource for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "resourceId",
"description": "The resource id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Update a resource for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceUpdateRequest"
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/relationship": {
"post": {
"operationId": "Add a relationship to an item",
"summary": "Add a relationship to an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Add a new relationship for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Relationship"
}
}
}
}
},
"get": {
"operationId": "Get all the relationships for an item",
"summary": "Get all the relationships for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "type",
"description": "Type of relationships to filter by.",
"in": "query",
"required": false,
"schema": {}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The list of all relationships for an item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelationshipListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/relationship/{relationshipId}": {
"get": {
"operationId": "Get a relationship for an item",
"summary": "Get a relationship for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "relationshipId",
"description": "The relationship id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a relationship get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Relationship"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update a relationship for an item",
"summary": "Update a relationship for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "relationshipId",
"description": "The relationship id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Update a relationship for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RelationshipUpdateRequest"
}
}
}
}
}
},
"/auditable-item-graph": {
"get": {
"operationId": "Full text search for items",
"summary": "Full text search for items",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "search",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to list items request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/blob": {
"post": {
"operationId": "Add a blob to an item",
"summary": "Add a blob to an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response from adding a blob to an item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlobAddResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Add a blob to an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlobAddRequest"
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/blob/{blobId}": {
"put": {
"operationId": "Update a blob for an item",
"summary": "Update a blob for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "blobId",
"description": "The blob id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response from updating a blob to an item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlobUpdateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Update a blob for an item.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlobUpdateRequest"
}
}
}
}
},
"get": {
"operationId": "Get a blob for an item",
"summary": "Get a blob for an item",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "blobId",
"description": "The blob id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "revision",
"description": "Optional revison, index 0 for the original to n revisions.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a blob get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlobGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/blob/{blobId}/url": {
"get": {
"operationId": "Get a url to view a blob",
"summary": "Get a url to view a blob",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "blobId",
"description": "The blob id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "revision",
"description": "Optional revison, index 0 for the original to n revisions.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "inline",
"description": "Return the content as inline.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a blob get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlobUrlResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
},
"503": {
"description": "The service you requested it currently unavailable, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/blob/{blobId}/view": {
"get": {
"operationId": "View the blob",
"summary": "View the blob",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "blobId",
"description": "The blob id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "revision",
"description": "Optional revison, index 0 for the original to n revisions.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "inline",
"description": "Return the content as inline.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The mime type may differ depending on the actual mime type of the blob",
"content": {
"application/octet": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
}
},
"/auditable-item-graph/item/{itemId}/json-ld": {
"get": {
"operationId": "Get the item properties as JSON LD",
"summary": "Get the item properties as JSON LD",
"tags": [
"Auditable Item Graph"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a Json LD get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonLdObject"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
}
}
},
"/logger": {
"post": {
"operationId": "Create a log entry",
"summary": "Create a log entry",
"tags": [
"Logger"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new log entry.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogEntry"
}
}
}
}
},
"get": {
"operationId": "Get a list of the log entries",
"summary": "Get a list of the log entries",
"tags": [
"Logger"
],
"parameters": [
{
"name": "level",
"description": "The level of the log entries to retrieve.",
"in": "query",
"required": false,
"schema": {}
},
{
"name": "source",
"description": "The source of the log entries to retrieve.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "timeStart",
"description": "The start time of the metrics to retrieve.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "timeEnd",
"description": "The end time of the metrics to retrieve.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "cursor",
"description": "The optional cursor to get next chunk.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for log entry list request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoggerListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/indexing/alias": {
"post": {
"operationId": "Create an indexing alias",
"summary": "Create an indexing alias",
"tags": [
"Indexing"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new alias for a primary urn.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexingAliasCreateRequest"
}
}
}
}
},
"delete": {
"operationId": "Remove an indexing alias",
"summary": "Remove an indexing alias",
"tags": [
"Indexing"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Remove an alias for a primary urn.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexingAliasRemoveRequest"
}
}
}
}
},
"get": {
"operationId": "Search for an alias",
"summary": "Search for an alias",
"tags": [
"Indexing"
],
"parameters": [
{
"name": "search",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfstring"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/indexing/alias/{alias}": {
"get": {
"operationId": "Get an indexing alias",
"summary": "Get an indexing alias",
"tags": [
"Indexing"
],
"parameters": [
{
"name": "alias",
"description": "The alias to lookup.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for an indexing get alias request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IndexingAliasGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/counters": {
"post": {
"operationId": "Create a counter",
"summary": "Create a counter",
"tags": [
"Counters"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a counter creation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CounterCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new counter.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CounterCreateRequest"
}
}
}
}
}
},
"/counters/{id}": {
"delete": {
"operationId": "Remove a counter",
"summary": "Remove a counter",
"tags": [
"Counters"
],
"parameters": [
{
"name": "id",
"description": "The id of the counter to remove.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update a counter",
"summary": "Update a counter",
"tags": [
"Counters"
],
"parameters": [
{
"name": "id",
"description": "The id of the counter to update.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
},
"requestBody": {
"description": "Update a counter.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CounterUpdateRequest"
}
}
}
}
},
"get": {
"operationId": "Get a counter",
"summary": "Get a counter",
"tags": [
"Counters"
],
"parameters": [
{
"name": "id",
"description": "The id of the counter to get.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a counter get.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CounterGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/counters/{id}/reset": {
"put": {
"operationId": "Reset a counter",
"summary": "Reset a counter",
"tags": [
"Counters"
],
"parameters": [
{
"name": "id",
"description": "The id of the counter to reset.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/catalog-location": {
"post": {
"operationId": "Create a catalog entity.",
"summary": "Create a catalog entity.",
"tags": [
"Catalog Location"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Create an item in the catalog.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
}
},
"get": {
"operationId": "Get catalog entities by query.",
"summary": "Get catalog entities by query.",
"tags": [
"Catalog Location"
],
"parameters": [
{
"name": "latitude",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "longitude",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for a catalog entity query request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CatalogLocationFindResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/catalog-location/{id}": {
"get": {
"operationId": "Get an entity from the catalog.",
"summary": "Get an entity from the catalog.",
"tags": [
"Catalog Location"
],
"parameters": [
{
"name": "id",
"description": "The id to be used to get the entity.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for a catalog entity get request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update an entity in the catalog.",
"summary": "Update an entity in the catalog.",
"tags": [
"Catalog Location"
],
"parameters": [
{
"name": "id",
"description": "The id of the entity to update.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
},
"requestBody": {
"description": "Update an entity in the catalog.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
}
}
}
}
},
"delete": {
"operationId": "Remove an entity from the catalog.",
"summary": "Remove an entity from the catalog.",
"tags": [
"Catalog Location"
],
"parameters": [
{
"name": "id",
"description": "The id to be used to delete an entity.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/metrics": {
"post": {
"operationId": "Create a new metric",
"summary": "Create a new metric",
"tags": [
"Metrics"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new metric.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsCreateRequest"
}
}
}
}
},
"get": {
"operationId": "Get all the metrics with the filters specified",
"summary": "Get all the metrics with the filters specified",
"tags": [
"Metrics"
],
"parameters": [
{
"name": "component",
"description": "The component to get the metrics for.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "timeStart",
"description": "The start time of the metrics to retrieve.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "timeEnd",
"description": "The end time of the metrics to retrieve.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "type",
"description": "The type of the metrics to retrieve.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"description": "Cursor for paged lookups.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a metrics get.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/authentication/login/create": {
"post": {
"operationId": "Create a login with an identity",
"summary": "Create a login with an identity",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a create login request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to create a login.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginCreateRequest"
}
}
}
}
}
},
"/authentication/login/verify": {
"post": {
"operationId": "Send verification for a created login",
"summary": "Send verification for a created login",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to verify some login information.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginVerifySendRequest"
}
}
}
}
},
"get": {
"operationId": "Confirm verification details for a created login",
"summary": "Confirm verification details for a created login",
"tags": [
"Authentication"
],
"parameters": [
{
"name": "identity",
"description": "The identity verify the login with.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"description": "The type of verification being performed.",
"in": "query",
"required": false,
"schema": {}
},
{
"name": "confirm",
"description": "The data to confirm the verification.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/authentication/login/verify/check": {
"post": {
"operationId": "Check if a verification for a login is complete",
"summary": "Check if a verification for a login is complete",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to check if a verification has completed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginVerifyCheckResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to check if a verification has completed.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginVerifyCheckRequest"
}
}
}
}
}
},
"/authentication/login": {
"post": {
"operationId": "Login with an identity",
"summary": "Login with an identity",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a login request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to login.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
}
}
}
},
"/authentication/login/refresh": {
"post": {
"operationId": "Refresh the current login token",
"summary": "Refresh the current login token",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a refresh login.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRefreshResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to refresh with login.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRefreshRequest"
}
}
}
}
}
},
"/authentication/logout": {
"post": {
"operationId": "Logout the current identity",
"summary": "Logout the current identity",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to logout.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogoutRequest"
}
}
}
}
}
},
"/authentication/login/2fa/create": {
"post": {
"operationId": "Create two-factor authentication for a login",
"summary": "Create two-factor authentication for a login",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a create login request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginTwoFactorCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to create a login.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginTwoFactorCreateRequest"
}
}
}
}
}
},
"/authentication/login/2fa/toggle": {
"post": {
"operationId": "Enable or disable the two factor authentication",
"summary": "Enable or disable the two factor authentication",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to enable or disable two factor authentication.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginTwoFactorToggleRequest"
}
}
}
}
}
},
"/authentication/account/profile": {
"post": {
"operationId": "Update identity profile",
"summary": "Update identity profile",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update identity profile.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileUpdateRequest"
}
}
}
}
}
},
"/authentication/account/update/taxpin": {
"post": {
"operationId": "Update tax pin",
"summary": "Update tax pin",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update tax pin.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxPinUpdateRequest"
}
}
}
}
}
},
"/authentication/login/password": {
"post": {
"operationId": "Update the password for the login",
"summary": "Update the password for the login",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to enable or disable two factor authentication.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginTwoFactorToggleRequest"
}
}
}
}
}
},
"/authentication/token": {
"post": {
"operationId": "Create an authentication token",
"summary": "Create an authentication token",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The response to a create token request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to create an access token.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenCreateRequest"
}
}
}
}
}
},
"/authentication/token/{identity}/{id}": {
"delete": {
"operationId": "Revoke an authentication token",
"summary": "Revoke an authentication token",
"tags": [
"Authentication"
],
"parameters": [
{
"name": "identity",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "id",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/authentication/token/{identity}": {
"get": {
"operationId": "List the authentication tokens",
"summary": "List the authentication tokens",
"tags": [
"Authentication"
],
"parameters": [
{
"name": "identity",
"description": "The identity to list the tokens for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "cursor",
"description": "The cursor for paging.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a list token request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/authentication/invite/user": {
"post": {
"operationId": "Invite user to an organization",
"summary": "Invite user to an organization",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to send an email invite.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInviteRequest"
}
}
}
}
}
},
"/authentication/invite/revoke": {
"post": {
"operationId": "Revoke user invite",
"summary": "Revoke user invite",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Revoke invite request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevokeInviteRequest"
}
}
}
}
}
},
"/authentication/invite/authority": {
"post": {
"operationId": "Invite an autority to join TLIP",
"summary": "Invite an autority to join TLIP",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to invite an authority.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthorityInviteRequest"
}
}
}
}
}
},
"/authentication/organization/{identity}/pending-invites": {
"get": {
"operationId": "List pending user invites in an organization",
"summary": "List pending user invites in an organization",
"tags": [
"Authentication"
],
"parameters": [
{
"name": "identity",
"description": "The identity to get users for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "cursor",
"description": "The cursor for paged requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The request to list organization users.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOrganizationUsersResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/authentication/token/decode": {
"post": {
"operationId": "Decode an authentication token",
"summary": "Decode an authentication token",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Request to decode an access token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JwtToken"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to decode an access token.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenDecodeRequest"
}
}
}
}
}
},
"/authentication/account/send-password-reset": {
"post": {
"operationId": "Send password reset email",
"summary": "Send password reset email",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to send password reset email.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordResetEmailRequest"
}
}
}
}
}
},
"/authentication/account/reset-password": {
"post": {
"operationId": "Reset password",
"summary": "Reset password",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to reset password.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to reset password.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordRequest"
}
}
}
}
}
},
"/authentication/apiKey/{identity}": {
"get": {
"operationId": "Get organisation's api key",
"summary": "Get organisation's api key",
"tags": [
"Authentication"
],
"parameters": [
{
"name": "identity",
"description": "The identity to get api key for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The request to get an api key.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiKeyResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/authentication/account/profile/toggleStatus": {
"post": {
"operationId": "Activate/Deactivate profile",
"summary": "Activate/Deactivate profile",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Toggle profile request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToggleProfileRequest"
}
}
}
}
}
},
"/authentication/login/2fa/recovery": {
"post": {
"operationId": "Recover two-factor authentication for a login",
"summary": "Recover two-factor authentication for a login",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Recover 2fa.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwoFactorRecoveryRequest"
}
}
}
}
}
},
"/authentication/login/unlock": {
"post": {
"operationId": "Unlock an authentication account",
"summary": "Unlock an authentication account",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Unlock account request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockAuthAccountRequest"
}
}
}
}
}
},
"/authentication/sessions": {
"get": {
"operationId": "Get sessions",
"summary": "Get sessions",
"tags": [
"Authentication"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to get sessions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSessionsResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to get sessions.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSessionsRequest"
}
}
}
}
}
},
"/authentication/session/{sessionId}/remove": {
"delete": {
"operationId": "Remove session",
"summary": "Remove session",
"tags": [
"Authentication"
],
"parameters": [
{
"name": "sessionId",
"description": "The sessionId to remove a session.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity": {
"post": {
"operationId": "Create a new identity",
"summary": "Create a new identity",
"tags": [
"Identity"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Create a new identity.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new identity.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityCreateRequest"
}
}
}
}
}
},
"/identity/{identity}": {
"put": {
"operationId": "Update an identity",
"summary": "Update an identity",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity to update.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update an identity.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityUpdateRequest"
}
}
}
}
}
},
"/identity/profile/{identity}": {
"put": {
"operationId": "Set the profile for an identity",
"summary": "Set the profile for an identity",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity to update the profile.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to update a profile.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileSetRequest"
}
}
}
}
},
"get": {
"operationId": "Get the profile for an identity",
"summary": "Get the profile for an identity",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity to get the profile for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to get a profile.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Get the profile for an identity.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileGetRequest"
}
}
}
}
}
},
"/identity/organizations": {
"get": {
"operationId": "Get the list of organizations",
"summary": "Get the list of organizations",
"tags": [
"Identity"
],
"parameters": [
{
"name": "cursor",
"description": "The cursor for paged requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"description": "Number of items to return.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to get a list of organizations.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationsGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity/organization/{identity}/users": {
"get": {
"operationId": "Get the list of organization users",
"summary": "Get the list of organization users",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity of the organization.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "cursor",
"description": "The cursor for paged requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to get a list of organizations.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationsGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity/organization/{identity}": {
"get": {
"operationId": "Get an organization",
"summary": "Get an organization",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity of the organization.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to get an organization.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity/verifiable-credentials/requirements/{identity}/{verifiableCredentialType}": {
"put": {
"operationId": "Set the requirements for a verifiable credential",
"summary": "Set the requirements for a verifiable credential",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity of the verifiable credential requirements.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "verifiableCredentialType",
"description": "The type of verifiable credential requirements being stored.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to set the requirements for a verifiable credential.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifiableCredentialRequirementsSetRequest"
}
}
}
}
},
"get": {
"operationId": "Get the requirements for a verifiable credential",
"summary": "Get the requirements for a verifiable credential",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity of the verifiable credential requirements.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "verifiableCredentialType",
"description": "The type of verifiable credential requirements being requested.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to get the requirements for a verifiable credential.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifiableCredentialRequirementsGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity/verifiable-credentials": {
"post": {
"operationId": "Create a verifiable credential",
"summary": "Create a verifiable credential",
"tags": [
"Identity"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to creating a verifiable credential.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifiableCredentialCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a verifiable credential.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifiableCredentialCreateRequest"
}
}
}
}
}
},
"/identity/verifiable-credentials/applications/{identity}": {
"get": {
"operationId": "Get the verifiable credential applications for an identity",
"summary": "Get the verifiable credential applications for an identity",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity to get the verifiable credentials for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "identityIsIssuer",
"description": "The identity is the issuer not the subject.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "state",
"description": "The state of the verifiable credential applications to get.",
"in": "query",
"required": false,
"schema": {}
},
{
"name": "cursor",
"description": "The cursor for paged requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to get verifiable credential applications request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifiableCredentialApplicationsGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity/verifiable-credentials/{verifiableCredentialId}": {
"put": {
"operationId": "Update a verifiable credential",
"summary": "Update a verifiable credential",
"tags": [
"Identity"
],
"parameters": [
{
"name": "verifiableCredentialId",
"description": "The verifiable credential to update.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response to an update of a verifiable credential.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerifiableCredentialApplication"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update a verifiable credential.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifiableCredentialUpdateRequest"
}
}
}
}
},
"get": {
"operationId": "Get a verifiable credential",
"summary": "Get a verifiable credential",
"tags": [
"Identity"
],
"parameters": [
{
"name": "verifiableCredentialId",
"description": "The id of the verifiable credentials.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/identity/verifiable-credentials/check": {
"post": {
"operationId": "Check a verifiable credential",
"summary": "Check a verifiable credential",
"tags": [
"Identity"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to get verifiable credential applications request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DidCredentialVerification"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/identity/data/sign/{identity}": {
"post": {
"operationId": "Sign data with the verification method for an identity",
"summary": "Sign data with the verification method for an identity",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity to sign the data with.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a sign data request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignDataResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Sign the requested data.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignDataRequest"
}
}
}
}
}
},
"/identity/data/verify/{identity}": {
"post": {
"operationId": "Verify the data signed by an identity",
"summary": "Verify the data signed by an identity",
"tags": [
"Identity"
],
"parameters": [
{
"name": "identity",
"description": "The identity to verify the data for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a data verification request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyDataResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Verify some signed data.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyDataRequest"
}
}
}
}
}
},
"/document-management": {
"post": {
"operationId": "Create a signed document",
"summary": "Create a signed document",
"tags": [
"Document Management"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The response to a document management creation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentOverview"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new document.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementCreateRequest"
}
}
}
}
}
},
"/document-management/document/{documentId}": {
"put": {
"operationId": "Update and sign a document revision",
"summary": "Update and sign a document revision",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a document management creation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentOverview"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new document.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementCreateRequest"
}
}
}
}
},
"get": {
"operationId": "Verify a document and get its details",
"summary": "Verify a document and get its details",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "includeBytes",
"description": "Include the bytes in the response.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a document management verify request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementVerifyResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/document-management/document/{documentId}/revision/{revision}": {
"get": {
"operationId": "Verify a document revision and get its details",
"summary": "Verify a document revision and get its details",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "revision",
"description": "The document revision to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "includeBytes",
"description": "Include the bytes in the response.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "context",
"description": "Include the signatures in the response.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a document management verify request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementVerifyResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/document-management/identity/{identity}": {
"get": {
"operationId": "Get a list of all the documents for the identity",
"summary": "Get a list of all the documents for the identity",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "identity",
"description": "The identity to list the documents for.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to get the resources from.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"description": "Cursor for pages requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a document management list request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/document-management/document/{documentId}/url": {
"get": {
"operationId": "Get a view url for the document",
"summary": "Get a view url for the document",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inline",
"description": "Return the content as inline.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "ttl",
"description": "The TTL of the URL in milliseconds.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "revision",
"description": "The document version.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a document management url get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementViewUrlResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/document-management/document/{documentId}/view": {
"get": {
"operationId": "View the document",
"summary": "View the document",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to view.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inline",
"description": "Return the content as inline.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The mime type may differ depending on the actual mime type of the document",
"content": {
"application/octet": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/document-management/document/{documentId}/revision/{revision}/view": {
"get": {
"operationId": "View the document revision",
"summary": "View the document revision",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to view.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "revision",
"description": "The document revision to view.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inline",
"description": "Return the content as inline.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The mime type may differ depending on the actual mime type of the document",
"content": {
"application/octet": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/document-management/document/{documentId}/share": {
"post": {
"operationId": "Share the document via email",
"summary": "Share the document via email",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "documentType",
"description": "Document Type.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"description": "The revision of the document.",
"in": "query",
"required": false,
"schema": {
"type": [
"string",
"number"
]
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"202": {
"description": "The rest request ended in accepted response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementShareRequest"
}
}
}
}
}
},
"/document-management/document/{documentId}/share/view": {
"get": {
"operationId": "View shared document",
"summary": "View shared document",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "documentType",
"description": "Document Type.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"description": "The revision of the document.",
"in": "query",
"required": false,
"schema": {
"type": [
"string",
"number"
]
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Get the view data for the document.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementViewShareResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/document-management/document/{documentId}/sharing-url": {
"get": {
"operationId": "Generate document sharing url",
"summary": "Generate document sharing url",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "documentId",
"description": "The id of the document to verify.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "auditableItemGraphId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "documentType",
"description": "Document Type.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"description": "The revision of the document.",
"in": "query",
"required": false,
"schema": {
"type": [
"string",
"number"
]
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Interface to define the response to get document sharing url.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementSharingUrlResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/document-management/document/share-url": {
"get": {
"operationId": "Generate document sharing url with document type and item id",
"summary": "Generate document sharing url with document type and item id",
"tags": [
"Document Management"
],
"parameters": [
{
"name": "itemId",
"description": "Id for auditable item graph to add as a resource.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "documentType",
"description": "Document Type.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "revision",
"description": "The revision of the document.",
"in": "query",
"required": false,
"schema": {
"type": [
"string",
"number"
]
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Interface to define the response to get document sharing url.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentManagementShareUrlResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/inventory": {
"get": {
"operationId": "Get inventory",
"summary": "Get inventory",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "cursor",
"description": "Cursor for paged lookups.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"description": "The item status.",
"in": "query",
"required": false,
"schema": {}
},
{
"name": "location",
"description": "The item location.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "groupBy",
"description": "The items grouping.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "itemId",
"description": "The item id.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Interface describing inventory get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/inventory/items/{itemId}": {
"get": {
"operationId": "Get item inventory",
"summary": "Get item inventory",
"tags": [
"Inventory"
],
"parameters": [
{
"name": "itemId",
"description": "The item id.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Interface for Item Inventory get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryEntity"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/signup": {
"post": {
"operationId": "Create a login with an identity",
"summary": "Create a login with an identity",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a create login request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to create a login.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginCreateRequest"
}
}
}
}
}
},
"/tlip/login": {
"post": {
"operationId": "Login with an identity",
"summary": "Login with an identity",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a login request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Request to login.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
}
}
}
},
"/tlip/consignment": {
"post": {
"operationId": "Create a new consignment",
"summary": "Create a new consignment",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a consignment creation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentCreateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create a new consignment.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentCreateRequest"
}
}
}
}
}
},
"/tlip/consignments/{itemId}/items": {
"post": {
"operationId": "Add consignments or commodities to a consignment",
"summary": "Add consignments or commodities to a consignment",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the consignment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Add alias id to a consignment.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentAddItemsRequest"
}
}
}
}
}
},
"/tlip/consignments/{itemId}/add": {
"post": {
"operationId": "Add shared or existing consignments to a shipment.",
"summary": "Add shared or existing consignments to a shipment.",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the consignment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Add consignments to a shipment.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentsAddRequest"
}
}
}
}
}
},
"/tlip/consignments/{consignmentId}": {
"get": {
"operationId": "Get a consignment",
"summary": "Get a consignment",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "consignmentId",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "globalId",
"description": "The consignment global identification id. Consignment UCR as per WCO standard.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "customsId",
"description": "The consignment customs declaration identification id. Consignment customs declaration number as per WCO standard.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Consignment get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonLdObject"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/consignments/{consignmentId}/json-ld": {
"get": {
"operationId": "Get a consignment as JSON-LD",
"summary": "Get a consignment as JSON-LD",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "consignmentId",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The details for a Json LD get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonLdObject"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/consignments/{itemId}/identifiers": {
"post": {
"operationId": "Add an identifier to a consignment",
"summary": "Add an identifier to a consignment",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the consignment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Add alias id to a consignment.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentAddIdentifierRequest"
}
}
}
}
}
},
"/tlip/consignments": {
"get": {
"operationId": "Get consignments",
"summary": "Get consignments",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/consignment/{consignmentId}/document/{documentType}": {
"put": {
"operationId": "Upload and associate a binary document with a consignment",
"summary": "Upload and associate a binary document with a consignment",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "consignmentId",
"description": "The consignment id or alias.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "documentType",
"description": "The type of document being stored.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to a document upload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentDocumentCreateUpdateResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Create or update a consignment document.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentDocumentCreateUpdateRequest"
}
}
}
}
}
},
"/tlip/consignments/{itemId}/update": {
"post": {
"operationId": "Update Consignment",
"summary": "Update Consignment",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "itemId",
"description": "The id of the consignment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
},
"requestBody": {
"description": "Update consignment.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsignmentUpdateRequest"
}
}
}
}
}
},
"/tlip/identifier-types": {
"post": {
"operationId": "Add an identifier type",
"summary": "Add an identifier type",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Add identifier type to entity storage.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentifierType"
}
}
}
}
},
"get": {
"operationId": "List identifier types",
"summary": "List identifier types",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "search",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The identifier types list response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentifierTypesListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/document-types": {
"post": {
"operationId": "Add document type",
"summary": "Add document type",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Update document type in entity storage.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentType"
}
}
}
}
},
"get": {
"operationId": "List of document types",
"summary": "List of document types",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "nextPageCursor",
"description": "The cursor offset to get identitifer types from.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "search",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Document types list response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentTypesListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/identifier-types/{code}": {
"put": {
"operationId": "Update identifier type",
"summary": "Update identifier type",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "code",
"description": "The code of the identifier type.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update identifier type in entity storage.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentifierType"
}
}
}
}
},
"delete": {
"operationId": "Delete identifier type",
"summary": "Delete identifier type",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "code",
"description": "The code of the identifier type.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/document-types/{code}": {
"put": {
"operationId": "Update document type",
"summary": "Update document type",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "code",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update document type in entity storage.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentType"
}
}
}
}
}
},
"/tlip/document-types/{id}": {
"delete": {
"operationId": "Delete a document type",
"summary": "Delete a document type",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "id",
"description": "The id of the document type locally defined by TLIP.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/event-types": {
"post": {
"operationId": "Add an event type",
"summary": "Add an event type",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "Add event type to entity storage.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TLIPEventType"
}
}
}
}
},
"get": {
"operationId": "List event types",
"summary": "List event types",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "nextPageCursor",
"description": "The cursor offset to get event types from.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "search",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The event types list response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypesListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/event-types/{id}": {
"put": {
"operationId": "Update event type",
"summary": "Update event type",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "id",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Add event type to entity storage.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TLIPEventType"
}
}
}
}
},
"delete": {
"operationId": "Delete event type",
"summary": "Delete event type",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "id",
"description": "The id of the event type.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/consignments/{consignmentId}/events": {
"post": {
"operationId": "Add an event",
"summary": "Add an event",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "consignmentId",
"description": "Id of the consignment to add events to.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"422": {
"description": "The operation could not be processed, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnprocessableEntityResponse"
}
}
}
}
},
"requestBody": {
"description": "The event request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleEventData"
}
}
}
}
},
"get": {
"operationId": "List events",
"summary": "List events",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "consignmentId",
"description": "The id of the consignment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response of list events.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventsListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/consignments/{consignmentId}/documents": {
"get": {
"operationId": "List documents",
"summary": "List documents",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "consignmentId",
"description": "The id of the consignment.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "List documents response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentsListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/users": {
"get": {
"operationId": "List organization users",
"summary": "List organization users",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "cursor",
"description": "The cursor for paged requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to list organization users.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationUsersListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/matrix-display": {
"get": {
"operationId": "Get display matrix",
"summary": "Get display matrix",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The response to get display matrix.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MatrixDisplayGetResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "The request to get display matrix.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MatrixDisplayGetRequest"
}
}
}
}
}
},
"/tlip/health": {
"get": {
"operationId": "Check the health of services that tlip depend on",
"summary": "Check the health of services that tlip depend on",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Health check response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheckServices"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/consignment/search": {
"get": {
"operationId": "Full text search for consignments",
"summary": "Full text search for consignments",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "value",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/access-groups": {
"post": {
"operationId": "Add an access group",
"summary": "Add an access group",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Add access group.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessGroup"
}
}
}
}
},
"get": {
"operationId": "List access groups",
"summary": "List access groups",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "The rest request ended in success with no data.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
}
}
},
"/tlip/access-groups/{name}": {
"put": {
"operationId": "Update an access group",
"summary": "Update an access group",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "name",
"description": "Name of the access group.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Update access group.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessGroup"
}
}
}
}
},
"delete": {
"operationId": "Delete an access group",
"summary": "Delete an access group",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "name",
"description": "Name of the access group.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip/access-groups/{name}/add": {
"put": {
"operationId": "Add profile to an access group",
"summary": "Add profile to an access group",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "name",
"description": "Name of the access group..",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Modify access request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyAccessToGroupRequest"
}
}
}
}
}
},
"/tlip/access-groups/{name}/remove": {
"put": {
"operationId": "Remove profile from an access group",
"summary": "Remove profile from an access group",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "name",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Modify access request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyAccessToGroupRequest"
}
}
}
}
}
},
"/tlip/activity-logs": {
"get": {
"operationId": "List organization activity logs",
"summary": "List organization activity logs",
"tags": [
"TLIP"
],
"parameters": [
{
"name": "nextPageCursor",
"description": "The cursor offset to get identitifer types from.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"description": "Maximum mumber of items to return per page.",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "search",
"description": "The search string.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "includeBytes",
"description": "Include the bytes in the response.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for getting organization activity logs.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityLogs"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip/attest": {
"post": {
"operationId": "Attest credential",
"summary": "Attest credential",
"tags": [
"TLIP"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Attest response interface.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttestResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Attest request interface.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttestRequest"
}
}
}
}
}
},
"/simple-event-repository/events/{id}": {
"get": {
"operationId": "Get Event By Id",
"summary": "Get Event By Id",
"tags": [
"SimpleEvents"
],
"parameters": [
{
"name": "id",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"name": "eventId",
"description": "Event Id.",
"in": "query",
"required": false,
"schema": {}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Response for getting event by id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleEvent"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/simple-event-repository/events": {
"get": {
"operationId": "Get Events",
"summary": "Get Events",
"tags": [
"SimpleEvents"
],
"parameters": [
{
"name": "itemId",
"description": "Item Id.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfSimpleEvent"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
},
"post": {
"operationId": "Capture an event",
"summary": "Capture an event",
"tags": [
"SimpleEvents"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "Simple Event.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleEvent"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Simple Event.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimpleEventData"
}
}
}
}
}
},
"/tlip-connector/notify": {
"post": {
"operationId": "Webhook notification endpoint",
"summary": "Webhook notification endpoint",
"tags": [
"TLIP Connector"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"202": {
"description": "The rest request ended in accepted response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Activity Stream interface.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityStream"
}
}
}
}
}
},
"/tlip-connector/activity-logs/{logEntryId}": {
"get": {
"operationId": "Get Activity Log Entry",
"summary": "Get Activity Log Entry",
"tags": [
"TLIP Connector"
],
"parameters": [
{
"name": "logEntryId",
"description": "The id for the Activity Log Entry.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "An Activity Log Entry to allow TLIP Connector clients to know the status of activity processing.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobDetails"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip-connector/consignment-documents": {
"get": {
"operationId": "Get Consignment Document",
"summary": "Get Consignment Document",
"tags": [
"TLIP Connector"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Consignment document get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RevisionOverviewHarmonized"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip-connector/activity-logs": {
"get": {
"operationId": "List Activity Log Entries",
"summary": "List Activity Log Entries",
"tags": [
"TLIP Connector"
],
"parameters": [
{
"name": "status",
"description": "Job statuses.",
"in": "query",
"required": false,
"schema": {}
},
{
"name": "cursor",
"description": "The cursor for paged requests.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Get the details for an item.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobDetailsListResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/tlip-connector/consignments": {
"get": {
"operationId": "Get consignment as JSON-LD",
"summary": "Get consignment as JSON-LD",
"tags": [
"TLIP Connector"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "Consignment get response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonLdObject"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
}
}
},
"/tlip-connector/subscriptions": {
"post": {
"operationId": "Control Plane - Subscription",
"summary": "Control Plane - Subscription",
"tags": [
"TLIP Connector"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"201": {
"description": "The rest request ended in accepted response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"409": {
"description": "The request resulted in a conflicting operation, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictResponse"
}
}
}
}
},
"requestBody": {
"description": "Activity Stream interface for a subscription.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
}
}
},
"/platform-directory/system": {
"post": {
"operationId": "Register system",
"summary": "Register system",
"tags": [
"Platform Directory"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Register system request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterSystemRequest"
}
}
}
}
}
},
"/platform-directory/system/{identity}": {
"delete": {
"operationId": "Unregister system",
"summary": "Unregister system",
"tags": [
"Platform Directory"
],
"parameters": [
{
"name": "identity",
"description": "The identity to the system to remove.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
},
"put": {
"operationId": "Update system",
"summary": "Update system",
"tags": [
"Platform Directory"
],
"parameters": [
{
"name": "identity",
"description": "The identity of the system to update.",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"404": {
"description": "The resource you tried to access does not exist, see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
}
},
"requestBody": {
"description": "Update system request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSystemRequest"
}
}
}
}
}
},
"/platform-directory/peers/{identity}": {
"delete": {
"operationId": "Remove a peer",
"summary": "Remove a peer",
"tags": [
"Platform Directory"
],
"parameters": [
{
"name": "identity",
"description": "",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
}
}
},
"/platform-directory/process-access": {
"post": {
"operationId": "Process access",
"summary": "Process access",
"tags": [
"Platform Directory"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Process access request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessAccessRequest"
}
}
}
}
}
},
"/platform-directory/request-access": {
"post": {
"operationId": "Request access",
"summary": "Request access",
"tags": [
"Platform Directory"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Access request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessRequest"
}
}
}
}
}
},
"/platform-directory/accept-request": {
"post": {
"operationId": "Accept access",
"summary": "Accept access",
"tags": [
"Platform Directory"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Access request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessRequest"
}
}
}
}
}
},
"/platform-directory/peers": {
"post": {
"operationId": "Peer access",
"summary": "Peer access",
"tags": [
"Platform Directory"
],
"security": [
{
"apiKeyQueryAuthScheme": []
},
{
"apiKeyHeaderAuthScheme": []
},
{
"jwtBearerAuthScheme": []
},
{
"jwtCookieAuthScheme": []
}
],
"responses": {
"200": {
"description": "The rest request ended in created response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedResponse"
}
}
}
},
"204": {
"description": "The rest request ended in success with no data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoContentResponse"
}
}
}
},
"400": {
"description": "Something went wrong with the request see the error field for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "You are not authorized to use the API or no credentials were supplied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
}
},
"requestBody": {
"description": "Access request.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessRequest"
}
}
}
}
}
}
},
"components": {
"schemas": {
"SuccessResponse": {
"type": "object",
"additionalProperties": false,
"description": "The rest request ended in success with no data."
},
"CreatedResponse": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Alternative response status code."
},
"headers": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The location where the resource was created."
}
},
"required": [
"location"
],
"additionalProperties": false,
"description": "Additional response headers."
}
},
"required": [
"statusCode",
"headers"
],
"additionalProperties": false,
"description": "The rest request ended in created response."
},
"AcceptedResponse": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Alternative response status code."
},
"headers": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The location where the resource was accepted."
}
},
"required": [
"location"
],
"additionalProperties": false,
"description": "Additional response headers."
},
"data": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Document url for the consignment."
}
},
"additionalProperties": false,
"description": "Response Data."
}
},
"required": [
"statusCode",
"headers"
],
"additionalProperties": false,
"description": "The rest request ended in accepted response."
},
"NoContentResponse": {
"type": "object",
"additionalProperties": false,
"description": "The rest request ended in success with no data."
},
"BadRequestResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"type": "string",
"description": "A message for the response."
}
},
"description": "Something went wrong with the request see the error field for more details."
},
"UnauthorizedResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"type": "string",
"description": "A message for the response."
}
},
"description": "You are not authorized to use the API or no credentials were supplied."
},
"NotFoundResponse": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "A message for the response."
},
"notFoundId": {
"type": "string",
"description": "The id if the item that was not found."
}
},
"additionalProperties": false,
"description": "The resource you tried to access does not exist, see the error field for more details."
},
"ConflictResponse": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "A message for the response."
},
"conflicts": {
"type": "array",
"items": {
"type": "string"
},
"description": "The conflicting items."
}
},
"required": [
"conflicts"
],
"additionalProperties": false,
"description": "The request resulted in a conflicting operation, see the error field for more details."
},
"UnprocessableEntityResponse": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "A message for the response."
},
"existingId": {
"type": "string",
"description": "The id which caused the unprocessable entity response."
}
},
"additionalProperties": false,
"description": "The operation could not be processed, see the error field for more details."
},
"ServiceUnavailableResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"type": "string",
"description": "A message for the response."
}
},
"description": "The service you requested it currently unavailable, see the error field for more details."
},
"ItemListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemOverview"
},
"description": "The list of items."
},
"cursor": {
"type": "string",
"description": "Cursor for a multi page request."
},
"pageSize": {
"type": "number",
"description": "Maximum mumber of items to return per page."
},
"totalItems": {
"type": "number",
"description": "The length of the total items."
}
},
"required": [
"items",
"totalItems"
],
"additionalProperties": false,
"description": "The response payload."
},
"ItemOverview": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the item."
},
"created": {
"type": "number",
"description": "Timestamp of when the item was created."
},
"updated": {
"type": "number",
"description": "Timestamp of when the item was last updated."
},
"blobUrn": {
"type": "string",
"description": "The urn to use to retrieve the blob."
},
"creator": {
"type": "string",
"description": "A identity of the creator."
},
"tenantId": {
"type": "string",
"description": "The tenant Id."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the item."
}
},
"required": [
"id",
"created",
"updated"
],
"additionalProperties": false,
"description": "Interface representing an item."
},
"Property": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key for the item."
},
"type": {
"type": "string",
"description": "The type for the item as a urn."
},
"value": {
"description": "The value for the item."
}
},
"required": [
"key",
"type",
"value"
],
"additionalProperties": false,
"description": "Interface describing a property."
},
"ItemCreateRequest": {
"type": "object",
"properties": {
"itemId": {
"type": "string",
"description": "The primary id for the item."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Additional properties for the item."
},
"aliasIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AliasId"
},
"description": "Alias Ids for the item."
}
},
"required": [
"itemId"
],
"additionalProperties": false,
"description": "The data to be used in the create."
},
"AliasId": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id for the alias."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the alias."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Interface describing a alias."
},
"Item": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the item."
},
"created": {
"type": "number",
"description": "Timestamp of when the item was created."
},
"updated": {
"type": "number",
"description": "Timestamp of when the item was last updated."
},
"blobUrn": {
"type": "string",
"description": "The urn to use to retrieve the blob."
},
"creator": {
"type": "string",
"description": "A identity of the creator."
},
"tenantId": {
"type": "string",
"description": "The tenant Id."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the item."
},
"aliasIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AliasId"
},
"description": "Alias identifiers for the item."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
},
"description": "A list of resources associated with the item."
},
"relationships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Relationship"
},
"description": "A list of relationships for the item."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
},
"description": "The permissions for the item."
}
},
"additionalProperties": false,
"required": [
"created",
"id",
"updated"
],
"description": "Interface representing an item."
},
"Resource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id for the resource."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the resource."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Interface describing a resource."
},
"Relationship": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the item being related to."
},
"type": {
"$ref": "#/components/schemas/RelationshipType"
},
"start": {
"type": "number",
"description": "A timestamp for when the relationship was made."
},
"end": {
"type": "number",
"description": "A timestamp for when the relationship was removed, empty if still related."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the relationship."
}
},
"required": [
"id",
"type",
"start"
],
"additionalProperties": false,
"description": "Interface describing a relationship."
},
"RelationshipType": {
"type": "string",
"enum": [
"child",
"parent",
"inherits"
],
"description": "Types for the relationships."
},
"Permission": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity to grant permission to."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionProperty"
},
"description": "The properties of the permission."
}
},
"required": [
"identity",
"properties"
],
"additionalProperties": false,
"description": "Interface for Permission."
},
"PermissionProperty": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the property."
},
"value": {
"description": "The value of the property."
},
"ttl": {
"type": "number",
"description": "The ttl of the property."
}
},
"required": [
"type",
"value"
],
"additionalProperties": false,
"description": "Permission property interface."
},
"ItemUpdatePermissionRequest": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionProperty"
},
"description": "The permission properties."
}
},
"required": [
"properties"
],
"additionalProperties": false,
"description": "The data to be used to create the permission."
},
"ItemHistoryResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
},
"description": "The items in the history."
},
"totalItems": {
"type": "number",
"description": "The total number of items in the history."
},
"cursor": {
"type": "string",
"description": "Cursor to use to get next chunk."
}
},
"required": [
"items",
"totalItems"
],
"additionalProperties": false,
"description": "The response payload."
},
"ItemUpdateRequest": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Additional properties for the item."
},
"aliasIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AliasId"
},
"description": "Updated aliases for the item."
}
},
"additionalProperties": false,
"description": "The data to be used in the update."
},
"ResourceGetResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id for the resource."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties values for the resource."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "The response payload."
},
"AliasIdUpdateRequest": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the alias id."
}
},
"additionalProperties": false,
"description": "The data to be used in the update."
},
"AliasIdMergeRequest": {
"type": "object",
"properties": {
"aliasIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AliasId"
},
"description": "List of alias ids to merge."
}
},
"additionalProperties": false,
"description": "The data to be used in the update."
},
"ResourceListResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
},
"description": "The item resources."
},
"ResourceAddRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The resource id."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The resource properties."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "The data to be used in the add."
},
"ResourceUpdateRequest": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The resource properties."
}
},
"additionalProperties": false,
"description": "The data to be used in the update."
},
"RelationshipUpdateRequest": {
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "The relationship start timestamp."
},
"end": {
"type": "number",
"description": "The relationship end timestamp."
},
"type": {
"$ref": "#/components/schemas/RelationshipType"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties for the relationship."
}
},
"required": [
"start",
"type"
],
"additionalProperties": false,
"description": "The data to be used in the update."
},
"RelationshipListResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Relationship"
},
"description": "The item relationships."
},
"BlobAddRequest": {
"type": "object",
"properties": {
"blobId": {
"type": "string",
"description": "The blob id."
},
"blob": {
"type": "string",
"description": "The data encoded as base64."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The resource properties."
}
},
"required": [
"blobId",
"blob"
],
"additionalProperties": false,
"description": "The data to be used in the add."
},
"BlobAddResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The updated properties."
},
"BlobUpdateRequest": {
"type": "object",
"properties": {
"blob": {
"type": "string",
"description": "The data encoded as base64."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The resource properties."
}
},
"additionalProperties": false,
"description": "The data to be used in the add."
},
"BlobUpdateResponse": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The updated properties."
},
"revisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlobRevision"
},
"description": "List of additional revisions values for the blob."
}
},
"additionalProperties": false,
"description": "The response payload."
},
"BlobRevision": {
"type": "object",
"properties": {
"storageId": {
"type": "string",
"description": "The storage id for the item."
},
"fingerPrint": {
"type": "string",
"description": "The finger print for the item."
},
"ts": {
"type": "number",
"description": "The timestamp for the item."
},
"blobSize": {
"type": "number",
"description": "The size for the item."
},
"mimeType": {
"type": "string",
"description": "The mime type for the item."
},
"reason": {
"type": "string",
"description": "The reason the document was updated."
}
},
"required": [
"storageId",
"fingerPrint",
"ts",
"blobSize",
"mimeType"
],
"additionalProperties": false,
"description": "Interface describing a blob revision."
},
"BlobGetResponse": {
"type": "object",
"properties": {
"blob": {
"type": "string",
"description": "The base64 data for the blob."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "List of additional properties values for the blob."
},
"revisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlobRevision"
},
"description": "List of additional revisions values for the blob."
}
},
"required": [
"blob"
],
"additionalProperties": false,
"description": "The response payload."
},
"BlobUrlResponse": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The url to view the blob."
}
},
"required": [
"url"
],
"additionalProperties": false,
"description": "The response payload."
},
"JsonLdObject": {
"type": "object",
"additionalProperties": {},
"properties": {
"@context": {
"$ref": "#/components/schemas/LdContext"
},
"type": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"id": {
"type": "string"
}
},
"required": [
"@context",
"id",
"type"
],
"description": "JSON-LD document."
},
"LdContext": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": {}
}
]
}
}
],
"description": "JSON-LD @context."
},
"LogEntry": {
"type": "object",
"properties": {
"level": {
"$ref": "#/components/schemas/LogLevel"
},
"source": {
"type": "string",
"description": "The source of the log entry."
},
"ts": {
"type": "number",
"description": "The timestamp of the log entry."
},
"message": {
"type": "string",
"description": "The message."
},
"error": {
"description": "Optional error details."
},
"data": {
"description": "Optional data for the message."
}
},
"required": [
"level",
"source",
"ts",
"message"
],
"additionalProperties": false,
"description": "Interface describing a log entry."
},
"LogLevel": {
"type": "string",
"enum": [
"info",
"warn",
"error"
],
"description": "Log level."
},
"LoggerListResponse": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogEntry"
},
"description": "The log entries."
},
"cursor": {
"type": "string",
"description": "The cursor for the next chunk."
}
},
"required": [
"entries"
],
"additionalProperties": false,
"description": "The response payload."
},
"IndexingAliasCreateRequest": {
"type": "object",
"properties": {
"primaryUrn": {
"type": "string",
"description": "The primary urn to alias."
},
"aliasUrn": {
"type": "string",
"description": "The alias urn to assign to the primary urn."
}
},
"required": [
"primaryUrn",
"aliasUrn"
],
"additionalProperties": false,
"description": "The data to be used in the create."
},
"IndexingAliasRemoveRequest": {
"type": "object",
"properties": {
"primaryUrn": {
"type": "string",
"description": "The primary urn for which to remove the alias."
},
"aliasUrn": {
"type": "string",
"description": "The alias urn to disassociate with the primary urn."
}
},
"required": [
"primaryUrn",
"aliasUrn"
],
"additionalProperties": false,
"description": "The data to be used in the removal."
},
"IndexingAliasGetResponse": {
"type": "object",
"properties": {
"indexes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The indexes the alias points to."
}
},
"required": [
"indexes"
],
"additionalProperties": false,
"description": "The response payload."
},
"CounterCreateRequest": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value."
}
},
"required": [
"value"
],
"additionalProperties": false,
"description": "The data to be used in the create."
},
"CounterCreateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the counter created."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "The response payload."
},
"CounterUpdateRequest": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount to update the value."
}
},
"required": [
"amount"
],
"additionalProperties": false,
"description": "The data to be used in the update."
},
"CounterGetResponse": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the counter."
}
},
"required": [
"value"
],
"additionalProperties": false,
"description": "The data for the response."
},
"Location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The GS1 sgln identifier."
},
"site": {
"type": "string",
"description": "Identifies the site in which the location is contained."
},
"sst": {
"$ref": "#/components/schemas/SubSiteTypes"
},
"ssa": {
"$ref": "#/components/schemas/SubSiteAttributes"
},
"ssd": {
"type": "string",
"description": "Sub site detail provides additional proprietary information."
},
"name": {
"type": "string",
"description": "The name of the location."
},
"streetAddressOne": {
"type": "string",
"description": "The street address line 1."
},
"streetAddressTwo": {
"type": "string",
"description": "The street address line 2."
},
"streetAddressThree": {
"type": "string",
"description": "The street address line 3."
},
"city": {
"type": "string",
"description": "City."
},
"state": {
"type": "string",
"description": "State."
},
"postalCode": {
"type": "string",
"description": "Postal Code."
},
"countryCode": {
"type": "string",
"description": "Country Code The ISO 3166-1 alpha-2 code specifying the country for the address."
},
"latitude": {
"type": "number",
"description": "The latitude of the location in degrees."
},
"longitude": {
"type": "number",
"description": "The longitude of the location in degrees."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "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 ."
},
"SubSiteTypes": {
"type": "string",
"enum": [
"201",
"202",
"203",
"207",
"208",
"209",
"210",
"211",
"212",
"213",
"214",
"215",
"251",
"252",
"253",
"299"
],
"description": "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 ."
},
"SubSiteAttributes": {
"type": "string",
"enum": [
"401",
"402",
"403",
"404",
"405",
"406",
"407",
"408",
"409",
"411",
"412",
"413",
"414",
"415",
"416",
"417",
"418",
"419",
"420",
"421",
"422",
"423",
"424",
"425",
"426",
"427",
"428",
"429",
"431",
"432",
"433",
"434"
],
"description": "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 ."
},
"CatalogLocationFindResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
},
"description": "The list of items."
},
"cursor": {
"type": "string",
"description": "Cursor for a multi page request."
}
},
"required": [
"items"
],
"additionalProperties": false,
"description": "The response payload."
},
"MetricsCreateRequest": {
"type": "object",
"properties": {
"component": {
"type": "string",
"description": "The component reporting its metrics."
},
"ts": {
"type": "number",
"description": "The timestamp for the report."
},
"type": {
"type": "string",
"description": "The type for the metric."
},
"data": {
"description": "The data for the metric."
},
"tenantId": {
"type": "string",
"description": "Optional tenantId when included."
}
},
"required": [
"component",
"ts",
"type"
],
"additionalProperties": false,
"description": "The data to be used in the create."
},
"MetricsGetResponse": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponentMetric"
},
"description": "The metrics."
},
"cursor": {
"type": "string",
"description": "Cursor for paged lookups."
}
},
"required": [
"metrics"
],
"additionalProperties": false,
"description": "The response payload."
},
"ComponentMetric": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id for the entry."
},
"component": {
"type": "string",
"description": "The component reporting its metrics."
},
"ts": {
"type": "number",
"description": "The timestamp for the report."
},
"type": {
"type": "string",
"description": "The type for the metric."
},
"data": {
"description": "The data for the metric."
},
"tenantId": {
"type": "string",
"description": "Optional tenantId when included."
}
},
"required": [
"id",
"component",
"ts",
"type"
],
"additionalProperties": false,
"description": "Details of a metric for a component."
},
"LoginCreateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"emailAddress": {
"type": "string",
"description": "The email address to create the login with."
},
"password": {
"type": "string",
"description": "The password to create login with."
},
"role": {
"$ref": "#/components/schemas/IdentityRole"
},
"verifyEmail": {
"type": "boolean",
"description": "Whether to send email verification or not."
},
"organizationId": {
"type": "string",
"description": "The identity of the organization."
},
"identity": {
"type": "string",
"description": "Pre-created Identity."
},
"verMethodKeyPair": {
"type": "object",
"properties": {
"privateKey": {
"type": "string"
},
"publicKey": {
"type": "string"
}
},
"required": [
"privateKey",
"publicKey"
],
"additionalProperties": false,
"description": "Keypair of the default Verification method associated with the identity."
}
},
"required": [
"emailAddress",
"password",
"role",
"verifyEmail"
],
"additionalProperties": false,
"description": "The data for the request."
},
"IdentityRole": {
"type": "string",
"enum": [
"organization",
"user",
"system",
"borderAgent"
],
"description": "The roles that an identity can have."
},
"LoginCreateResponse": {
"type": "object",
"properties": {
"recoveryPhrase": {
"type": "string",
"description": "The recovery phrase used to regenerate the identity."
},
"identity": {
"type": "string",
"description": "The identity."
},
"publicKey": {
"type": "string",
"description": "The public key for the identity."
},
"privateKey": {
"type": "string",
"description": "The private key for the identity."
},
"token": {
"type": "string",
"description": "The auth token for future requests."
}
},
"required": [
"recoveryPhrase",
"identity",
"publicKey",
"privateKey"
],
"additionalProperties": false,
"description": "The response payload."
},
"LoginVerifySendRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity verify the login with."
},
"verificationType": {
"$ref": "#/components/schemas/VerificationType"
}
},
"required": [
"identity",
"verificationType"
],
"additionalProperties": false,
"description": "The data for the request."
},
"VerificationType": {
"type": "string",
"enum": [
"email",
"not-used"
],
"description": "The verification types."
},
"LoginVerifyCheckRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity verify the login with."
},
"verificationType": {
"$ref": "#/components/schemas/VerificationType"
}
},
"required": [
"identity",
"verificationType"
],
"additionalProperties": false,
"description": "The data for the request."
},
"LoginVerifyCheckResponse": {
"type": "object",
"properties": {
"verified": {
"type": "boolean",
"description": "The verification is complete."
}
},
"required": [
"verified"
],
"additionalProperties": false,
"description": "The response payload."
},
"LoginRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The email address to login with."
},
"passwordHash": {
"type": "string",
"description": "The hash of the password to login with."
},
"pin": {
"type": "string",
"description": "The two factor authentication pin if required."
}
},
"required": [
"emailAddress",
"passwordHash"
],
"additionalProperties": false,
"description": "The data for the request."
},
"LoginResponse": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity associated with the login."
},
"twoFactorRequired": {
"type": "boolean",
"description": "Is the two factor authentication required."
},
"twoFactorEnabled": {
"type": "boolean",
"description": "Is the two factor authentication enabled."
},
"verifiedEmail": {
"type": "boolean",
"description": "Is this email address verified."
},
"token": {
"type": "string",
"description": "The auth token to use in future requests."
},
"accessGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessGroup"
},
"description": "List of access groups the user belongs to."
},
"sessionId": {
"type": "string"
}
},
"additionalProperties": false,
"description": "The response payload."
},
"AccessGroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the access group."
},
"accessRights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessRight"
},
"description": "List of access accessRight."
},
"identities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identities of profiles in the group."
},
"description": {
"type": "string",
"description": "Optional group description."
}
},
"required": [
"name",
"accessRights"
],
"additionalProperties": false,
"description": "Interface for Access group."
},
"AccessRight": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/PermissionType"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionProperty"
},
"description": "The properties of the accessRight."
}
},
"required": [
"type",
"properties"
],
"additionalProperties": false,
"description": "Interface for IAccessRight."
},
"PermissionType": {
"type": "string",
"enum": [
"READ",
"WRITE",
"SHARE"
],
"description": "Permission type enum."
},
"LoginRefreshRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity being refreshed."
}
},
"required": [
"identity"
],
"additionalProperties": false,
"description": "The data for the request."
},
"LoginRefreshResponse": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity associated with the login."
},
"twoFactorEnabled": {
"type": "boolean",
"description": "Is the two factor authentication enabled."
},
"verifiedEmail": {
"type": "boolean",
"description": "Is this email address verified."
},
"token": {
"type": "string",
"description": "The auth token to use in future requests."
}
},
"required": [
"identity",
"twoFactorEnabled",
"verifiedEmail",
"token"
],
"additionalProperties": false,
"description": "The response payload."
},
"LogoutRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity to logout."
}
},
"required": [
"identity"
],
"additionalProperties": false,
"description": "The data for the request."
},
"LoginTwoFactorCreateRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity to create the two factor authentication for."
}
},
"required": [
"identity"
],
"additionalProperties": false,
"description": "The data for the request."
},
"LoginTwoFactorCreateResponse": {
"type": "object",
"properties": {
"twoFactorSecret": {
"type": "string",
"description": "The two factor authentication secret."
}
},
"required": [
"twoFactorSecret"
],
"additionalProperties": false,
"description": "The response payload."
},
"LoginTwoFactorToggleRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity of the login."
},
"enableDisable": {
"type": "boolean",
"description": "Enable or disable the two factor authentication for the login."
},
"pin": {
"type": "string",
"description": "The pin for the two factor authentication."
}
},
"required": [
"identity",
"enableDisable",
"pin"
],
"additionalProperties": false,
"description": "The data for the request."
},
"ProfileUpdateRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity of the login."
},
"emailAddress": {
"type": "string",
"description": "The new email address."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Other optional fields."
}
},
"required": [
"identity",
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"TaxPinUpdateRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity of the login."
},
"taxPin": {
"type": "string",
"description": "The tax pin."
}
},
"required": [
"identity",
"taxPin"
],
"additionalProperties": false,
"description": "The data for the request."
},
"TokenCreateRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity to create the token for."
},
"name": {
"type": "string",
"description": "The name of the token."
},
"ttl": {
"type": "number",
"description": "The ttl for the token, or empty for no expiry."
}
},
"required": [
"identity",
"name"
],
"additionalProperties": false,
"description": "The data for the request."
},
"TokenCreateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the created token."
},
"created": {
"type": "number",
"description": "The time the token was created."
},
"token": {
"type": "string",
"description": "The token to use in requests."
},
"expires": {
"type": "number",
"description": "The expiry time in milli-seconds since epoch if a ttl was requested."
}
},
"required": [
"id",
"created",
"token"
],
"additionalProperties": false,
"description": "The response payload."
},
"TokenListResponse": {
"type": "object",
"properties": {
"tokens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created": {
"type": "number"
},
"name": {
"type": "string"
},
"expires": {
"type": "number"
}
},
"required": [
"id",
"created",
"name"
],
"additionalProperties": false
},
"description": "The tokens."
},
"cursor": {
"type": "string",
"description": "The cursor for paged requests."
}
},
"required": [
"tokens"
],
"additionalProperties": false,
"description": "The response payload."
},
"UserInviteRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email addresses to send invite to."
}
},
"required": [
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"RevokeInviteRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email address(s) for the invite account."
}
},
"required": [
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"AuthorityInviteRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The email address to send invite to."
},
"name": {
"type": "string",
"description": "The name of the authority."
}
},
"required": [
"emailAddress",
"name"
],
"additionalProperties": false,
"description": "The data for the request."
},
"ListOrganizationUsersResponse": {
"type": "object",
"properties": {
"nextPageCursor": {
"type": "string",
"description": "The cursor for paged requests."
},
"pendingInvites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The user email."
},
"status": {
"type": "string",
"description": "The user name."
},
"timeToExpiry": {
"type": "number",
"description": "Time to expiry."
}
},
"required": [
"email",
"status"
],
"additionalProperties": false
},
"description": "The organization users."
}
},
"required": [
"pendingInvites"
],
"additionalProperties": false,
"description": "The response payload."
},
"TokenDecodeRequest": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "The token to decode."
}
},
"required": [
"token"
],
"additionalProperties": false,
"description": "The data for the request."
},
"JwtToken": {
"type": "object",
"properties": {
"sub": {
"type": "string",
"description": "The subject ie the identity who is logged in."
},
"tenantId": {
"type": "string",
"description": "The tenant that issued the token."
},
"iat": {
"type": "number",
"description": "The time which the token was generated in seconds since 1970."
},
"exp": {
"type": "number",
"description": "The time which the token expires in seconds since 1970."
},
"tokenId": {
"type": "string",
"description": "Id of a manually generation auth token to lookup for existence."
}
},
"required": [
"sub",
"iat"
],
"additionalProperties": false,
"description": "The token returned for JWT."
},
"PasswordResetEmailRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The account email address."
},
"emailContent": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"bodyText": {
"type": "string"
},
"linkText": {
"type": "string"
},
"caution": {
"type": "string"
},
"customHtml": {
"type": "string"
}
},
"required": [
"subject",
"bodyText",
"customHtml"
],
"additionalProperties": false,
"description": "Custom email content."
}
},
"required": [
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"ResetPasswordRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The email address representing the account."
},
"password": {
"type": "string",
"description": "The new account password."
}
},
"required": [
"emailAddress",
"password"
],
"additionalProperties": false,
"description": "The data for the request."
},
"ResetPasswordResponse": {
"type": "object",
"properties": {
"existingSessions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The existing session id(s)."
}
},
"required": [
"existingSessions"
],
"additionalProperties": false,
"description": "The response payload."
},
"ApiKeyResponse": {
"type": "object",
"properties": {
"apiKey": {
"type": "string",
"description": "The api key."
}
},
"required": [
"apiKey"
],
"additionalProperties": false,
"description": "The response payload."
},
"ToggleProfileRequest": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Activate/deactivate."
},
"identities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identity(s) to toggle."
}
},
"required": [
"active",
"identities"
],
"additionalProperties": false,
"description": "The data for the request."
},
"TwoFactorRecoveryRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The new email address."
},
"recoveryCode": {
"type": "string",
"description": "The recovery code."
}
},
"required": [
"emailAddress",
"recoveryCode"
],
"additionalProperties": false,
"description": "The data for the request."
},
"UnlockAuthAccountRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email address(s) for the account to unlock."
}
},
"required": [
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"GetSessionsRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The idetity to get sessions."
}
},
"required": [
"identity"
],
"additionalProperties": false,
"description": "Request to get sessions."
},
"GetSessionsResponse": {
"type": "object",
"properties": {
"existingSessions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The existing session id(s)."
}
},
"required": [
"existingSessions"
],
"additionalProperties": false,
"description": "The response payload."
},
"IdentityCreateRequest": {
"type": "object",
"properties": {
"role": {
"$ref": "#/components/schemas/IdentityRole"
},
"emailAddress": {
"type": "string",
"description": "The Email address."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Optional fields."
}
},
"required": [
"role",
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"IdentityCreateResponse": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity created."
},
"recoveryPhrase": {
"type": "string",
"description": "Recovery phrase mnemonic."
},
"privateKey": {
"type": "string",
"description": "Private key."
},
"publicKey": {
"type": "string",
"description": "Public key."
}
},
"required": [
"identity",
"recoveryPhrase",
"privateKey",
"publicKey"
],
"additionalProperties": false,
"description": "The response payload."
},
"IdentityUpdateRequest": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Optional fields."
}
},
"additionalProperties": false,
"description": "The data for the request."
},
"ProfileSetRequest": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The email address for the identity."
},
"taxPin": {
"type": "string",
"description": "The tax pin for the identity."
},
"imageBase64": {
"type": "string",
"description": "The image to update the profile with."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Additional properties for the profile."
}
},
"required": [
"emailAddress"
],
"additionalProperties": false,
"description": "The data for the request."
},
"ProfileGetRequest": {
"type": "object",
"properties": {
"secondaryIndex": {
"type": "string",
"description": "Secondary index of the search parameter."
}
},
"required": [
"identity"
],
"additionalProperties": false,
"description": "Get the profile for an identity."
},
"ProfileGetResponse": {
"type": "object",
"properties": {
"role": {
"$ref": "#/components/schemas/IdentityRole"
},
"emailAddress": {
"type": "string",
"description": "The email address for the identity."
},
"identity": {
"type": "string",
"description": "The id for the identity."
},
"name": {
"type": "string",
"description": "The name in the profile."
},
"imageBase64": {
"type": "string",
"description": "The image in the profile."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Additional properties for the profile."
}
},
"required": [
"role",
"emailAddress",
"identity"
],
"additionalProperties": false,
"description": "The response payload."
},
"OrganizationsGetResponse": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "The cursor for paged requests."
},
"organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"identity",
"name"
],
"additionalProperties": false
},
"description": "The organizations."
}
},
"required": [
"organizations"
],
"additionalProperties": false,
"description": "The response payload."
},
"OrganizationGetResponse": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization."
}
},
"required": [
"name"
],
"additionalProperties": false,
"description": "The response payload."
},
"VerifiableCredentialRequirementsSetRequest": {
"type": "object",
"properties": {
"matchDomains": {
"type": "string",
"description": "Verifiable credential applicants must match the users email domain."
},
"requiredClaims": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityClaimRequirement"
},
"description": "The requisites needed to apply for a verifiable credential."
}
},
"additionalProperties": false,
"description": "The request payload."
},
"IdentityClaimRequirement": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The property key for the verifiable credential claim requirement."
},
"type": {
"type": "string",
"description": "The data type for the verifiable credential claim requirement."
},
"isPublic": {
"type": "boolean",
"description": "Should this property be available in public presentation of the claims."
}
},
"required": [
"key",
"type",
"isPublic"
],
"additionalProperties": false,
"description": "Definitions for verifiable credential claim requirement."
},
"VerifiableCredentialRequirementsGetResponse": {
"type": "object",
"properties": {
"matchDomains": {
"type": "string",
"description": "Verifiable credential applications must match the users email domain."
},
"requiredClaims": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityClaimRequirement"
},
"description": "The requisites needed to apply for a verifiable credential."
}
},
"additionalProperties": false,
"description": "The response payload."
},
"VerifiableCredentialCreateRequest": {
"type": "object",
"properties": {
"issuer": {
"type": "string",
"description": "The entity they want to create the verifiable credential with."
},
"subject": {
"type": "string",
"description": "The identity of the verifiable credential being created."
},
"verifiableCredentialType": {
"type": "string",
"description": "The type of verifiable credential requirements being requested."
},
"claims": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The completed claims providing information to the verifiable credential."
}
},
"required": [
"issuer",
"subject",
"verifiableCredentialType"
],
"additionalProperties": false,
"description": "The data for the request."
},
"VerifiableCredentialCreateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier for the verifiable credential."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "The response payload."
},
"VerifiableCredentialState": {
"type": "string",
"enum": [
"pendingVerification",
"rejected",
"issued",
"revoked"
],
"description": "The state of a verifiable credential."
},
"VerifiableCredentialApplicationsGetResponse": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "The cursor for paged requests."
},
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityVerifiableCredentialApplication"
},
"description": "The verifiable credential applications."
}
},
"required": [
"applications"
],
"additionalProperties": false,
"description": "The response payload."
},
"IdentityVerifiableCredentialApplication": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the verifiable credential application."
},
"issuer": {
"type": "string",
"description": "The identity that is issuing the verifiable credential."
},
"subject": {
"type": "string",
"description": "The identity that is the target of the verifiable credential."
},
"state": {
"$ref": "#/components/schemas/VerifiableCredentialState"
},
"created": {
"type": "number",
"description": "The timestamp when the verifiable credential application was created."
},
"updated": {
"type": "number",
"description": "The timestamp when the verifiable credential application was updated."
},
"verifiableCredentialType": {
"type": "string",
"description": "The type of verifiable credential being requested."
},
"privateClaims": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Properties supplied for the verifiable credential claims that are private."
},
"publicClaims": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Properties supplied for the verifiable credential claims that can be public."
},
"verifiableCredential": {
"$ref": "#/components/schemas/DidVerifiableCredential"
},
"rejectedCode": {
"type": "string",
"description": "The code for why the verifiable credential application was rejected."
}
},
"required": [
"id",
"issuer",
"subject",
"state",
"created",
"updated",
"verifiableCredentialType"
],
"additionalProperties": false,
"description": "Interface representing the state of an verifiable credential application."
},
"DidVerifiableCredential": {
"type": "object",
"properties": {
"@context": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The context for the verifiable credential."
},
"id": {
"type": "string",
"description": "The identifier for the verifiable credential."
},
"type": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of the data stored in the verifiable credential."
},
"credentialSubject": {
"description": "The data for the verifiable credential."
},
"credentialStatus": {
"$ref": "#/components/schemas/DidCredentialStatus"
},
"issuer": {
"type": "string",
"description": "The issuing identity."
},
"issuanceDate": {
"type": "string",
"description": "The date the verifiable credential was issued."
},
"proof": {
"$ref": "#/components/schemas/DidProof"
}
},
"required": [
"@context",
"id",
"type",
"credentialSubject",
"issuer",
"issuanceDate"
],
"additionalProperties": false,
"description": "Interface describing a verifiable credential."
},
"DidCredentialStatus": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The URI id."
},
"type": {
"type": "string",
"description": "The credential status type."
}
},
"required": [
"id",
"type"
],
"additionalProperties": {
"description": "Additional properties."
},
"description": "Interface describing a DID credential status."
},
"DidProof": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the proof."
},
"verificationMethod": {
"type": "string",
"description": "The verification method for the proof."
},
"signatureValue": {
"type": "string",
"description": "The signature for the proof."
}
},
"required": [
"type",
"verificationMethod",
"signatureValue"
],
"additionalProperties": false,
"description": "Interface describing a DID Proof."
},
"VerifiableCredentialUpdateRequest": {
"type": "object",
"properties": {
"state": {
"$ref": "#/components/schemas/VerifiableCredentialState"
},
"rejectedCode": {
"type": "string",
"description": "The reason for the rejection if that is the new state."
}
},
"required": [
"state"
],
"additionalProperties": false,
"description": "The request payload."
},
"DidCredentialVerification": {
"type": "object",
"properties": {
"isVerified": {
"type": "boolean",
"description": "Is the whole credential verified."
},
"issuer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the issuer."
},
"isVerified": {
"type": "boolean",
"description": "Is the issuer verified."
},
"document": {
"$ref": "#/components/schemas/DidDocument"
}
},
"required": [
"id",
"isVerified"
],
"additionalProperties": false,
"description": "Who was the issuer."
},
"subjects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The if od the subject."
},
"isVerified": {
"type": "boolean",
"description": "Is the subject verified."
},
"document": {
"$ref": "#/components/schemas/DidDocument"
}
},
"required": [
"id",
"isVerified"
],
"additionalProperties": false
},
"description": "The subjects of the verifications."
}
},
"required": [
"isVerified"
],
"additionalProperties": false,
"description": "Interface describing the result of checking verifiable credential."
},
"DidDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id for the document."
},
"alsoKnownAs": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Aliases for the document."
},
"controller": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The controller for the document."
},
"verificationMethod": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/DidDocumentVerificationMethod"
}
]
},
"description": "The verification methods."
},
"authentication": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/DidDocumentVerificationMethod"
}
]
},
"description": "The authentication methods."
},
"assertionMethod": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/DidDocumentVerificationMethod"
}
]
},
"description": "The assertion methods."
},
"keyAgreement": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/DidDocumentVerificationMethod"
}
]
},
"description": "The key agreements."
},
"capabilityInvocation": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/DidDocumentVerificationMethod"
}
]
},
"description": "The capability invocations."
},
"capabilityDelegation": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/DidDocumentVerificationMethod"
}
]
},
"description": "The capability delegations."
},
"service": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DidService"
},
"description": "The services."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Interface describing a DID Document. Spec https://www.w3.org/TR/did-core/#did-document-properties."
},
"DidDocumentVerificationMethod": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the entry."
},
"controller": {
"type": "string",
"description": "The controller for the entry."
},
"type": {
"type": "string",
"description": "The type of the entry."
},
"publicKeyMultibase": {
"type": "string",
"description": "The public key for the entry. Spec https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-03 ."
},
"publicKeyJwk": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The public key for the entry as a JWK. Spec https://datatracker.ietf.org/doc/html/rfc7517 ."
},
"revocation": {
"type": "string",
"description": "Multikey partial revocation."
}
},
"required": [
"id",
"controller",
"type"
],
"additionalProperties": false,
"description": "Interface describing a DID document verification method."
},
"DidService": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the service."
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The type of the service."
},
"serviceEndpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The endpoint for the service."
}
},
"required": [
"id",
"type",
"serviceEndpoint"
],
"additionalProperties": false,
"description": "Interface describing a did document service."
},
"SignDataRequest": {
"type": "object",
"properties": {
"bytes": {
"type": "string",
"description": "The bytes for the document encoded as hex."
},
"verificationMethod": {
"type": "string",
"description": "The verification method to use for signing."
}
},
"required": [
"bytes",
"verificationMethod"
],
"additionalProperties": false,
"description": "The data to be used in the signing."
},
"SignDataResponse": {
"type": "object",
"properties": {
"signatureType": {
"type": "string",
"description": "The type of signature generated."
},
"signatureValue": {
"type": "string",
"description": "The value of the signature."
}
},
"required": [
"signatureType",
"signatureValue"
],
"additionalProperties": false,
"description": "The response payload."
},
"VerifyDataRequest": {
"type": "object",
"properties": {
"bytes": {
"type": "string",
"description": "The bytes for the document encoded as hex."
},
"verificationMethod": {
"type": "string",
"description": "The verification method to use for verification."
},
"signatureType": {
"type": "string",
"description": "The type of the signature."
},
"signatureValue": {
"type": "string",
"description": "The value of the signature."
}
},
"required": [
"bytes",
"verificationMethod",
"signatureType",
"signatureValue"
],
"additionalProperties": false,
"description": "The data to be used in the verification."
},
"VerifyDataResponse": {
"type": "object",
"properties": {
"verified": {
"type": "boolean",
"description": "Is the signature verified."
}
},
"required": [
"verified"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentManagementCreateRequest": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "The id of the document to create."
},
"identity": {
"type": "string",
"description": "The identity to sign the document."
},
"bytes": {
"type": "string",
"description": "The bytes for the document encoded as hex."
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Additional properties to storewith the document."
},
"auditableItemGraphId": {
"type": "string",
"description": "Id for auditable item graph to add the document as a resource."
}
},
"required": [
"documentId",
"identity",
"bytes"
],
"additionalProperties": false,
"description": "The data to be used in the create."
},
"DocumentOverview": {
"type": "object",
"properties": {
"proof": {
"$ref": "#/components/schemas/DocumentProof"
},
"version": {
"type": "number",
"description": "The document version. (https://schema.org/version)."
},
"identity": {
"type": "string",
"description": "The signer of the document."
},
"blobStorageId": {
"type": "string",
"description": "The id of the document in the blob storage."
},
"fileFormat": {
"type": "string",
"description": "Media type, typically MIME format of the content. (https://schema.org/fileFormat)."
},
"dateCreated": {
"type": "number",
"description": "The timestamp for the created."
},
"contentSize": {
"type": "number",
"description": "File size in (mega/kilo)bytes. (https://schema.org/contentSize)."
},
"fingerPrint": {
"type": "string",
"description": "Fingerprint of the document data."
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The custom metadata."
},
"matrix": {
"type": "object",
"additionalProperties": {},
"description": "The document matrix."
},
"id": {
"type": "string",
"description": "The id of the document."
},
"itemId": {
"type": "string",
"description": "The item Id."
},
"tenantId": {
"type": "string",
"description": "The tenant Id."
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RevisionOverview"
},
"description": "The document revisions."
}
},
"required": [
"blobStorageId",
"contentSize",
"dateCreated",
"fileFormat",
"fingerPrint",
"id",
"identity",
"proof",
"version"
],
"additionalProperties": false,
"description": "Entity to store information about a document."
},
"DocumentProof": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "DataIntegrityProof",
"description": "The data document proof type."
},
"cryptosuite": {
"type": "string",
"description": "The data document proof crypto suite."
},
"created": {
"type": "string",
"description": "The data document proof created at timestamp (ISO8601 string)."
},
"verificationMethod": {
"type": "string",
"description": "The data document proof verification method."
},
"proofPurpose": {
"type": "string",
"const": "assertionMethod",
"description": "The data document proof purpose."
},
"proofValue": {
"type": "string",
"description": "The data document proof value."
}
},
"required": [
"type",
"cryptosuite",
"created",
"verificationMethod",
"proofPurpose",
"proofValue"
],
"additionalProperties": false,
"description": "Interface describing the data document proof."
},
"RevisionOverview": {
"type": "object",
"properties": {
"proof": {
"$ref": "#/components/schemas/DocumentProof"
},
"version": {
"type": "number",
"description": "The document version. (https://schema.org/version)."
},
"identity": {
"type": "string",
"description": "The signer of the document."
},
"blobStorageId": {
"type": "string",
"description": "The id of the document in the blob storage."
},
"fileFormat": {
"type": "string",
"description": "Media type, typically MIME format of the content. (https://schema.org/fileFormat)."
},
"dateCreated": {
"type": "number",
"description": "The timestamp for the created."
},
"contentSize": {
"type": "number",
"description": "File size in (mega/kilo)bytes. (https://schema.org/contentSize)."
},
"fingerPrint": {
"type": "string",
"description": "Fingerprint of the document data."
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The custom metadata."
},
"matrix": {
"type": "object",
"additionalProperties": {},
"description": "The document matrix."
}
},
"required": [
"proof",
"version",
"identity",
"blobStorageId",
"fileFormat",
"dateCreated",
"contentSize",
"fingerPrint"
],
"additionalProperties": false,
"description": "Entity to store information about a document revision."
},
"DocumentManagementVerifyResponse": {
"type": "object",
"properties": {
"overview": {
"$ref": "#/components/schemas/RevisionOverview"
},
"verified": {
"type": "boolean",
"description": "Is the document verified."
},
"bytes": {
"type": "string",
"description": "The bytes for the document, included if includeBytes was set in the request."
}
},
"required": [
"overview",
"verified"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentManagementListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentOverview"
},
"description": "The items."
},
"cursor": {
"type": "string",
"description": "Cursor for paged requests."
}
},
"required": [
"items"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentManagementViewUrlResponse": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The url to view the document."
}
},
"required": [
"url"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentManagementShareRequest": {
"type": "object",
"properties": {
"emailAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email addresses to share the document with."
}
},
"required": [
"emailAddresses"
],
"additionalProperties": false,
"description": "The request data."
},
"DocumentManagementViewShareResponse": {
"type": "object",
"properties": {
"document": {
"type": "object",
"additionalProperties": false,
"properties": {
"verified": {
"type": "boolean"
},
"bytes": {
"type": "object",
"properties": {
"BYTES_PER_ELEMENT": {
"type": "number"
},
"buffer": {
"type": "object",
"properties": {
"byteLength": {
"type": "number"
}
},
"required": [
"byteLength"
],
"additionalProperties": false
},
"byteLength": {
"type": "number"
},
"byteOffset": {
"type": "number"
},
"length": {
"type": "number"
}
},
"required": [
"BYTES_PER_ELEMENT",
"buffer",
"byteLength",
"byteOffset",
"length"
],
"additionalProperties": {
"type": "number"
}
},
"proof": {
"$ref": "#/components/schemas/DocumentProof"
},
"version": {
"type": "number",
"description": "The document version. (https://schema.org/version)."
},
"identity": {
"type": "string",
"description": "The signer of the document."
},
"blobStorageId": {
"type": "string",
"description": "The id of the document in the blob storage."
},
"fileFormat": {
"type": "string",
"description": "Media type, typically MIME format of the content. (https://schema.org/fileFormat)."
},
"dateCreated": {
"type": "number",
"description": "The timestamp for the created."
},
"contentSize": {
"type": "number",
"description": "File size in (mega/kilo)bytes. (https://schema.org/contentSize)."
},
"fingerPrint": {
"type": "string",
"description": "Fingerprint of the document data."
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The custom metadata."
},
"matrix": {
"type": "object",
"additionalProperties": {},
"description": "The document matrix."
}
},
"required": [
"blobStorageId",
"contentSize",
"dateCreated",
"fileFormat",
"fingerPrint",
"identity",
"proof",
"verified",
"version"
],
"description": "Verified document."
},
"documentType": {
"$ref": "#/components/schemas/DocumentType"
},
"documentViewUrl": {
"type": "string",
"description": "The document view url."
},
"documentDownloadUrl": {
"type": "string",
"description": "The document download url."
}
},
"required": [
"document",
"documentViewUrl",
"documentDownloadUrl"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentType": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The uri of the reference code."
},
"name": {
"type": "string",
"description": "The name of the reference code."
},
"code": {
"type": [
"string",
"number"
],
"description": "The value of the reference code."
},
"identifierField": {
"type": "string",
"description": "The identifier field used for the document type."
},
"isStandardType": {
"type": "boolean",
"description": "Standard Type."
},
"isOpenGtsc": {
"type": "boolean",
"description": "Open GTSC Type."
}
},
"additionalProperties": false,
"required": [
"code",
"name",
"uri"
],
"description": "The response to get a document type."
},
"DocumentManagementSharingUrlResponse": {
"type": "object",
"properties": {
"documentSharingUrl": {
"type": "string",
"description": "The document sharing url."
}
},
"required": [
"documentSharingUrl"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentManagementShareUrlResponse": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The document sharing url."
}
},
"required": [
"url"
],
"additionalProperties": false,
"description": "The response payload."
},
"InventoryStatus": {
"type": "string",
"enum": [
"commisioned",
"stocked",
"faulty",
"shipped",
"delivered",
"received",
"sold",
"installed",
"recalled",
"returned",
"recycled"
],
"description": "The inventory status properties."
},
"InventoryGetResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryEntity"
},
"description": "The response data."
},
"cursor": {
"type": "string",
"description": "Cursor for paged lookups."
}
},
"required": [
"items"
],
"additionalProperties": false,
"description": "The response payload."
},
"InventoryEntity": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The item id."
},
"type": {
"type": "array",
"items": {
"type": "string"
},
"description": "The item type."
},
"inventoryLevel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryLevel"
},
"description": "The item inventory level."
}
},
"required": [
"id",
"type",
"inventoryLevel"
],
"additionalProperties": false,
"description": "The inventory entity."
},
"InventoryLevel": {
"type": "object",
"properties": {
"inventoryStatus": {
"$ref": "#/components/schemas/InventoryStatus"
},
"value": {
"type": "number",
"description": "The item's inventory value."
},
"location": {
"type": "string",
"description": "The item's inventory location."
}
},
"required": [
"inventoryStatus",
"value",
"location"
],
"additionalProperties": false,
"description": "The inventory level summary."
},
"ItemInventoryQuery": {
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/InventoryStatus"
},
"location": {
"type": "string",
"description": "The item location."
},
"groupBy": {
"type": "string",
"description": "The items grouping."
}
},
"additionalProperties": false,
"description": "Interface for item inventory query."
},
"ConsignmentCreateRequest": {
"type": "object",
"properties": {
"identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier"
},
"description": "The consignment identifiers."
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsignmentDocumentCreateUpdateRequest"
},
"description": "The consignment's documents."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier"
},
"description": "The consignment's commodities or consignments."
},
"consignmentType": {
"type": "string",
"enum": [
"consignment",
"shipment"
],
"description": "The consignment type."
},
"itemsToShipment": {
"type": "boolean",
"description": "Whether to add consignments to shipment?"
},
"destinationCountry": {
"$ref": "#/components/schemas/UneceCountry"
}
},
"required": [
"identifiers",
"documents",
"consignmentType"
],
"additionalProperties": false,
"description": "The data to be used in the create."
},
"Identifier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Identifier type."
},
"id": {
"type": "string",
"description": "Identifier value."
}
},
"required": [
"type",
"id"
],
"additionalProperties": false,
"description": "Identifier response."
},
"ConsignmentDocumentCreateUpdateRequest": {
"type": "object",
"properties": {
"issuingCompany": {
"type": "string",
"description": "The organization generating and issuing the document."
},
"data": {
"type": "object",
"properties": {
"binaryData": {
"type": "string",
"description": "Base 64 encoded version of the document."
},
"completionStatus": {
"type": "string",
"enum": [
"complete",
"issued",
"approved",
"rejected",
"failed",
"other"
],
"description": "Completion state for any associated event."
},
"issuer": {
"type": "string",
"description": "The issuer of the document."
}
},
"required": [
"binaryData",
"completionStatus"
],
"additionalProperties": false,
"description": "The data to be used in the operation."
}
},
"additionalProperties": false,
"required": [
"data",
"documentType",
"issuingCompany"
],
"description": "Create or update a consignment document."
},
"UneceCountry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "Country",
"description": "LD @type."
},
"countryId": {
"type": "string",
"description": "Country Id."
}
},
"required": [
"type",
"countryId"
],
"additionalProperties": false,
"description": "UN/CEFACT Country."
},
"ConsignmentCreateResponse": {
"type": "object",
"properties": {
"consignmentId": {
"type": "string",
"description": "The identifier of the created consignment."
}
},
"required": [
"consignmentId"
],
"additionalProperties": false,
"description": "The response payload."
},
"ConsignmentAddItemsRequest": {
"type": "object",
"properties": {
"consignmentType": {
"$ref": "#/components/schemas/ConsignmentType"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Identifier"
},
"description": "The commodities or consignments associated to the consignment."
}
},
"required": [
"consignmentType",
"items"
],
"additionalProperties": false,
"description": "The data to be used in creating an alias."
},
"ConsignmentType": {
"type": "string",
"enum": [
"consignment",
"shipment",
"commodity"
],
"description": "Consignment Types."
},
"ConsignmentsAddRequest": {
"type": "object",
"properties": {
"consignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "The consignments to be associated to the shipment."
}
},
"required": [
"consignments"
],
"additionalProperties": false,
"description": "The data to be used in adding relationships."
},
"ConsignmentAddIdentifierRequest": {
"type": "object",
"properties": {
"aliasType": {
"type": "string",
"description": "Alias type."
},
"aliasId": {
"type": "string",
"description": "The alias id."
}
},
"required": [
"aliasType",
"aliasId"
],
"additionalProperties": false,
"description": "The data to be used in creating an alias."
},
"ConsignmentDocumentCreateUpdateResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The document id."
},
"revision": {
"type": "number",
"description": "The new revision number of the updated document."
},
"fingerPrint": {
"type": "string",
"description": "The fingerprint for the document."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Field matrix values added during the processing."
},
"identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AliasId"
},
"description": "Identifiers added during the processing."
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleEvent"
},
"description": "Events extracted during processing."
}
},
"required": [
"id",
"revision",
"fingerPrint"
],
"additionalProperties": false,
"description": "The response payload."
},
"SimpleEvent": {
"type": "object",
"properties": {
"itemId": {
"type": "string",
"description": "The event subject (the itemId)."
},
"type": {
"type": "string",
"description": "Event type."
},
"identity": {
"type": "string",
"description": "The identity of the organization or user that issued the event."
},
"startTime": {
"type": "number",
"description": "Start time."
},
"endTime": {
"type": "number",
"description": "End time."
},
"completionStatus": {
"type": "string",
"enum": [
"complete",
"issued",
"approved",
"rejected",
"failed",
"other"
],
"description": "Completion Status."
},
"action": {
"type": "string",
"enum": [
"Request",
"Add"
],
"description": "Event action."
},
"customTitle": {
"type": "string",
"description": "If the event type is custom, this is the title to display."
},
"fail": {
"type": "boolean",
"description": "If completion was a success or failure."
},
"code": {
"type": [
"number",
"string"
],
"description": "The document code associated with the event as in https://vocabulary.uncefact.org/DocumentCodeList."
},
"location": {
"$ref": "#/components/schemas/EventLocationData"
},
"documentRevision": {
"type": "number",
"description": "The revision of the document if there is one."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Extended data."
},
"dataProducer": {
"type": "string",
"description": "Data producer."
},
"id": {
"type": "string",
"description": "ID of the event."
},
"name": {
"type": "string",
"description": "The display name."
}
},
"required": [
"id",
"identity",
"itemId",
"startTime",
"type"
],
"additionalProperties": false,
"description": "Simple Event."
},
"EventLocationData": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Location name."
},
"longitude": {
"type": "number",
"description": "Location longitude."
},
"latitude": {
"type": "number",
"description": "Location latitude."
}
},
"additionalProperties": false,
"description": "Location options."
},
"ConsignmentUpdateRequest": {
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The consignment properties."
}
},
"required": [
"properties"
],
"additionalProperties": false,
"description": "The data to be used in adding relationships."
},
"IdentifierType": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The uri of the reference code."
},
"name": {
"type": "string",
"description": "The name of the reference code."
},
"code": {
"type": [
"string",
"number"
],
"description": "The value of the reference code."
},
"isStandardType": {
"type": "boolean",
"description": "Standard Type."
},
"isOpenGtsc": {
"type": "boolean",
"description": "Open GTSC Type."
}
},
"additionalProperties": false,
"required": [
"code",
"name",
"uri"
],
"description": "Identifier type."
},
"IdentifierTypesListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentifierType"
},
"description": "The identifier type items."
}
},
"required": [
"items"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentTypesListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTypesList"
},
"description": "Document types list."
},
"nextPageCursor": {
"type": "string",
"description": "Cursor pointing to the next set of results in a paged request."
}
},
"required": [
"items"
],
"additionalProperties": false,
"description": "The response data."
},
"DocumentTypesList": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The uri of the reference code."
},
"name": {
"type": "string",
"description": "The name of the reference code."
},
"code": {
"type": [
"string",
"number"
],
"description": "The value of the reference code."
},
"identifierField": {
"type": "string",
"description": "The identifier field used for the document type."
},
"isStandardType": {
"type": "boolean",
"description": "Standard Type."
},
"isOpenGtsc": {
"type": "boolean",
"description": "Open GTSC Type."
},
"defaultReaders": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of default readers for the document type."
},
"defaultWriters": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of default writers for the document type."
}
},
"required": [
"code",
"defaultReaders",
"defaultWriters",
"name",
"uri"
],
"additionalProperties": false,
"description": "Document types list."
},
"TLIPEventType": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The event type id."
},
"name": {
"type": "string",
"description": "The event type name e.g Goods Delivered."
},
"uri": {
"anyOf": [
{
"$ref": "#/components/schemas/Url"
},
{
"$ref": "#/components/schemas/Urn"
}
],
"description": "Event type URI defined in Linked Data Vocabularies e.g https://w3id.org/open-gtsc/kra_release_event."
},
"createName": {
"type": "string",
"description": "Event creation name e.g Request Export Certificate."
},
"inProgressName": {
"type": "string",
"description": "In progess name e.g Export Certificate Requested."
},
"documentType": {
"type": "string",
"description": "The type of document associated with the event."
},
"code": {
"type": [
"number",
"string"
],
"description": "The document code associated with the event as in https://vocabulary.uncefact.org/DocumentCodeList."
},
"isOpenGtsc": {
"type": "boolean",
"description": "Whether is a gtsc internal event type."
}
},
"required": [
"id",
"name",
"uri",
"createName",
"inProgressName"
],
"additionalProperties": false,
"description": "Event type."
},
"Url": {
"type": "object",
"additionalProperties": false,
"description": "Class to help with urls."
},
"Urn": {
"type": "object",
"additionalProperties": false,
"description": "Class to help with urns."
},
"EventTypesListResponse": {
"type": "object",
"properties": {
"eventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TLIPEventType"
},
"description": "The event type items."
},
"nextPageCursor": {
"type": "string",
"description": "The next page cursor."
}
},
"required": [
"eventTypes"
],
"additionalProperties": false,
"description": "The response payload."
},
"SimpleEventData": {
"type": "object",
"properties": {
"itemId": {
"type": "string",
"description": "The event subject (the itemId)."
},
"type": {
"type": "string",
"description": "Event type."
},
"identity": {
"type": "string",
"description": "The identity of the organization or user that issued the event."
},
"startTime": {
"type": "number",
"description": "Start time."
},
"endTime": {
"type": "number",
"description": "End time."
},
"completionStatus": {
"type": "string",
"enum": [
"complete",
"issued",
"approved",
"rejected",
"failed",
"other"
],
"description": "Completion Status."
},
"action": {
"type": "string",
"enum": [
"Request",
"Add"
],
"description": "Event action."
},
"customTitle": {
"type": "string",
"description": "If the event type is custom, this is the title to display."
},
"fail": {
"type": "boolean",
"description": "If completion was a success or failure."
},
"code": {
"type": [
"number",
"string"
],
"description": "The document code associated with the event as in https://vocabulary.uncefact.org/DocumentCodeList."
},
"location": {
"$ref": "#/components/schemas/EventLocationData"
},
"documentRevision": {
"type": "number",
"description": "The revision of the document if there is one."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "Extended data."
},
"dataProducer": {
"type": "string",
"description": "Data producer."
}
},
"required": [
"itemId",
"type",
"identity",
"startTime"
],
"additionalProperties": false,
"description": "Simple Event."
},
"EventsListResponse": {
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleEvent"
},
"description": "The events list."
}
},
"required": [
"events"
],
"additionalProperties": false,
"description": "The response payload."
},
"DocumentsListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentOverview"
},
"description": "The documents list."
}
},
"required": [
"items"
],
"additionalProperties": false,
"description": "The response payload."
},
"OrganizationUsersListResponse": {
"type": "object",
"properties": {
"nextPageCursor": {
"type": "string",
"description": "The cursor for paged requests."
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The user email."
},
"name": {
"type": "string",
"description": "The user name."
},
"accountLocked": {
"type": "boolean",
"description": "Whether the auth login account is locked."
},
"active": {
"type": "boolean",
"description": "Whether the profile is active."
},
"accessGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccessGroup"
},
"description": "List of access groups the user belongs to."
},
"identity": {
"type": "string",
"description": "Account identity."
}
},
"required": [
"email",
"name",
"accountLocked",
"active"
],
"additionalProperties": false
},
"description": "Organization users."
}
},
"required": [
"users"
],
"additionalProperties": false,
"description": "The response payload."
},
"MatrixDisplayGetRequest": {
"type": "object",
"additionalProperties": false,
"description": "The request to get display matrix."
},
"MatrixDisplayGetResponse": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatrixDisplayGroup"
},
"description": "Matrix display groups."
}
},
"additionalProperties": false,
"description": "The response payload."
},
"MatrixDisplayGroup": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label for the group."
},
"arrayField": {
"type": "string",
"description": "If this is an array."
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatrixDisplayGroupField"
},
"description": "The fields for the items in the group."
}
},
"required": [
"label",
"fields"
],
"additionalProperties": false,
"description": "Matrix display goup."
},
"MatrixDisplayGroupField": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The label of the field."
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "The id of the group item."
},
"format": {
"$ref": "#/components/schemas/MatrixDisplayGroupFieldFormat"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatrixDisplayGroupField"
},
"description": "Fields used if format is list."
}
},
"required": [
"label",
"id"
],
"additionalProperties": false,
"description": "Matrix display group field."
},
"MatrixDisplayGroupFieldFormat": {
"type": "string",
"enum": [
"linebreak",
"hyphen",
"space",
"date",
"list",
"link"
],
"description": "Matrix display group field format."
},
"HealthCheckServices": {
"type": "object",
"properties": {
"entityStorage": {
"type": "string",
"description": "Health check performed on entity storage."
},
"blobStorage": {
"type": "string",
"description": "Health check performed on blob storage."
},
"immutableStorage": {
"type": "string",
"description": "Health check performed on the immutable storage."
}
},
"required": [
"entityStorage",
"blobStorage",
"immutableStorage"
],
"additionalProperties": false,
"description": "Services on which we perform health check on."
},
"ModifyAccessToGroupRequest": {
"type": "object",
"properties": {
"identities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identities of the profiles to add."
}
},
"required": [
"identities"
],
"additionalProperties": false,
"description": "Request data."
},
"ActivityLogs": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponentMetric"
},
"description": "The activity logs."
},
"cursor": {
"type": "string",
"description": "The cursor offset to get identitifer types from."
},
"bytes": {
"type": "string",
"description": "Document Bytes."
}
},
"required": [
"metrics"
],
"additionalProperties": false,
"description": "Activity logs."
},
"AttestRequest": {
"type": "object",
"properties": {
"businessRegistrationNumber": {
"type": "string",
"description": "Business registaration number."
}
},
"required": [
"businessRegistrationNumber"
],
"additionalProperties": false,
"description": "The data to verify BRN."
},
"AttestResponse": {
"type": "object",
"properties": {
"organizationName": {
"type": "string",
"description": "Organisation name."
},
"pin": {
"type": "string",
"description": "Organisation pin."
},
"verifiedBRN": {
"type": "boolean",
"description": "Is BRN number verified."
}
},
"required": [
"verifiedBRN"
],
"additionalProperties": false,
"description": "The data returned."
},
"ActivityStream": {
"type": "object",
"properties": {
"@context": {
"$ref": "#/components/schemas/LdContext"
},
"id": {
"type": "string",
"description": "LD @id."
},
"type": {
"type": "string",
"enum": [
"Create",
"Add",
"Request",
"Update"
],
"description": "LD @type."
},
"generator": {
"type": "string",
"description": "Activity's Generator."
},
"actor": {
"$ref": "#/components/schemas/OrganizationActor"
},
"object": {
"$ref": "#/components/schemas/ActivityObject"
},
"target": {
"$ref": "#/components/schemas/UneceConsignment"
},
"updated": {
"type": "string",
"description": "Updated."
},
"to": {
"$ref": "#/components/schemas/Url"
}
},
"required": [
"@context",
"type",
"generator",
"actor",
"object",
"updated"
],
"additionalProperties": false,
"description": "Activity Stream interface."
},
"OrganizationActor": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "LD @id."
},
"name": {
"type": "string",
"description": "Org name."
},
"type": {
"anyOf": [
{
"type": "string",
"const": "Organization"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "LD @type."
},
"identificationType": {
"type": "string",
"description": "Identification Type."
},
"identificationId": {
"type": "string",
"description": "The identification id."
}
},
"required": [
"id",
"type"
],
"additionalProperties": false,
"description": "Activity actor."
},
"ActivityObject": {
"anyOf": [
{
"$ref": "#/components/schemas/UneceDocument"
},
{
"$ref": "#/components/schemas/UneceConsignment"
}
],
"description": "Activity's actor."
},
"UneceDocument": {
"type": "object",
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"const": "Document"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "LD @ type."
},
"documentTypeCode": {
"type": "string",
"description": "Document type."
},
"versionId": {
"type": "string",
"description": "Version Id."
},
"issueDateTime": {
"type": "string",
"description": "Issue datetime."
},
"mediaType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Media Type."
},
"href": {
"type": "string",
"description": "URL."
},
"issuerParty": {
"$ref": "#/components/schemas/UneceParty"
},
"documentBinaryData": {
"type": "string",
"description": "Binary data for the document."
},
"contentUrl": {
"type": "string",
"description": "Data URI with the content."
},
"documentType": {
"type": "string",
"description": "Document Type."
},
"identificationId": {
"type": "string",
"description": "Document identifier."
},
"identificationType": {
"type": "string",
"description": "Document identification type."
},
"fingerprint": {
"type": "string",
"description": "Fingerprint."
}
},
"required": [
"type",
"documentTypeCode"
],
"additionalProperties": false,
"description": "UN/CEFACT Document."
},
"UneceParty": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The party id."
},
"type": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
],
"description": "LD @type."
},
"identificationType": {
"type": "string",
"description": "Identification Type."
},
"identificationId": {
"type": "string",
"description": "Identification Id."
}
},
"additionalProperties": false,
"description": "UN/CEFACT Party."
},
"UneceConsignment": {
"type": "object",
"properties": {
"type": {
"anyOf": [
{
"type": "string",
"const": "Consignment"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "LD @ type."
},
"globalId": {
"type": "string",
"description": "UCR."
},
"identificationType": {
"type": "string",
"description": "Identification Type."
},
"identificationId": {
"type": "string",
"description": "Identification Id."
},
"customsId": {
"type": "string",
"description": "Customs identification id."
},
"exporterParty": {
"$ref": "#/components/schemas/UneceParty"
},
"importerParty": {
"$ref": "#/components/schemas/UneceParty"
},
"destinationCountry": {
"$ref": "#/components/schemas/UneceCountry"
},
"exportTypeCode": {
"type": "string",
"description": "Export type code."
}
},
"additionalProperties": false,
"required": [
"type"
],
"description": "UN/CEFACT Consignment."
},
"JobDetails": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Job id."
},
"generator": {
"type": "string",
"description": "The generator of the job."
},
"jobData": {
"type": "object",
"additionalProperties": {},
"description": "Data associated to the job. It can be params, runnableClass, etc."
},
"status": {
"$ref": "#/components/schemas/JobStatus"
},
"created": {
"type": "number",
"description": "When it was created."
},
"started": {
"type": "number",
"description": "When it started."
},
"finished": {
"type": "number",
"description": "When it finished."
},
"result": {
"description": "The result."
},
"error": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"message": {
"type": "string"
},
"stack": {
"type": "string"
}
},
"required": [
"name",
"message"
],
"additionalProperties": false,
"description": "The error if failed."
},
"to": {
"$ref": "#/components/schemas/Url"
}
},
"required": [
"id",
"generator",
"status",
"created"
],
"additionalProperties": false,
"description": "Job Details."
},
"JobStatus": {
"type": "string",
"enum": [
"pending",
"running",
"completed",
"failed",
"error"
],
"description": "Job statuses."
},
"DocumentQuery": {
"type": "object",
"properties": {
"code": {
"type": [
"number",
"string"
],
"description": "The document code. (https://vocabulary.uncefact.org/DocumentCodeList)."
},
"globalId": {
"type": "string",
"description": "The consignment global identification id. Consignment UCR as per WCO standard."
},
"customsId": {
"type": "string",
"description": "The consignment customs declaration identification id. Consignment customs declaration number as per WCO standard."
},
"identificationId": {
"type": "string",
"description": "The document local identification id. (only mandatory if globalIdentificationId is not provided and ignored otherwise)."
},
"identificationType": {
"type": "string",
"description": "The consignment local identification type. (optional and it shall be ignored unless identificationId is provided)."
},
"versionId": {
"type": "string",
"description": "The document version to get."
}
},
"required": [
"code"
],
"additionalProperties": false,
"description": "Consignment document get request."
},
"RevisionOverviewHarmonized": {
"type": "object",
"properties": {
"@context": {
"$ref": "#/components/schemas/LdContext"
},
"type": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"id": {
"type": "string"
},
"proof": {
"$ref": "#/components/schemas/DocumentProof"
},
"version": {
"type": "number",
"description": "The document version. (https://schema.org/version)."
},
"identity": {
"type": "string",
"description": "The signer of the document."
},
"blobStorageId": {
"type": "string",
"description": "The id of the document in the blob storage."
},
"fileFormat": {
"type": "string",
"description": "Media type, typically MIME format of the content. (https://schema.org/fileFormat)."
},
"dateCreated": {
"type": "number",
"description": "The timestamp for the created."
},
"contentSize": {
"type": "number",
"description": "File size in (mega/kilo)bytes. (https://schema.org/contentSize)."
},
"fingerPrint": {
"type": "string",
"description": "Fingerprint of the document data."
},
"metadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
},
"description": "The custom metadata."
},
"matrix": {
"type": "object",
"additionalProperties": {},
"description": "The document matrix."
},
"code": {
"type": [
"number",
"string"
],
"description": "The document code."
},
"verified": {
"type": "boolean",
"description": "Is the document verified."
},
"contentUrl": {
"type": "string",
"description": "The document data url."
}
},
"required": [
"@context",
"blobStorageId",
"code",
"contentSize",
"dateCreated",
"fileFormat",
"fingerPrint",
"id",
"identity",
"proof",
"type",
"verified",
"version"
],
"additionalProperties": {},
"description": "Harmonized revision overview."
},
"ActivityLogEntryListResponse": {
"type": "object",
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobDetailsSummary"
}
},
"cursor": {
"type": "string"
}
},
"required": [
"jobs"
],
"additionalProperties": false,
"description": "The response data."
},
"ActivityLogEntrySummary": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the job."
},
"created": {
"type": "number",
"description": "The date the job was created."
}
},
"required": [
"id",
"created"
],
"additionalProperties": false,
"description": "A summary of Activity Log Entries to allow TLIP Connector clients to know the status of activity processing."
},
"Subscription": {
"type": "object",
"properties": {
"@context": {
"$ref": "#/components/schemas/LdContext"
},
"type": {
"type": "string",
"const": "Subscription",
"description": "The LD type."
},
"id": {
"type": "string",
"description": "The subscription ID."
},
"subscriber": {
"type": "string",
"description": "Subscriber."
},
"event": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/UneceConsignment"
}
},
"required": [
"type",
"item"
],
"additionalProperties": false,
"description": "Event."
},
"notification": {
"type": "object",
"properties": {
"receivedBy": {
"$ref": "#/components/schemas/Url"
}
},
"required": [
"receivedBy"
],
"additionalProperties": false,
"description": "Subscription recepient."
}
},
"required": [
"@context",
"type",
"event",
"notification"
],
"additionalProperties": false,
"description": "Activity Stream interface for a subscription."
},
"RegisterSystemRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity of the system to communicate with."
},
"endpoint": {
"type": "string",
"description": "The endpoint."
}
},
"required": [
"identity",
"endpoint"
],
"additionalProperties": false,
"description": "The data for the request."
},
"UpdateSystemRequest": {
"type": "object",
"properties": {
"endpoint": {
"type": "string",
"description": "The endpoint."
},
"apiKey": {
"type": "string",
"description": "The API key."
}
},
"required": [
"endpoint",
"apiKey"
],
"additionalProperties": false,
"description": "The request data."
},
"ProcessAccessRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity of the requesting system."
},
"accessType": {
"$ref": "#/components/schemas/AccessType"
}
},
"required": [
"identity",
"accessType"
],
"additionalProperties": false,
"description": "The data for the request."
},
"AccessType": {
"type": "string",
"enum": [
"granted",
"revoked",
"pending"
],
"description": "The access types."
},
"AccessRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"description": "The identity to request access for."
},
"endpoint": {
"type": "string",
"description": "The endpoint to access."
},
"secret": {
"type": "string",
"description": "The secret to access the system."
},
"privateKey": {
"type": "string",
"description": "The private key of the identity."
},
"publicKey": {
"type": "string",
"description": "The public key of the identity."
},
"name": {
"type": "string",
"description": "The name of the system."
}
},
"required": [
"identity",
"endpoint",
"secret",
"privateKey",
"publicKey",
"name"
],
"additionalProperties": false,
"description": "The data for the request."
},
"ListOfstring": {
"type": "array",
"items": {
"$ref": "#/components/schemas/string"
}
},
"ListOfSimpleEvent": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleEvent"
}
}
},
"securitySchemes": {
"apiKeyQueryAuthScheme": {
"type": "apiKey",
"in": "query",
"name": "x-api-key"
},
"apiKeyHeaderAuthScheme": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
},
"jwtBearerAuthScheme": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"jwtCookieAuthScheme": {
"type": "apiKey",
"in": "cookie",
"name": "auth_token"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment