{"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 Movement Service RESTful API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The Movement Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Movement instances, plus list operations on multiple Movement 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":"Movement CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create an Movement","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new Movement 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":" ","type":"text","marks":[{"type":"strong"}]},{"text":"to that Movement record. Follows standard Create model. See the documentation of the Movement schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c279da72-e1d9-4c21-9c5e-89ddd38c699f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/movements HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read an Movement","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing Movement 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 Movement schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"58c2ad3b-dc48-4239-9251-6341386d2a3f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/movements/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update an Movement","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing Movement 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 Movement schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"14b98442-1d11-451d-ba76-281770aa0f24"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/movements/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete an Movement","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing Movement 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","width":760.0,"localId":"345a9aef-ef00-449e-8929-41cd12db013a"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/movements/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List Movement instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing Movement 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/2930128194"}}]},{"text":" model. See the documentation of the Movement list schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5046cd78-47b5-4bcf-9cbb-e05caef5fc1b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/movements HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2778f051-9a00-4045-8bc0-ead3d522617b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/movements?pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List also supports query parameters for searching for matching records, including keyword search. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1cdecccd-b43a-4309-b0c6-40571dedb603"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/movements?kw=foo&pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Movement REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Movement 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":"037e2def-fa56-4008-9bcd-e0fa086a8aa7"},"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":" MV2010.56","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-29","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":"20fedfa5-ce82-4c55-b4ac-ec3b69740cef"},"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":" MV2010.56","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-29","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":"Movement 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":"6ec9ff23-001a-4ebf-a99c-4db437fc928c"},"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":" MV2010.56","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-29","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /movements/b59d0c6f-08f2-4fb5-b5f7","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" b59d0c6f-08f2-4fb5-b5f7","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"},{"type":"paragraph"},{"type":"paragraph"}],"version":1}

Browser not supported