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 |
|
|
Type |
Entity type (CL) |
persons_mmi.entitytype |
persons_mmi:entityType |
|
|
History notes |
Biographical Note |
persons_common.bionote |
persons_common:bioNote |
|
|
Source |
Source (CL) |
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 |
|
|
|
|
The fields marked (CL) describe a field that is a controlled list (HTML select element). The returned value is a non-spaced string. Please see Controlled List mapping for a mapping of controlled list strings to displayed values.
Other parameters
In progress
Description |
NXQL string |
DB string |
API query string |
Required |
|---|---|---|---|---|
is object record deleted? |
|
|
Y |
|
sort by |
|
|
N |
Using short ID in place of CSIDs
Foreknowledge of the parent authority CSID is no longer necessary. Only the short ID of the parent authority needs be known, which for MMI is urn:cspace:name(person). Likewise, the CSID of the person authority record can be replaced with the short ID of that record.
The URL structure can be formatted with CSIDs
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/acc60b93-3a09-47eb-bd8f/f23e6629-53e1-4021-82be-58e70f34e0fc/
or with short IDs
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/urn:cspace:name(person)/urn:cspace:name(oc2584)
Also see /wiki/spaces/collectionspace/pages/666273476.
Get cataloging records referencing a specific person authority record
This is currently broken for MMI. A patch will be applied for the development servers soon.
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, i.e. records that are not collectionobjects nor authorities, but using a ?type=object parameter will filter by object record. Likewise, ?type=authority will filter by authorities.
An example API call would be a such
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/urn:cspace:name(person)/items/442a6f9e-e361-4369-a8e3/refObjs?type=object
Also see related Object References for authority term instances.
Controlled List mapping
Entity - Type
Controlled list string |
Display string |
|---|---|
|
Corporation |
|
Group |
|
Individual |
Entity - Source
Controlled list string |
Display string |
|---|---|
|
Encyclopedia of Early Cinema |
|
Halliwell's Who's Who in the Cinema |
|
Library of Congress Name Authority |
|
Other |
|
Root |
|
Silent Film Necrology, 2nd Edition |
|
The Film Encyclopedia, 4th Edition |
Additional links
Authority REST API for Hierarchies
Person Services REST APIs
Organization Services REST APIs
Common Services REST API
Short Identifier /wiki/spaces/collectionspace/pages/666273476