Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Currently, the following Authorities provide this behavior:

LocationAuthority (/locationauthorities)
PersonAuthority (/personauthorities)
OrgAuthority (/orgauthorities)
TaxonAuthority (/taxonomyauthorities)
VocabularyAuthority (/vocabularies) TODO: Vocabularies are supposed to be flat? But they inherit from the same base class...)

Other services may be found here: RESTful Rollup

For all queries, the target of the URI is called the "item". For example with this URL,

...

These examples and many more, along with their resulting payloads, may be seen here: http://wiki.collectionspace.org/download/attachments/72548501/location-hierarchy-rest-api.html
To see a payload on that page, click on the hyperlink titled RESPONSE.

Java API Constants and Maven Coordinates

If you will be accessing these query parameters programmatically, you are encouraged to you the symbolic query parameter names found here:

org.collectionspace.services.common.api.CommonAPI.showRelations_QP
org.collectionspace.services.common.api.CommonAPI.showSiblings_QP
org.collectionspace.services.common.api.CommonAPI.showAllRelations_QP

The string value of these variables is subject to change, but will be up-to-date in the services common-api module, which has maven coordinates:

Code Block

    <groupId>org.collectionspace.services</groupId>
    <artifactId>org.collectionspace.services.common-api</artifactId>
    <name>services.common-api</name>

See Also

Relationship Service RESTful APIs