interface.json

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.1",
    "title": "MarketplaceCore Database Rest API",
    "contact": {
      "name": "TRUMPF Werkzeugmaschinen GmbH & Co KG"
    },
    "description": ""
  },
  "host": "tdm-core.axoom.cloud",
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "securityDefinitions": {
    "Core_Auth": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://tdm-jmw.axoom.cloud/oauth/authorise",
      "tokenUrl": "https://tdm-jmw.axoom.cloud/oauth/token",
      "scopes": {
        "default": "Undefined"
      }
    }
  },
  "paths": {
    "/technologydata": {
      "post": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Create technology data",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TechnologyDataSaveDataBody"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Operation successful",
            "headers": {
              "location": {
                "description": "The path to the technologydata (technologydatauuid)",
                "type": "string"
              }
            },
            "schema": {
              "$ref": "#/definitions/TechnologyData"
            }
          },
          "400": {
            "description": "bad request"
          },
          "401": {
            "description": "Authentication required"
          }
        }
      },
      "get": {
        "description": "Gets a list of technologydata",
        "parameters": [
          {
            "name": "user",
            "in": "query",
            "type": "string"
          },
          {
            "name": "components",
            "in": "query",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          {
            "name": "technology",
            "in": "query",
            "type": "string"
          },
          {
            "name": "technologydataname",
            "in": "query",
            "type": "string"
          },
          {
            "name": "ownerUUID",
            "in": "query",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TechnologyData"
              }
            }
          },
          "400": {
            "description": "bad request"
          }
        }
      }
    },
    "/technologydata/{technologyDataId}": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Gets the technology data for a specific identifier",
        "parameters": [
          {
            "name": "technologyDataId",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TechnologyData"
              }
            }
          },
          "400": {
            "description": "bad request"
          },
          "401": {
            "description": "Authorization required"
          },
          "404": {
            "description": "technologydata not found"
          }
        }
      }
    },
    "/technologydata/{technologyDataId}/content": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Gets the encrypted technology data for a specific identifier",
        "parameters": [
          {
            "name": "technologyDataId",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "schema": {
              "$ref": "#/definitions/TechnologyDataContent"
            }
          },
          "400": {
            "description": "bad request"
          },
          "401": {
            "description": "Authorization required"
          },
          "404": {
            "description": "technologydata not found"
          }
        }
      }
    },
    "/technologydata/{technologyDataId}/image": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "The image for a specific technology data",
        "parameters": [
          {
            "name": "technologyDataId",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "string",
              "format": "byte"
            }
          },
          "404": {
            "description": "Image not found"
          }
        }
      }
    },
    "/technologydata/{technologyDataId}/components": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "The image for a specific technology data",
        "parameters": [
          {
            "name": "technologyDataId",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/TechnologyData"
              }
            }
          },
          "400": {
            "description": "bad request"
          },
          "404": {
            "description": "technologydata not found"
          }
        }
      }
    },
    "/offers": {
      "post": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Create a new offer",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/OfferRequestBody"
            }
          },
          {
            "name": "userUUID",
            "in": "query",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "201": {
            "description": "Operation successful",
            "schema": {
              "$ref": "#/definitions/Invoice"
            }
          },
          "400": {
            "description": "bad request"
          }
        }
      }
    },
    "/offers/{id}": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Get a offer based on the id",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "offerid to search for",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Offer"
              }
            }
          },
          "400": {
            "description": "bad request"
          },
          "404": {
            "description": "offer not found"
          }
        }
      }
    },
    "/components": {
      "post": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Create a new component",
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Components"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Operation successful",
            "headers": {
              "location": {
                "description": "The path to the component (componentuuid)",
                "type": "string"
              }
            },
            "schema": {
              "$ref": "#/definitions/Components"
            }
          },
          "400": {
            "description": "bad request"
          }
        }
      },
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Get component for the given componentName or get all components",
        "parameters": [
          {
            "name": "componentName",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operation successful",
            "schema": {
              "$ref": "#/definitions/Components"
            }
          },
          "400": {
            "description": "bad request"
          }
        }
      }
    },
    "/components/{id}": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "Get component for the given id",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operation successful",
            "schema": {
              "$ref": "#/definitions/Components"
            }
          },
          "400": {
            "description": "bad request"
          },
          "404": {
            "description": "component not found"
          }
        }
      }
    },
    "/vault/users/{userId}/balance": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "returns the current balance of the license fee income in the vault for a given User UUID",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "description": "the user id for which the balance is displayed",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "the balance in coin",
            "schema": {
              "type": "integer"
            }
          },
          "404": {
            "description": "the user is unknown"
          }
        }
      }
    },
    "/vault/users/{userId}/wallets": {
      "get": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "returns the vault wallets for a user UUID",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "description": "the user id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "the balance in coin",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Wallet"
              }
            }
          },
          "404": {
            "description": "the user is unknown"
          }
        }
      }
    },
    "/vault/users/{userId}/wallets/{walletId}/payouts": {
      "post": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "create a payout at the vault for a user and its wallet",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "description": "the user id",
            "required": true,
            "type": "string"
          },
          {
            "name": "walletId",
            "in": "path",
            "description": "the wallet id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "the payout to create",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Payout"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "the created Payout",
            "schema": {
              "$ref": "#/definitions/Payout"
            }
          },
          "404": {
            "description": "the user is unknown"
          },
          "409": {
            "description": "the wallet balance is to low for this"
          }
        }
      }
    },
    "/vault/users/{userId}/wallets/{walletId}/payouts/check": {
      "post": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "check a payout at the vault for a user and its wallet",
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "description": "the user id",
            "required": true,
            "type": "string"
          },
          {
            "name": "walletId",
            "in": "path",
            "description": "the wallet id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "the payout to create",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Payout"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "the created Payout",
            "schema": {
              "$ref": "#/definitions/PayoutCheck"
            }
          },
          "404": {
            "description": "the user is unknown"
          },
          "409": {
            "description": "the Wallet balance is to low",
            "schema": {
              "$ref": "#/definitions/PayoutCheck"
            }
          }
        }
      }
    },
    "/protocols/{clientId}": {
      "post": {
        "security": [
          {
            "Core_Auth": [
              "default"
            ]
          }
        ],
        "description": "A machine can post information on its usage",
        "parameters": [
          {
            "in": "path",
            "name": "clientId",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "protocol",
            "schema": {
              "$ref": "#/definitions/Protocol"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Logging accepted"
          }
        }
      }
    }
  },
  "/protocols": {
    "get": {
      "security": [
        {
          "Core_Auth": [
            "admin"
          ]
        }
      ],
      "description": "Route to retrieve protocol data. For admins only.",
      "parameters": [
        {
          "name": "eventType",
          "in": "query",
          "description": "protocol event type",
          "required": true,
          "type": "string"
        },
        {
          "name": "from",
          "in": "query",
          "description": "from date to filter query",
          "required": true,
          "type": "datetime"
        },
        {
          "name": "to",
          "in": "query",
          "description": "to date to filter query",
          "required": true,
          "type": "datetime"
        },
        {
          "name": "clientId",
          "in": "query",
          "description": "cleintid for filter query",
          "type": "string"
        },
        {
          "name": "limit",
          "in": "query",
          "description": "limits the result amount",
          "default": 100,
          "type": "integer"
        }
      ],
      "responses": {
        "200": {
          "description": "the created Payout",
          "schema": {
            "$ref": "#/definitions/Protocol"
          }
        }
      }
    }
  },
  "/protocols/last": {
    "get": {
      "security": [
        {
          "Core_Auth": [
            "admin"
          ]
        }
      ],
      "description": "Route to retrieve last protocol data for each client. For admins only.",
      "parameters": [
        {
          "name": "eventType",
          "in": "query",
          "description": "protocol event type",
          "required": true,
          "type": "string"
        },
        {
          "name": "from",
          "in": "query",
          "description": "from date to filter query",
          "required": true,
          "type": "datetime"
        },
        {
          "name": "to",
          "in": "query",
          "description": "to date to filter query",
          "required": true,
          "type": "datetime"
        }
      ],
      "responses": {
        "200": {
          "description": "the created Payout",
          "schema": {
            "$ref": "#/definitions/Protocol"
          }
        }
      }
    }
  },
  "definitions": {
    "Protocol": {
      "type": "object",
      "properties": {
        "eventType": {
          "type": "string"
        },
        "timestamp": {
          "type": "string",
          "format": "datetime"
        },
        "payload": {
          "type": "object",
          "properties": {}
        }
      }
    },
    "Payout": {
      "description": "object describing a payout job",
      "type": "object",
      "properties": {
        "payoutId": {
          "type": "string",
          "format": "uuid"
        },
        "payoutAddress": {
          "type": "string"
        },
        "amount": {
          "type": "integer",
          "format": "int32"
        },
        "emptyWallet": {
          "type": "boolean",
          "description": "if true, the amount value will be the maximum value paid out. but it will also payout if there is less balance in the wallet"
        },
        "referenceId": {
          "type": "string",
          "description": "a place to put describing information"
        }
      }
    },
    "PayoutCheck": {
      "description": "The result object of payout checks",
      "type": "object",
      "properties": {
        "fee": {
          "type": "integer",
          "format": "long"
        },
        "remaining": {
          "type": "integer",
          "format": "long"
        }
      }
    },
    "Wallet": {
      "type": "object",
      "properties": {
        "walletId": {
          "type": "string",
          "format": "UUID"
        },
        "unconfirmed": {
          "type": "number"
        },
        "confirmed": {
          "type": "number"
        }
      }
    },
    "Offer": {
      "type": "object",
      "properties": {
        "offeruuid": {
          "type": "string"
        },
        "paymentinvoiceuuid": {
          "type": "string"
        },
        "createdat": {
          "type": "string"
        },
        "createdby": {
          "type": "string"
        }
      }
    },
    "TechnologyDataSaveDataBody": {
      "type": "object",
      "properties": {
        "technologyDataName": {
          "type": "string"
        },
        "technologyData": {
          "type": "string",
          "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
          "minLength": 1,
          "maxLength": 100000
        },
        "technologyDataDescription": {
          "type": "string"
        },
        "technologyUUID": {
          "type": "string"
        },
        "licenseFee": {
          "type": "number"
        },
        "tagList": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "tagName": {
                "type": "string"
              }
            }
          }
        },
        "componentList": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "componentName": {
                "type": "string"
              }
            }
          }
        },
        "backgroundColor": {
          "type": "string",
          "maxLength": 9,
          "pattern": "^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$"
        },
        "image": {
          "type": "string",
          "maxLength": 10000
        }
      }
    },
    "TechnologyData": {
      "type": "object",
      "properties": {
        "technologydataid": {
          "type": "integer"
        },
        "technologydataname": {
          "type": "string"
        },
        "technologydatadescription": {
          "type": "string"
        },
        "licensefee": {
          "type": "number"
        }
      }
    },
    "TechnologyDataContent": {
      "type": "string"
    },
    "OfferRequestBody": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "dataId": {
                "type": "string"
              },
              "amount": {
                "type": "integer"
              }
            }
          }
        },
        "hsmId": {
          "type": "string"
        }
      }
    },
    "Invoice": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "invoice": {
          "type": "string"
        }
      }
    },
    "Components": {
      "type": "object",
      "properties": {
        "componentName": {
          "type": "string"
        },
        "componentParentName": {
          "type": "string"
        },
        "componentDescription": {
          "type": "string"
        },
        "attributeList": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "technologyList": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}