Skip to main content

get Digital Twin

GET 

https://api.mtrust.io/api/gemini/v1/digital-twin/object/:objectId

get Digital Twin for the Id of the physical Object, resolve the DID document of the Digital Twin by handing over the Object Id

Request

Path Parameters

    objectId stringrequired

    the physical object identifier

Responses

DID identifier base don the M-Trust agent
Schema
    did stringrequired
    the decentralized identifier of the physical object. see https://www.w3.org/TR/did-core/
    Example: did:ethr:polygon:mumbai:0x023b1de7d53ebe9d97015514f44610702d889528fa0f00ffab8893c89426129462
    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
    Example: 0b6fe947a3add76d66ab697a46c1268e399366f98b44baf172cbb73762bbb01a
    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
    Example: did:ethr:polygon:mumbai
    controllerKeyId string
    the public ledger address of the controller / owner of a Digital Twin / DID
    Example: 043b1de7d53ebe9d97015514f44610702d889528fa0f00ffab8893c89426129462a4266843f80b98fdc76077c066d89fae807a8d314e4c3947976fd64f726ee6da
    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

    Example: 043b1de7d53ebe9d97015514f44610702d889528fa0f00ffab8893c89426129462a4266843f80b98fdc76077c066d89fae807a8d314e4c3947976fd64f726ee6da
    kms stringrequired

    the key management system of the key

    Example: local
    type string

    Key algorithm

    Example: Secp256k1
    publicKeyHex stringrequired

    public part of the key as a string in hex format

    Example: 043b1de7d53ebe9d97015514f44610702d889528fa0f00ffab8893c89426129462a4266843f80b98fdc76077c066d89fae807a8d314e4c3947976fd64f726ee6da
    privateKeyHex stringdeprecated

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

    meta object

    Key metadata. This should be used to determine which algorithms are supported

    algorithms string[]

    a lis tof supported key algorithm

    Example: ["ES256K","ES256K-R","eth_signTransaction","eth_signTypedData","eth_signMessage","eth_rawSign"]
  • ]
  • 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
    Example: did:example:123456789#service-1
    type stringrequired
    categorization of the provided service url, if not maintained, LinkedDomain will be used.
    Only chars a-z or A-Z are allowed
    Default value: LinkedDomain
    Example: LinkedDomain
    serviceEndpoint stringrequired
    the endpoint url providing additional services / information for the digital twin
    Example: https://foo.bar
    description string
    Endpoint is providing additional material information like Certificates and hazardous information
    Example: The purpose and/or additional information to the service endpoint
  • ]
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.mtrust.io/api/gemini/v1/digital-twin/object/:objectId");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.mtrust.io
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!