Place Service REST APIs

Owned by Adaptavist ScriptRunner for Confluence Cloud
Sept 11, 2012
4 min read

Brief Description

Unknown macro: {multi-excerpt-include}
For a full description, visit the Service Description and Assumptions page.

Assumptions

Unknown macro: {multi-excerpt-include}
For a complete list of assumptions, visit the Service Description and Assumptions page.

References

Vocabulary and Authority Overview
Place Service Description and Assumptions
Place Service Entity Diagrams
Place Authority Schema

REST-based API

The Place Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual PlaceAuthority instances, and on the associated Place items. These follow the Common model for CollectionSpace REST services.

Note that Place items are not directly "addressable"; they can only be accessed via the parent PlaceAuthority.

PlaceAuthority CRUD+L services

Create a PlaceAuthority

Creates a new PlaceAuthority record. Assigns a unique, service-specified CollectionSpace ID (CSID) to that PlaceAuthority record. Follows standard Create model. See the documentation of the PlaceAuthority schema, below. Example:
Read a PlaceAuthority

Reads an existing PlaceAuthority record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the PlaceAuthority schema, below. Example:
Update a PlaceAuthority

Updates an existing PlaceAuthority record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the PlaceAuthority schema, below. Example:
Delete a PlaceAuthority

Deletes an existing PlaceAuthority record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:
List PlaceAuthority instances

Lists existing PlaceAuthority records, with summary information for each. Follows standard List model, with pagination support. See the documentation of the PlaceAuthority-List schema, below. List supports the following common parameters for List results, pagination controls and query filters:

  • pgSz for page size
  • pgNum for page size

Examples:

PlaceAuthority REST payload schemas

The schemas below are abbreviated, and are thus illustrative. For a full list of the fields that may potentially be present in payloads when creating, updating, or reading PlaceAuthority records, please see the most recent PlaceAuthority schema

PlaceAuthority instance schema

Create and Update should use the following schema. The value of vocabType must be "PlaceAuthority".

Read will return the above, plus additional fields (uri and csid) for access:
PlaceAuthority-List schema

List (and variants) will return the following schema:

Place CRUD+L services

Place item instances are only accessible via the owning PlaceAuthority. The sub-resource is accessed with "items" (for consistency across all vocabulary-like services). In the examples below, the {place-auth-id} parameter represents the CSID value of an existing PlaceAuthority instance.

Create a Place item in a PlaceAuthority

Creates a new Place record. Assigns a unique, service-specified CollectionSpace ID (CSID) to that Place record. Follows standard Create model. Must See the documentation of the Place schema, below. Example:

You may also POST a part called

and any new relations there will be created. For example, this POST will add a relationship. Note that you must know beforehand the CSIDs of related terms. These are the CSIDs of two other Place records, which must exist before this call. The special variable ${itemCSID} will be expanded to the CSID of the newly created Place. (For Java use, please use the constant in CommonAPI.AuthorityItemCSID_REPLACE )

NOTE: if you wish to delete related items,
simply send relations-common-list as an empty element.
This is shown in a comment here:
http://wiki.collectionspace.org/display/collectionspace/Person+Service+REST+APIs?focusedCommentId=72220749&#comment-72220749

Read a Place in a PlaceAuthority

Reads an existing Place record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the Place schema, below. Example:

There are additional query parameters to get the relations for this item.
Query Parameters are defined and explained here, with examples: Authority REST API for Hierarchies

Update a Place in a PlaceAuthority

Updates an existing Place record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the Place schema, below. Example:

You may also PUT a part called

and any new relations there will be created. Relations to the updated item which are missing from the relations list in the PUT will be deleted from persistence. No target records are deleted, just the relations records that point to target records. E.g., POST to authority with Place "San Jose, CA", with relations-common-list that has an entry for ${itemCSID} hasBroader "Santa Clara County" creates a relations record that references both San Jose, CA and Santa Clara County. When a PUT is made that does not have the relation for Santa Clara County, then San Jose, CA has no relations, so the relations record for San Jose, CA==>hasBroader==>Santa Clara County is deleted, but both "San Jose, CA" and "Santa Clara County" Place records remain.

Delete a Place in a PlaceAuthority

Deletes an existing Place record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:
List Place instances in a PlaceAuthority

Lists existing Place records, with summary information for each. Follows standard List model. See the documentation of the Place-List schema, below. List supports the following common parameters for List results, pagination controls and query filters:

  • pgSz for page size
  • pgNum for page size
  • pt for partial-term matching, to support term completion.

Examples:

Place REST payload schemas

The schemas below are abbreviated, and are thus illustrative. For a full list of the fields that may potentially be present in payloads when creating, updating, or reading individual Place records, please see the most recent Place schema (i.e. for an individual Place term within a PlaceAuthority or vocabulary).

Place instance schema

Create and Update should use the following schema.

On create, the value of inAuthority must match the identifier of the parent PlaceAuthority, and will not be modified once the instance is created.

You can view the full set of validation constraints on the data you submit when creating or updating Place instance records, in the most recent CollectionSpace code, via this Java source code file.

Read will return the above, plus additional fields (uri and csid) for access:
Place-List schema

List (and variants) will return a schema similar to the following example: