The following commands may be given as JSON PUT requests to the SNAC RestFUL API. Most read-only API commands may be called without login, however anything that causes changes in the data require a user object which includes a temporary API key. For examples using the RestFUL API in PHP and Java, view the SNAC RestAPI Examples Repository on GitHub.
Search through the controlled vocabulary.
Read a particular controlled vocabulary term.
Reconcile a given constellation against all constellations in SNAC, returning the top results.
Full Constellation object
Returns the information for the given user, including information for Constellations locked to the user.
Insert a new Constellation into SNAC. The Constellation must have the operation flags set to "insert".
Updates SNAC's copy of the given Constellation with this one. Any components with operation flags set to "update" will be overwritten with the new version.
Drops the lock on the given Constellation from "currently editing" down to simply locked to the user.
Publishes the given Constellation in SNAC. This does not make any updates to the Constellation data in SNAC.
Sends the given Constellation in SNAC for review. This does not make any updates to the Constellation data in SNAC.
Deletes the given Constellation from SNAC. This does not make any updates to the Constellation data in SNAC before deleting.
Reassigns the given Constellation to a different user, i.e. changes which user to which the Constellation is locked. This does not make any updates to the Constellation data in SNAC.
Returns a list of the most recently published Constellations in SNAC.
Returns a random subset of the Constellations in SNAC.
Returns a list of Constellations based on the query parameters.
Returns the edit history of the given Constellation.
Returns the full Constellation in the requested format.
Returns a list of Constellations denoted as maybe-same-as the given Constellation.
Computes the difference between the two given Constellations. Returns Constellation objects containing: only those items in the first, only those items in the second, and components shared.
Constellation ID for one Constellation to compare
Constellation ID for the other Constellation to compare
Constellation object containing only data distinct to the first Constellation
Constellation object containing only data distinct to the second Constellation
Constellation object containing only data shared by both Constellations
Boolean value denoting whether these two Constellations can be merged by this user
Computes the difference between the two given Constellations. Checks out the two Constellations in editing for the given user to allow a merge. Returns Constellation objects containing: only those items in the first, only those items in the second, and components shared.
Given Constellation IDs and a full, merged, Constellation, creates a new Constellation in SNAC from the given Constellation and sets all Constellations given by the IDs to be "tombstoned" and redirected to the new, merged, Constellation.
Array of Constellation IDs to tombstone in favor of the merged Constellation
Full Merged Constellation object
Full merged Constellation object with IDs
Given Constellation IDs, creates a new Constellation in SNAC from the combined data from all Constellations, "tombstones" the originals, and redirects thier IDs to the new, merged, Constellation.
Array of Constellation IDs to merge
Full merged Constellation object
Returns the full Constellation for viewing.
Constellation ID for Constellation to read
ARK ID for Constellation to read
Version of the Constellation to read
Check out the Constellation for editing.
Constellation object with ID and version to edit
Full Constellation object checked out for editing
Search for a Constellation, returning a list of possible matches.
Given a query name heading, returns the surrounding matching Constellations (in alphabetical order).
Given a Resource, inserts it into SNAC's resource cache.
Given a Resource, update the resource cache in SNAC by overwriting it with the given one.
Read the entire Resource from SNAC's resource cache.
Searches the resource cache in SNAC. Returns the top matches.