Context

See the Context definition to understand how this resource fits into the data model.

Get the context

Endpoint

GET /context

Response attributes

Name Type
id Name
copyright String
custodian Optional String
description Optional String
hashing-algorithm HashingAlgorithm
licence String
root-hash Hash
schema List of attributes
statistics Statistics
status Status
title Optional String

Hashing algorithm attributes

Name Type
digest-length Integer
function-type Integer
codec String

Attribute attributes

Name Type
id Name
datatype Datatype
cardinality Cardinality
title Optional String
description Optional String

Statistics attributes

Name Type
total-entries Integer
total-blobs Integer
total-records Integer

Status attributes

Name Type
start-date Datetime
end-date Optional Datetime
replacement Optional Url
reason Optional String

For example,

GET /context HTTP/1.1
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "multihash",
  "title": "The Multihash register",
  "description": "List of multihash codes.",
  "custodian": "IPFS team",
  "hashing-algorithm": {
    "codec": "sha2-256",
    "function-type": 18,
    "digest-length": 32
  },
  "statistics": {
    "total-entries": 0,
    "total-blobs": 0,
    "total-records": 0,
  },
  "copyright": "Copyright (c) 2016 Protocol Labs Inc.",
  "licence": "MIT",
  "root-hash": "1220e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "status": { "start-date": "2018-12" },
  "schema": [
    {"id": "name", "datatype": "name", "cardinality": "1"},
    {"id": "function-type", "datatype": "integer", "cardinality": "1"},
    {"id": "digest-length", "datatype": "integer", "cardinality": "1"}
  ]
}

© Crown copyright released under the Open Government Licence.