| Note | ||
|---|---|---|
| ||
Newest schema mapping is here |
Status
This schema is... |
|
|---|---|
under review | |
complete |
|
...
Description | NXQL string | DB string | API query string | Required |
|---|---|---|---|---|
is object record deleted? | | | Y | |
sort by | | | N |
Query construction
...
Using short ID in place of CSIDs
Foreknowledge of the parent authority ID CSID is no longer necessary. Only the name short ID of the parent authority needs be known, which for MMI is the default person authority. The personauthority service will accept either the CSID or the authority name in the string format 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 is formatted as such can be formatted with CSIDs
| Code Block |
|---|
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/acc60b93-3a09-47eb-bd8f/items?as=/f23e6629-53e1-4021-82be-58e70f34e0fc/ |
or with short IDs
| Code Block |
|---|
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/urn:cspace:name(person)/items?as=
|
with the latter not requiring a specific CSID.
urn:cspace:name(oc2584)
|
Also see /wiki/spaces/collectionspace/pages/666273476.
Get referenced authority records
Append authorityrefs to the API URL for a collectionobject record to get a list of referenced authority records': sourceField, itemDisplayName and refName (in short ID format).
An example API call for authorityrefs for a given authority record
| Code Block |
|---|
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/urn:cspace:name(person)/items/urn:cspace:name(FOOPERSON1330911677949)/authorityrefs
|
Get cataloging records referencing a specific person authority record
| Note |
|---|
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 as such
| Code Block |
|---|
http://cspacetest.collectionspace.org:8180/cspace-services/personauthorities/urn:cspace:name(person)/items/442a6f9e-e361-4369-a8e3urn:cspace:name(FOOPERSON1330911677949)/refObjs?type=object |
Also see related Object References for authority term instances.
Controlled List mapping
Entity - Type
...
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