MARS documentation
API reference

Get entry

Contract and client context

Operation: get_entry · HTTP: GET /v1/entries/{did}

Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.

Exact operation definition
{
  "operationId": "get_entry",
  "parameters": [
    {
      "description": "OAS DID of the entry",
      "in": "path",
      "name": "did",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MarsEntry"
          }
        }
      },
      "description": "Latest entry"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Entry not found"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Read rate limit exceeded"
    }
  },
  "tags": [
    "entries"
  ]
}

Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.

GET/v1/entries/{did}

Path Parameters

did*string

OAS DID of the entry

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/entries/string"
{  "accessPolicy": null,  "anchorState": "unanchored",  "bondReference": null,  "customMetadata": {    "property1": null,    "property2": null  },  "description": "string",  "entryDid": "string",  "entryType": "AgentDefinition",  "itemData": null,  "itemDataHash": "string",  "itemSchemaUri": "string",  "lifecycleStatus": "draft",  "lineageReference": null,  "marsVersion": "string",  "name": "string",  "publishedAt": "2019-08-24T14:15:22Z",  "publisherDid": "string",  "relationships": [    {      "label": "string",      "relationshipType": "dependsOn",      "targetDid": "string"    }  ],  "semanticAnnotations": [    {      "objectLiteral": "string",      "objectUri": "string",      "predicateUri": "string"    }  ],  "sequence": 0,  "serviceEndpoints": [    {      "id": "string",      "priority": 0,      "properties": {        "property1": null,        "property2": null      },      "type": "string",      "url": "string"    }  ],  "shardAssignment": "string",  "signature": {    "algorithm": "string",    "created": "string",    "keyId": "string",    "value": "string"  },  "tags": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z",  "verifiableAttestations": [    null  ],  "version": "string"}