| Div | ||
|---|---|---|
| ||
| Table of Contents |
|---|
Brief Description
...
Creates a new CitationAuthority record. Assigns a unique, service-specified CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 to that CitationAuthority record. Follows standard Create model. See the documentation of the CitationAuthority schema, below. Example:
| Code Block |
|---|
POST /cspace-services/citationauthorities HTTP/1.1
|
Read a CitationAuthority
Reads an existing CitationAuthority record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the CitationAuthority schema, below. Example:
| Code Block |
|---|
Update a CitationAuthority
Updates an existing CitationAuthority record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the CitationAuthority schema, below. Example:
| Code Block |
|---|
PUT /cspace-services/citationauthorities/{id} HTTP/1.1
|
Delete a CitationAuthority
Deletes an existing CitationAuthority record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:
| Code Block |
|---|
DELETE /cspace-services/citationauthorities/{id} HTTP/1.1
|
List CitationAuthority instances
...
- pgSz for page size
- pgNum for page number
Examples:
| Code Block |
|---|
GET /cspace-services/citationauthorities/ HTTP/1.1
GET /cspace-services/citationauthorities/?pgSz=10 HTTP/1.1
|
CitationAuthority REST payload schemas
...
Create and Update should use the following schema.
| Code Block |
|---|
Read will return the above, plus additional fields (uri and csid) for access:
| Code Block |
|---|
CitationAuthority-List schema
List (and variants) will return the following schema:
| Code Block |
|---|
Citation CRUD+L services
Citation instances are only accessible via the owning CitationAuthority. The sub-resource is accessed with "items" (for consistency across all vocabulary-like services). In the examples below, the {citation_auth_id} parameter represents the CSID value of an existing CitationAuthority instance.
...
Creates a new Citation record. Assigns a unique, service-specified CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 to that Citation record. Follows standard Create model. Must See the documentation of the Citation schema, below. Example:
| Code Block |
|---|
POST /cspace-services/citationauthorities/{citation-auth-id}/items HTTP/1.1
|
You may also POST a part called
| Code Block |
|---|
and any new relations there will be created. For example, this POST will add a relationship. Note that you must know beforehand the CSIDs of related terms. These are the CSIDs of two other Citation records, which must exist before this call. The special variable ${itemCSID} will be expanded to the CSID of the newly created Citation. (For Java use, please use the constant in CommonAPI.AuthorityItemCSID_REPLACE )
| Code Block |
|---|
<document name="citations">
<ns2:citations_common xmlns:ns2="http://collectionspace.org/services/citation" xmlns:ns3="http://collectionspace.org/services/jaxb">
<inAuthority>6ca3db57-7c96-47b6-b17d</inAuthority>
<shortIdentifier>Quiscustodietipsoscustodes1367585080203</shortIdentifier>
<citationTermGroupList>
<citationTermGroup>
<displayName>Quis custodiet ipsos custodes</displayName>
</citationTermGroup>
</citationTermGroupList>
...
</ns2:citations_common>
<ns3:relations-common-list xmlns:ns3="http://collectionspace.org/services/relation" xmlns:ns2="http://collectionspace.org/services/jaxb">
<relation-list-item>
<predicate>hasBroader</predicate>
<subject>
<csid>${itemCSID}</csid>
<documentType>Citation</documentType>
</subject>
<object>
<csid>a6d62e30-2bd6-439b-b19f</csid>
<uri>/cspace-services/citationauthorities/urn:cspace:name(citation)/items/a6d62e30-2bd6-439b-b19f</uri>
<documentType>Citation</documentType>
</object>
</relation-list-item>
</ns3:relations-common-list>
</document>
|
NOTE: if you wish to delete related items, simply send relations-common-list as an empty element. This is shown in a comment here:
http://wiki.collectionspace.org/display/collectionspace/Person+Service+REST+APIs?focusedCommentId=72220749&#comment-72220749
...
Reads an existing Citation record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the Citation schema, below. Example:
| Code Block |
|---|
GET /cspace-services/citationauthorities/{citation-auth-id}/items/{id} HTTP/1.1
|
There are additional query parameters to get the relations for this item.
Query Parameters are defined and explained here, with examples: Authority REST API for Hierarchies
Update a Citation in a CitationAuthority
Updates an existing Citation record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the Citation schema, below. Example:
| Code Block |
|---|
You may also PUT a part called
| Code Block |
|---|
and any new relations there will be created. Relations to the updated item which are missing from the relations list in the PUT will be deleted from persistence. No target records are deleted, just the relations records that point to target records. e.g. POST to authority with Citation "Drawing", with relations-common-list that has an entry for ${itemCSID} hasBroader "Art" creates a relations record that references both Art and Drawing. When a PUT is made that does not have the relation for Art, then Drawing has no relations, so the relations record for Drawing==>hasBroader==>Art is deleted, but both "Drawing" and "Art" Citation records remain.
...
Deletes an existing Citation record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:
| Code Block |
|---|
List Citation instances in a CitationAuthority
...
- pgSz for page size
- pgNum for page number
- pt for partial-term matching, to support term completion.
Examples:
| Code Block |
|---|
GET /cspace-services/citationauthorities/{citation-auth-id}/items/ HTTP/1.1
GET /cspace-services/citationauthorities/{citation-auth-id}/items/?pt=foo&pgSz=10 HTTP/1.1
|
Citation REST payload schemas
...
Here's an example payload for creating a new instance:
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<document name="citations">
<ns2:citations_common xmlns:ns2="http://collectionspace.org/services/citation" xmlns:ns3="http://collectionspace.org/services/jaxb">
<inAuthority>6ca3db57-7c96-47b6-b17d</inAuthority>
<shortIdentifier>Quiscustodietipsoscustodes1367585080203</shortIdentifier>
<citationTermGroupList>
<citationTermGroup>
<displayName>Quis custodiet ipsos custodes</displayName>
<termLanguage>urn:cspace:core.collectionspace.org:vocabularies:name(languages):item:name(eng)'English'</termLanguage>
</citationTermGroup>
</citationTermGroupList>
...
</ns2:citations_common>
</document>
|
Read will return the above, plus additional fields (uri and csid) for access:
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<document name="citations">
<ns2:collectionspace_core xmlns:ns2="http://collectionspace.org/collectionspace_core/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<uri>/citationauthorities/afbb91ca-3988-4524-bada</uri>
...
</ns2:collectionspace_core>
<ns2:citations_common xmlns:ns2="http://collectionspace.org/services/citation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<csid>afbb91ca-3988-4524-bada</csid>
...
</ns2:citations_common>
</document>
|
Citation-List schema
List (and variants) will return a schema similar to the following example:
| Code Block |
|---|
| Code Block |
|---|