Incomplete. Use with caution.
Status
This schema is... |
|
|---|---|
under review |
|
complete |
|
Schema
Authority |
MMI Field Name |
CSpace field name |
DB table.field |
NXQL table:field |
notes |
|---|---|---|---|---|---|
Entity |
Display name |
Display name |
persons_common.displayname |
persons_common:displayName |
|
|
Lifespan |
Lifespan |
persons_mmi.lifespan |
persons_mmi:lifeSpan |
calculated |
|
Type |
Entity type |
persons_mmi.entitytype |
persons_mmi:entityType |
|
|
History notes |
Biographical Note |
persons_common.bionote |
persons_common:bioNote |
sometimes doesn't show in results if null value |
|
Source |
Source |
persons_mmi.namesource |
persons_mmi:nameSource |
|
|
Source notes |
Source note |
persons_mmi.sourcenote |
persons_mmi:sourceNote |
|
Production |
Name |
TBD |
|
|
|
|
History notes |
|
|
|
|
|
Source |
|
|
|
|
|
Source notes |
|
|
|
|
|
Attribute: Medium |
|
|
|
|
|
Attribute: Director |
|
|
|
|
|
Attribute: Release date |
|
|
|
|
|
Attribute: Running dates |
|
|
|
|
|
Attribute: Distributor |
|
|
|
|
|
Attribute: Network/cable company |
|
|
|
|
|
Attribute: Production company |
|
|
|
|
Publication \ Citation |
Name |
in development |
|
|
|
|
History notes |
|
|
|
|
|
Source |
|
|
|
|
|
Source notes |
|
|
|
|
|
Attribute: Publisher |
|
|
|
|
|
Attribute: Copyright holder |
|
|
|
|
Other parameters
In progress
Description |
NXQL string |
DB string |
API query string |
Required |
|---|---|---|---|---|
is object record deleted? |
|
|
Y |
|
sort by |
|
|
N |
Query construction
Searching through authority records via API calls requires prior knowledge of the parent authority CSID. For instance, the default person authority CSID can be gathered from a GET call: http://cspacedev.collectionspace.org:8180/cspace-services/personauthorities/ returns the CSID acc60b93-3a09-47eb-bd8f for authority with displayName 'Default Person Authority'.
The URL structure is formatted as such http://cspacedev.collectionspace.org:8180/cspace-services/personauthorities/acc60b93-3a09-47eb-bd8f/items?as=
Get cataloging records referencing a specific person authority record
This is currently broken for MMI.
Getting a list of cataloging records referencing a specific person authority record follows the same API construction listed in the previous section. An additional query path component is used, refObjs, to filter referencing cataloging, procedural or authority records. By default refObjs filters by procedural records but using a ?type=object parameter will filter by object record. Likewise, ?type=authority will filter by authorities.
This sample API call will not return any results due to a bug in how document types are listed internally.
An example API call would be like http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/acc60b93-3a09-47eb-bd8f/items/442a6f9e-e361-4369-a8e3/refObjs?type=object
Also see related Object References for authority term instances.
Additional links
Authority REST API for Hierarchies
Person Services REST APIs
Organization Services REST APIs
Common Services REST API