Impressionist Painting

{"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 CollectionObject Service RESTful API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The CollectionObject Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual CollectionObject instances, plus list operations on multiple CollectionObject instances. ","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":" ","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Brief Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The purpose of the CollectionObject Service is to manage records of information called ","type":"text"},{"text":"CollectionObjects","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":". In CollectionSpace, a \"CollectionObject\" is a record of information about a collection item -e.g. a single artifact, a box of shards, a specimen, etc. A museum or other repository using CollectionSpace to manage their collections can create and maintain a CollectionObject record for each item in their collection.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"CollectionObject CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create a CollectionObject","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new CollectionObject 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 CollectionObject record. Follows standard Create model. See the documentation of the CollectionObject schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4de524e2-2e12-4fd2-a590-820004af97f9"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/collectionobjects HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read a CollectionObject","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing CollectionObject record, specified by its Brief Description. Follows standard Read model. See the documentation of the CollectionObject schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1b70522b-822e-431f-bbcf-e7fa4e07dc7b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update a CollectionObject","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing CollectionObject 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/DOC/pages/2930129134"}}]},{"text":". Follows standard Update model. See the documentation of the CollectionObject schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0dd4384f-5b1d-4d40-a070-2f0a4a3792bb"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/collectionobjects/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete a CollectionObject","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing CollectionObject 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/DOC/pages/2930129134"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d3750a2d-15b9-41bc-bfa4-83ae9d045ac3"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/collectionobjects/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List CollectionObject instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing CollectionObject records, with summary information for each. Follows standard List model. See the documentation of the CollectionObject list schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"10b4434e-10eb-41c9-8183-13e3a20c0a6e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/ HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"List hierarchical related records via ","type":"text"},{"text":"showRelations","type":"text","marks":[{"type":"code"}]},{"text":" for structured objects","type":"text"}]},{"type":"paragraph","content":[{"text":"To list records structurally related to a particular CollectionObject (aka, a structured object) 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/DOC/pages/2930129134"}}]},{"text":", add the ","type":"text"},{"text":"showRelations=true","type":"text","marks":[{"type":"code"}]},{"text":" query parameter to the request URL.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, to list records structurally related to the Cataloging / CollectionObject record specified by CSID 850161ed-466c-4af2-bc45:","type":"text"}]},{"type":"paragraph","content":[{"text":"request to obtain related records","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9947a42a-27f0-470c-b469-a8f8445efeab"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/850161ed-466c-4af2-bc45?showRelations=true HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"This request returns, in a ","type":"text"},{"text":"relations-common-list","type":"text","marks":[{"type":"code"}]},{"text":" part of the response payload, a list of Relation records. The Cataloging / CollectionObject record specified by CSID 850161ed-466c-4af2-bc45 will be either the subject or object of each of the Relation records in that list. The records to which it is related will be specified, in turn, by both document type and CSID, in the reciprocal fields of each item in the list.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"List related records via ","type":"text"},{"text":"showAllRelations","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"To list records related to a particular CollectionObject (aka, cataloging) 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/DOC/pages/2930129134"}}]},{"text":", add the ","type":"text"},{"text":"showAllRelations=true","type":"text","marks":[{"type":"code"}]},{"text":" query parameter to the request URL.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, to list records related to the Cataloging / CollectionObject record specified by CSID 850161ed-466c-4af2-bc45:","type":"text"}]},{"type":"paragraph","content":[{"text":"request to obtain related records","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"44c58e93-dabf-4017-95fc-7ea88bd5d599"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/850161ed-466c-4af2-bc45?showAllRelations=true HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"This request returns, in a ","type":"text"},{"text":"relations-common-list","type":"text","marks":[{"type":"code"}]},{"text":" part of the response payload, a list of Relation records. The Cataloging / CollectionObject record specified by CSID 850161ed-466c-4af2-bc45 will be either the subject or object of each of the Relation records in that list. The records to which it is related will be specified, in turn, by both document type and CSID, in the reciprocal fields of each item in the list.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"CollectionObject REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"CollectionObject instance schema","type":"text"}]},{"type":"paragraph","content":[{"text":"The schemas below are severely abbreviated, and are thus illustrative. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"60cbbec5-188c-4dd7-bb7d-76b89ffa36cd"},"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":" 2010.5.18","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Laguna Tide Pool","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Impressionist Painting","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 following schema:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c70a7869-2f84-4c6c-859e-e3a85b96d247"},"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":" 2010.5.18","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Laguna Tide Pool","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Impressionist Painting","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":"CollectionObject list schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return the following schema. This schema includes the ","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":" fields to help facilitate access to individual records:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"eca2e2ae-5387-4558-8614-a6a4821bc254"},"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":" 2010.5.18","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Painting of a Tide Pool","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /collectionobjects/f0cf4c50-8f8a-4df0-869a","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" f0cf4c50-8f8a-4df0-869a","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"}],"version":1}

Browser not supported