-
Notifications
You must be signed in to change notification settings - Fork 9
Api example: register read
der edited this page Mar 27, 2015
·
17 revisions
- Internal state of registry
- Result of a read operation on the root register
- Result of read operation on register /reg1
- Just read the metadata for /reg1
- Read the full item metadata for /reg1
- Paged listing of /reg1
- Return the full metadata and version information for /reg1
We show a registry state with one register (/reg1) added to the root register and one external entity registered within /reg1.
Note that the act of creating the register, registering an entity, updating the status of the entity would in fact require several steps and so would result in several versions of each resource being created. We omit most of these versions here just for clarity.
Note also that in this example we use bNodes for some nested resources such as intervals. An implementation may choose to use URI resources instead to simplify data management.
# The root register
<http://registry> a reg:Register, version:VersionedThing ;
.
<http://registry:2> a reg:Register, version:Version;
dct:isVersionOf <http://registry/reg>;
owl:versionInfo "2";
rdfs:label "root"@en;
dct:description "The root register"@en;
reg:owner <http://example.com/UKLocation> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass reg:Register;
dct:replaces <http://registry:1>;
version:interval [ time:hasBeginning [ time:inXSDDateTime "2012-11-11T08:00:00Z"^^xsd:dateTime ] ];
.# A register
<http://registry/reg1> a reg:Register, version:VersionedThing, skos:Collection ;
ldp:membershipPredicate skos:member;
.
<http://registry/reg1:1> a reg:Register, version:Version, skos:Collection;
dct:isVersionOf <http://registery/reg1>;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
version:interval [ time:hasBeginning [ time:inXSDDateTime "2012-11-11T07:00:00Z"^^xsd:dateTime ] ];
.# item record linking the register to the root register
<http://registry/_reg1> a reg:RegisterItem, version:VersionedThing;
reg:register <http://registry/reg> ;
reg:notation "reg1";
reg:itemClass reg:Register;
.
<http://registry/_reg1:2> a reg:RegisterItem, version:Version;
dct:isVersionOf <http://registry/reg1>;
owl:versionInfo "2";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
dct:dateSubmitted "2012-11-11T09:00:00Z"^^xsd:dateTime ;
dct:dateAccepted "2012-11-11T09:10:00Z"^^xsd:dateTime ;
reg:status reg:statusValid ;
reg:definition <http://registry/reg1#entityRef> ;
dct:replaces <http://registry/reg1:1> ;
version:interval [ time:hasBeginning [ time:inXSDDateTime "2012-11-11T09:00:00Z"^^xsd:dateTime ] ];
.
<http://registry/reg1#entityRef> a reg:EntityReference;
reg:entity <http://registry/reg1> ;
.# A single external entry registered in register /reg1
<http://registry/reg1/_myconcept> a reg:RegisterItem, version:VersionedThing;
reg:register <http://registry/reg1> ;
reg:notation "myconcept";
reg:itemClass skos:Concept;
.
<http://registry/reg1/_myconcept:0> a reg:RegisterItem, version:Version;
dct:isVersionOf <http://registry/reg1/_myconcept>;
owl:versionInfo "0";
rdfs:label "My concept"@en;
dct:description "An externally defined entity"@en;
dct:dateSubmitted "2012-11-11T09:20:00Z"^^xsd:dateTime ;
dct:dateAccepted "2012-11-11T09:20:00Z"^^xsd:dateTime ;
reg:status reg:statusValid ;
reg:definition <http://registry/reg1/_myconcept:v0#entityRef> ;
version:interval [
time:hasBeginning [ time:inXSDDateTime "2012-11-11T09:20:00Z"^^xsd:dateTime ]
time:hasEnd [ time:inXSDDateTime "2012-11-11T09:40:00Z"^^xsd:dateTime ]
];
.
<http://registry/reg1/_myconcept:0#entityRef> a reg:EntityReference;
reg:entity <http://example.com/mywebsite/myconcept> ;
reg:sourceGraph <http://registry/reg1/_myconcept:0#graph> ;
.# The named graph containing the stored copy of the external item
<http://registry/reg1/_myconcept:0#graph> {
<http://example.com/mywebsite/myconcept> a skos:Concept;
rdfs:label "My concept"@en;
dct:description "An externally defined entity"@en;
.
}# An updated version of the entry
<http://registry/reg1/_myconcept:1> a reg:RegisterItem, version:Version;
dct:isVersionOf <http://registry/reg1/_myconcept>;
owl:versionInfo "1";
dct:replaces <http://registry/reg1/_myconcept:0>;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
dct:dateSubmitted "2012-11-11T09:40:00Z"^^xsd:dateTime ;
dct:dateAccepted "2012-11-11T09:40:00Z"^^xsd:dateTime ;
reg:status reg:statusValid ;
reg:definition <http://registry/reg1/_myconcept:1#entityRef> ;
version:interval [ time:hasBeginning [ time:inXSDDateTime "2012-11-11T09:40:00Z"^^xsd:dateTime ] ];
.
<http://registry/reg1/_myconcept:1#entityRef> a reg:EntityReference;
reg:entity <http://example.com/mywebsite/myconcept> ;
reg:sourceGraph <http://registry/reg1/_myconcept:1#graph> ;
.# The named graph containing the stored copy of the external item
<http://registry/reg1/_myconcept:1#graph> {
<http://example.com/mywebsite/myconcept> a skos:Concept;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
.
}| GET | http://registry |
Results in returned payload:
<http://registry> a reg:Register ;
owl:versionInfo "2";
rdfs:label "root"@en;
dct:description "The root register"@en;
reg:owner <http://example.com/UKLocation> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass reg:Register;
rdfs:member <http://registry/reg1> ;
.
<http://registry/reg1> a reg:Register, skos:Collection ;
ldp:membershipPredicate skos:member;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
.Note: The VersionedThing and Version resources have been merged together for ease of consumption.
Note: The RegisterItem metadata has been omitted and instead a direct membership predicate asserted from the register (the root register in this case) to the entity in the definition of the registered item (in this case http://registry/reg1).
Note: Since no explicit ldp:membershipPredicate is defined for the root register the default of rdfs:member is used to relate the container to its entries.
| GET | http://registry/reg1 |
Results in returned payload:
<http://registry/reg1> a reg:Register, skos:Collection ;
ldp:membershipPredicate skos:member;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
skos:member <http://example.com/mywebsite/myconcept>;
.
<http://example.com/mywebsite/myconcept> a skos:Concept;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
. Note: In this case there is an explicit declaration of ldp:membershipPredicate which is used to list the contents of the register.
Note: Only the latest version information has been returned.
Note: The stored description of the relevant version of the registered entity has been retrieved from its named graph and included in the return result.
| GET | http://registry/reg1?non-member-properties |
Results in returned payload:
<http://registry/reg1> a reg:Register, skos:Collection ;
ldp:membershipPredicate skos:member;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
.| GET | http://registry/reg1?_view=with_metadata |
Results in returned payload:
<http://registry/reg1> a reg:Register, skos:Collection ;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
skos:member <http://example.com/mywebsite/myconcept>;
.
<http://registry/reg1/_myconcept> a reg:RegisterItem;
reg:register <http://registry/reg1> ;
reg:notation "myconcept";
reg:itemClass skos:Concept;
owl:versionInfo "1";
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
dct:dateSubmitted "2012-11-11T09:40:00Z"^^xsd:dateTime ;
dct:dateAccepted "2012-11-11T09:40:00Z"^^xsd:dateTime ;
reg:status reg:statusValid ;
reg:definition <http://registry/reg1/_myconcept:1#entityRef> ;
.
<http://registry/reg1/_myconcept:1#entityRef> a reg:EntityReference;
reg:entity <http://example.com/mywebsite/myconcept> ;
.
<http://example.com/mywebsite/myconcept> a skos:Concept;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
. Note: The relevant version of the regsitered entity itself has been retrieved from its named graph and included in the response payload.
| GET | http://registry/reg1?firstPage |
Results in returned payload:
<http://registry/reg1> a reg:Register, skos:Collection ;
ldp:membershipPredicate skos:member;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
skos:member <http://example.com/mywebsite/myconcept>;
.
<http://registry/reg1?firstPage> a ldp:Page;
ldp:pageOf <http://registry/reg1>;
# ldp:nextPage omited because there isn't one, pattern would be <http://registry/reg1?_page=1>;
lda:items ( <http://example.com/mywebsite/myconcept> ) ;
.
<http://example.com/mywebsite/myconcept> a skos:Concept;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
. Note: The page includes an ordered list of the entries on that page. Experience with the Linked Data API indicates that this explicit listing of page members is very useful to simplify client implementations, include HTML rendering. The current draft of the Linked Data Platform Container specification does not have an equivalent mechanism. For the purposes of this example we use lda:items to convey the explicit list. We intend to raise this issue with the W3C LDP working group. If an official equivalent ldp: property is created that will be preferred.
| GET | http://registry/reg1?_view=version,with_metadata |
Results in returned payload:
<http://registry/reg1> a reg:Register, version:VersionedThing, skos:Collection ;
ldp:membershipPredicate skos:member;
version:currentVersion <http://registry/reg1:1>;
.
<http://registry/reg1:1> a reg:Register, version:Version, skos:Collection;
dct:isVersionOf <http://registery/reg1>;
owl:versionInfo "1";
rdfs:label "register 1"@en;
dct:description "Example register 1"@en;
reg:owner <http://example.com/department> ;
reg:manager <http://example.com/registryManagementLtd> ;
reg:containedItemClass skos:Concept;
ldp:membershipPredicate skos:member;
version:interval [ time:hasBeginning [ time:inXSDDateTime "2012-11-11T07:00:00Z"^^xsd:dateTime ] ];
skos:member <http://example.com/mywebsite/myconcept>;
.
<http://registry/reg1/_myconcept> a reg:RegisterItem, version:VersionedThing;
reg:register <http://registry/reg1> ;
reg:notation "myconcept";
reg:itemClass skos:Concept;
version:currentVersion <http://registry/reg1/_myconcept:1>;
.
<http://registry/reg1/_myconcept:1> a reg:RegisterItem, version:Version;
dct:isVersionOf <http://registry/reg1/_myconcept>;
owl:versionInfo "1";
dct:replaces <http://registry/reg1/_myconcept:0>;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
dct:dateSubmitted "2012-11-11T09:40:00Z"^^xsd:dateTime ;
dct:dateAccepted "2012-11-11T09:40:00Z"^^xsd:dateTime ;
reg:status reg:statusValid ;
reg:definition <http://registry/reg1/_myconcept:1#entityRef> ;
version:interval [ time:hasBeginning [ time:inXSDDateTime "2012-11-11T09:40:00Z"^^xsd:dateTime ] ];
.
<http://registry/reg1/_myconcept:1#entityRef> a reg:EntityReference;
reg:entity <http://example.com/mywebsite/myconcept> ;
.
<http://example.com/mywebsite/myconcept> a skos:Concept;
rdfs:label "My shiny concept"@en;
dct:description "An externally defined entity"@en;
. Note: Returns only the current version and includes an inferred version:currentVersion link.
Note: It is possible to use the dct:replaces link to find the URI of a previous version of any resource and then retrieve that, and so walk back up the version graph.