{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Table of Contents","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"style":{"value":"disc"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"61238332-bf9b-4488-b70b-6e3bac86513a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c4d3f7d6-82a9-4778-af33-6fd7dc6cffa8"}}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"About Place Service RESTful API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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. ","type":"text"}]},{"type":"paragraph","content":[{"text":"These follow the ","type":"text"},{"text":"Common model for CollectionSpace REST services","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3577544705"}}]},{"text":".","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Note that Place items are not directly \"addressable\"; they can only be accessed via the parent PlaceAuthority.","type":"text"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"PlaceAuthority CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new PlaceAuthority record. Assigns a unique, service-specified ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":" to that PlaceAuthority record. Follows standard Create model. See the documentation of the PlaceAuthority schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b52943dd-4b07-4981-9982-0f52fa82b4ad"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/placeauthorities HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing PlaceAuthority record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Read model. See the documentation of the PlaceAuthority schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"cbe3cae8-29db-423c-8037-e4a691709425"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/placeauthorities/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing PlaceAuthority record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Update model. See the documentation of the PlaceAuthority schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"7b5a2d71-4b59-43b7-94d6-ad951778255a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/placeauthorities/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing PlaceAuthority record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"8e058104-ec86-48a3-99bd-f15184006e36"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/placeauthorities/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List PlaceAuthority instances","type":"text"}]},{"type":"paragraph","content":[{"text":"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: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pgSz for page size","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pgNum for page size","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"4ccd519a-f3ba-473e-b409-e309560f08d8"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/placeauthorities HTTP/1.1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"GET /cspace-services/placeauthorities?pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"PlaceAuthority REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"the most recent PlaceAuthority schema","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/collectionspace/services/blob/master/services/place/3rdparty/nuxeo-platform-cs-place/src/main/resources/schemas/placeauthorities_common.xsd"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"PlaceAuthority instance schema","type":"text"}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema. The value of ","type":"text"},{"text":"vocabType","type":"text","marks":[{"type":"em"}]},{"text":" must be \"PlaceAuthority\".","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"08a8fcf3-3b61-4ae1-9287-8b56c2886a28"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Default PlaceAuthority","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" place","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" PlaceAuthority","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Read will return the above, plus additional fields (","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":") for access:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"d33459fd-8cb2-43a3-9ed8-2ef7ed1d4d1b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /placeauthorities/afbb91ca-3988-4524-bada","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" afbb91ca-3988-4524-bada","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"PlaceAuthority-List schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return the following schema:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"d434f713-2f6e-4ec4-b0ff-eca98d0fb554"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 40","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 3","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 3","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" csid|uri|updatedAt|displayName|refName|shortIdentifier|vocabType","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" afbb91ca-3988-4524-bada","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /placeauthorities/afbb91ca-3988-4524-bada","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-03-29T00:51:04Z","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Default PlaceAuthority","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:placeauthorities:name(place)'Default PlaceAuthority'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" place","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Place CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Place item instances are only accessible via the owning PlaceAuthority. The sub-resource is accessed with \"","type":"text"},{"text":"items","type":"text","marks":[{"type":"em"}]},{"text":"\" (for consistency across all vocabulary-like services). In the examples below, the ","type":"text"},{"text":"{place-auth-id}","type":"text","marks":[{"type":"em"}]},{"text":" parameter represents the CSID value of an existing PlaceAuthority instance.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create a Place item in a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new Place record. Assigns a unique, service-specified ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":" to that Place record. Follows standard Create model. Must See the documentation of the Place schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"bbee495d-6d23-4601-8efa-a9b8dd2a78c3"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/placeauthorities/{place-auth-id}/items HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"You may also POST a part called","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"28f98ed7-d475-4601-9e27-e9e5f9192284"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"CommonAPI","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3577544705"}}]},{"text":". AuthorityItemCSID_REPLACE )","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"11ae6da7-9f12-423e-8d7d-545c1f60a997"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" aab04036-7c9a-492d-a4d5","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" SantaClaraCountyCA","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" current","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Santa Clara County, CA","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" hasBroader","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ${itemCSID}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Placeitem","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"

","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"NOTE: if you wish to delete related items, simply send relations-common-list as an empty element.","type":"text"},{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read a Place in a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing Place record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Read model. See the documentation of the Place schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e9ed36cd-5346-4f71-a01c-4c787ed612bb"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/placeauthorities/{place-auth-id}/items/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"There are additional query parameters to get the relations for this item.","type":"text"},{"type":"hardBreak"},{"text":"Query Parameters","type":"text","marks":[{"type":"strong"}]},{"text":" are defined and explained here, with examples: ","type":"text"},{"text":"Authority REST API for Hierarchies","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3580756009"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update a Place in a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing Place record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Update model. See the documentation of the Place schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"9b859b89-58ba-46c0-ac78-be24de1ab98a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/placeauthorities/{place-auth-id}/items/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"You may also PUT a part called","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"16ae2845-68f8-4920-98ce-324e4a8fa210"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete a Place in a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing Place record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"00924dee-8fed-499b-be8b-4e08a7f271e7"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/placeauthorities/{place-auth-id}/items/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List Place instances in a PlaceAuthority","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing Place records, with summary information for each. Follows standard ","type":"text"},{"text":"List","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/DOC/pages/2930128340"}}]},{"text":" model. See the documentation of the Place-List schema, below. List supports the following common parameters for List results, pagination controls and query filters: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pgSz for page size","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pgNum for page size","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pt for partial-term matching, to support term completion.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"8b16e9d9-b097-45eb-b04b-40d1c4c5a88b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/placeauthorities/{place-auth-id}/items HTTP/1.1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"GET /cspace-services/placeauthorities/{place-auth-id}/items?pt=foo&pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Place REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"the most recent Place schema (i.e. for an individual Place term within a PlaceAuthority or vocabulary)","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/collectionspace/services/blob/master/services/place/3rdparty/nuxeo-platform-cs-place/src/main/resources/schemas/places_common.xsd"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Place instance schema","type":"text"}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema.","type":"text"}]},{"type":"paragraph","content":[{"text":"On create, the value of ","type":"text"},{"text":"inAuthority","type":"text","marks":[{"type":"em"}]},{"text":" must match the identifier of the parent PlaceAuthority, and will not be modified once the instance is created.","type":"text"}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"Java source code file","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/collectionspace/services/blob/master/services/place/service/src/main/java/org/collectionspace/services/place/nuxeo/PlaceValidatorHandler.java"}}]},{"text":".","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"8b619d65-20e3-4bc7-9854-e03abe501d9e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 6ca3db57-7c96-47b6-b17d","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" SanJoseCA","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" current","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" San Jose, CA","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Read will return the above, plus additional fields (","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":") for access:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"7e882348-a727-492a-9254-2bdad606ea08"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /placeauthorities/6ca3db57-7c96-47b6-b17d/items/d286deaa-245c-4505-8b6d","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" d286deaa-245c-4505-8b6d","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Place-List schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return a schema similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"2ce5d03f-3b2b-4f2b-9462-a754b1962624"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 40","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 8","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 8","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" csid|uri|updatedAt|termType|displayName|shortIdentifier|refName|termStatus","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 8efbeed8-b592-4683-869f","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /placeauthorities/6ca3db57-7c96-47b6-b17d/items/8efbeed8-b592-4683-869f","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-03-29T01:26:46Z","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" San Jose, CA","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" SanJoseCA","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:placeauthorities:name(place):item:name(SanJoseCA)'San Jose, CA'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"rule"}],"version":1}

Browser not supported