Skip to main content
Jump to: navigation, search

BaSyx / Documentation / API / Registry

The BaSyx discovery API is implemented by BaSyx discovery services. Discovery services enable the discovery of conforming production entities, which are production entities that export an Asset Administration Shell (AAS). The Asset Administration Shell is a data structure that describes the production entity. It provides basic data and a directory of sub models that describe specific aspects of production entities. Production entities may be any entity that is relevant to production. This includes products under production, devices, workers, but also non-physical entites such as placed orders, and as well products that have been sold. The discrovery service enables discovery and management of Asset Administration Shells via a defined HTTP REST interface.


GET /api/v1/registry Description
  • Retrieves all (locally) registered Asset Administration Shells


Response codes

  • 200: Returns JSON-serialized list of found Asset Administration Shells
  • 400: Bad Request
  • 502: Bad Gateway
POST /api/v1/registry Description
  • Registers a new Asset Administration Shell


Parameter

  • (body): New Asset Administration Shell data is transmitted in body using JSON serialization


Response codes

  • 201: The Asset Administration Shell was created successfully
  • 400: Bad Request
  • 502: Bad Gateway
GET /api/v1/registry/{aasId} Description
  • Retrieves a specific Asset Administration Shell


Parameter

  • aasId: ID of a registered Asset Administration Shell


Response codes

  • 200: Returns the requested Asset Administration Shell
  • 400: Bad Request
  • 404: No Asset Administration Shell found
  • 502: Bad Gateway
PUT /api/v1/registry/{aasId} Description
  • Renews a specific Asset Administration Shell's registration


Parameter

  • aasId: ID of a registered Asset Administration Shell
  • (body): New Asset Administration Shell data is transmitted in body using JSON serialization


Response codes

  • 204: The Asset Administration Shell’s registration was successfully renewed
  • 400: Bad Request
  • 502: Bad Gateway


DELETE /api/v1/registry/{aasId} Description
  • Deletes a specific Asset Administration Shell


Parameter

  • aasId: ID of a registered Asset Administration Shell


Response codes

  • 204: The Asset Administration Shell was deleted successfully
  • 400: Bad Request
  • 502: Bad Gateway


BaSyx project links: Project BaSyx main wiki page | What is BaSyx? | BaSyx Developer Documentation

Back to the top