Skip to main content

create Digital Twin

POST 
/api/gemini/v1/digital-twin

create a Digital Twin for an entity using the registry provided within the body

Request​

Body

required

The object identifier and optional service endpoints, which provides additional information to the physical object

    identifier stringrequired
    the unique identifier of the physical / real item
    objectType stringrequired
    the kind / object of the physical / real item.
    could although be used to cluster objects into groups like bottles-1l, bottles-500ml
    registryName string

    Default value: Polygon Mumbai Testnet

    The ledger to be used, if not provided the default ledger of the project/client will be used. 
    Only registries defined for the project/client combination can be used. 
    Only "Polygon Mumbai Testnet" is initially supported

    serviceEndpoints

    object[]

    A list of additional endpoints, which should be added to the Digital Twin. This operation is asynchronous and requires a ledger transaction. So the result will no be immediately available

  • Array [

    • serviceEndpoint stringrequired
    the endpoint url providing additional services / information for the digital twin
    type string

    Default value: LinkedDomain

    categorization of the provided service url, if not maintained, LinkedDomain will be used.
    Only chars a-z or A-Z are allowed

  • ]

Responses​

the created Digital Twin, be aware if services were added

Schema

    did stringrequired
    the decentralized identifier of the physical object. see https://www.w3.org/TR/did-core/
    alias string
    the alias used for identifying the did. This could be a human readable identifier for did:web or the public address of a ledger based did
    provider stringrequired
    the protocol, method and optional the ledger identifier of the did.
    Protocol is did
    method for example ethr
    and ledger identifier polygon:mumbai
    controllerKeyId string
    the public ledger address of the controller / owner of a Digital Twin / DID

    keys

    object[]

    required

    A list of key materials used for verification, access and ownership.

  • Array [

    • kid stringrequired

    identifier of the Key, acts like an alias for the key

    kms stringrequired

    the key management system of the key

    type string

    Key algorithm

    publicKeyHex stringrequired

    public part of the key as a string in hex format

    privateKeyHex stringdeprecated

    the private part of the key, based on the security reasons will not be returned

    meta

    object

    algorithms string[]

    a lis tof supported key algorithm

  • ]

    • services

    object[]

    required

    A list of service endpoints, providing additional information to the digital twin

  • Array [

    • id stringrequired
    the identifier of the service. Required for deletion operation
    type stringrequired

    Default value: LinkedDomain

    categorization of the provided service url, if not maintained, LinkedDomain will be used.
    Only chars a-z or A-Z are allowed
    serviceEndpoint stringrequired
    the endpoint url providing additional services / information for the digital twin
    description string
    Endpoint is providing additional material information like Certificates and hazardous information

  • ]

Loading...