Skip to content

TED Services

Shane Isbell edited this page Nov 9, 2017 · 2 revisions

The ted scheme stands for text electronic delivery but also gives recognition to Ted Nelson, who originated the Xanadu concept. This section covers the operations that you can do on a ted URI.

Motivation

Tumbler addresses are an excellent way to define resources like documents and users. Udanax Green defines a set of RPC commands called the FEBE Protocol for querying and updating of these resources.

The motivation for the ted scheme is to create a uniform interface (for these tumbler resources) similar to HTTP GET, PUT, POST and DELETE. We also introduce some additional qualifiers and standards so that we can convert some of the Udanax protocols into one of these four resource operations. In some cases, this will increase the ease of use of the API at the the expense of the generality of a specific FEBE command.

TED Operations create resources, meta-data and topological links between data. Document Operations for editing text are those that operate directly on the streams and are compiled into a DocumentFile.

Format

A tumbler address with a ted scheme looks like

   ted://1.2.0.3.5.0.1.1.2.0.2.10

With the field elements being

<network> . <node> .0. <user> .0. <document> .0. <element>

The tumbler address itself is described in detail in the Object Model. We won't be covering the tumbler basics, just the ted specific extensions and uses.

Basic Operations

The following cover the basic PUT, GET, POST operations

Node

OP URI Description FEBE Protocol Equivalent
GET ted://1 Gets network information
GET ted://1/nodes Gets all nodes in network 1
GET ted://1.2 Gets node 2 information
PUT ted://1.2 Update/Create node 2 create-node-or-account

Users

OP URI Description FEBE Protocol Equivalent
GET ted://1.2/users Get all users of node 2
POST ted://1.2/users Create user create-node-or-account
GET ted://1.2.0.3.5 Get user 3.5 information
PUT ted://1.2.0.3.5 Update user 3.5

Documents

OP URI Description FEBE Protocol Equivalent
GET ted://1.2.0.3.5/documents Get list of all documents of user 3.5
POST ted://1.2.0.3.5/documents Create document create-new-document
GET ted://1.2.0.3.5.0.1.1.2 Get document 1.1.2 information
GET ted://1.2.0.3.5.0.1.1.2/endsets Get document endsets (pi op)
PUT ted://1.2.0.3.5.0.1.1.2 Update document 1.1.2
POST ted://1.2.0.3.5.0.1.1.2/newMajorVersion Create version 2.1.1 (copy of 1.1.2) create-new-version
POST ted://1.2.0.3.5.0.1.1.2/newMinorVersion Create version 1.2.1 (copy of 1.1.2) create-new-version
POST ted://1.2.0.3.5.0.1.1.2/newRevision Create version 1.1.3 (copy of 1.1.2) create-new-version

Links

OP URI Description FEBE Protocol Equivalent
GET ted://1.2.0.3.5.0.1.1.2/links Get list of links of document 1.1.2 (also see exp op, with params)
POST ted://1.2.0.3.5.0.1.1.2/links Create new link for document 1.1.2
PUT ted://1.2.0.3.5.0.1.1.2.0.2.1 Update link 2.1 with endsets create-link
GET ted://1.2.0.3.5.0.1.1.2.0.2.1 Get link info (endsets) follow-link

VSpans

OP URI Description FEBE Protocol Equivalent
GET ted://1.2.0.3.5.0.1.1.2/virtual Get list of vspans/text and linkIds of document 1.1.2 retrieve-v
GET ted://1.2.0.3.5.0.1.1.2.0.1.1~1.100 Get VSpan 1.1~1.100
Clone this wiki locally