Push Service

The twinsphere push service allows you to push serialized asset administration shells from your twinsphere tenant to any of the configurable endpoints. Take a look at the Swagger for more API documentation around each parameter and return value.

To send AAS data to a desired target, the following procedure must be followed:

1. Create a valid target via the API
2. Create a new push job with the IDs of the shells and submodels you want to push

Target management

Target management is performed through /sphere/push/targets/* endpoints.

To create or update a target, use the /sphere/push/targets/{name} endpoint (you need to choose a name for the target yourself), and post the JSON configuration as the body depending on the target itself (see supported targets below).

Note Please make sure that the target is reachable from the internet!

Supported Targets

Azure Blob Storage

To connect to the Azure Blob Storage, you need to create a Blob container in advance. Please issue a Shared access token with full rights, and insert the "Blob SAS URL" with the configuration body as in the example below:

{
  "name": "...",
  "type": "azure-blob-storage",
  "configuration": {
    "blobSasUrl": "..."
  }
}

Note blobSasUrl should include the http target, blob container name and the secret required for the connection! Make sure to use the URL value starting with https

Connection information will be handled as secret and stored in encrypted form.

Job management

To perform a push from twinsphere repository to one of your targets, you have to create a push job. Push jobs are managed through /sphere/push/jobs/* endpoints.

Since push jobs can take longer time to perform, asynchronous REST pattern is used. Job you POST on /sphere/push/jobs will return an identifier, which you can use with GET on /sphere/push/jobs/{id} to query the state of the job.

Refer to Swagger documentation (on /swagger/index.html) for the push job configuration options. We currently support pushing of shells, submodels and concept descriptions. Output serialization formats supported are: - application/json - application/xml - application/asset-administration-shell-package+json

If the job failed, you can see the reason inside the message property. Most issue occur due to invalid target configuration parameters or network connectivity issues between the twinsphere service and the target itself.

If you can not do anything with the error in the message, please contact our support and ask for more detailed help.