atitle

{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Except as noted in individual service REST API documentation, the CollectionSpace services support the following calls.","type":"text"}]},{"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":"d45c64b1-19ed-4cc9-b464-dc08123ac062"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"f651f738-62dc-4d82-8665-06e72a1aa57c"}},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create an object/procedure/record instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new object/procedure/record instance. 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/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" to that record. Standard authentication applies, and user must have create privileges for the associated object/procedure/record type.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Create is invoked as an HTTP POST method on a collection of service resources or sub-resources (e.g. ../collectionobjects/ or ../personauthorities/{csid}/persons/). The RESTful metaphor is that of creating a new record within a container, or 'bucket', of records of that type.","type":"text"}]},{"type":"paragraph","content":[{"text":"The body of your Create request contains the data that will be used to create a new record. In most cases, you'll be sending an XML document consisting of one or more parts, with each part contained within its own XML element.","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of a Create request to the CollectionObject service follows below. See each individual service's API documentation for further details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"65ecde1a-76a0-4a09-9e00-fee7d09a4536"},"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":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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":" objectNumber-1266005065536","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Papier mache bird cow mask with horns, painted red with black and yellow spots.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Puerto Rico. ca. 8" high, 6" wide, projects 10" (with horns).","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" objectName-1266005065536","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":" test-string","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 999","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 9999","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":"Create service calls do not generally accept query parameters or other arguments.","type":"text"}]},{"type":"paragraph","content":[{"text":"Any XML document(s) included in your Create request must be a valid XML representation of the associated object/procedure/record that you wish to create. This ","type":"text"},{"text":"may","type":"text","marks":[{"type":"em"}]},{"text":" be a sparse payload, containing only selected fields. Each service has a different schema (record format); for details, please see the individual service's documentation.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Responses","type":"text"}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"201 Created\" HTTP status code is returned. Note that the Location: header will contain the service path, including the ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":", to the newly created resource, as in this example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cb742dbe-2794-4de3-ace3-b795623e12c5"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 201 Created","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Location: https://demo.collectionspace.org/cspace-services/collectionobjects/a4b65c82-0eb8-41ec-8936","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following errors may be returned in response to Create requests. Your code should check for each of these, while noting that not every CollectionSpace service may currently return all of the errors below:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"181aa6cc-a310-4fb7-89d1-10503d6905b2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad Request","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be created because the data sent in the entity body of the request was bad, as determined by the service.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be created because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be created because the client submitting the request was not authorized to create new resources in this container.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"409","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Conflict","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be created because the submitted data would create a duplicate (non-unique) resource, as determined by the service.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the resource from being created.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Read an object/procedure/record instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets (reads) information about a single object/procedure/record instance, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" as returned by Create, or a List method. Standard authentication applies, and user must have read privileges for the associated object/procedure/record type.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Read is invoked as an HTTP GET method on a specific instance of a resource, qualified with a CSID value. Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b00b51c2-4cac-40d1-99f2-99045f351ed3"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/{csid} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Most read service calls accept a single, optional query parameter:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d7da70b7-1e43-4286-a479-d1978786ea5d"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/{csid}?wf_deleted=false HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If this parameter is included, a record that has been \"soft\" deleted will not be returned by the Read request. Instead, a ","type":"text"},{"text":"404 Not Found","type":"text","marks":[{"type":"code"}]},{"text":" status code will be returned in the response.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Responses","type":"text"}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code and a representation of the requested object/procedure/record record is returned, with the associated schema sections represented, as below. See the individual service documentation for schema details.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"dd84d7fb-22fc-4ac1-82e4-e4ee3c989c19"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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":" 2011-08-02T21:08:33Z","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2011-07-29T18:03:56Z","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":" objectNumber-1266005065536","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Papier mache bird cow mask with horns, painted red with black and yellow spots.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Puerto Rico. ca. 8" high, 6" wide, projects 10" (with horns).","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" objectName-1266005065536","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":" test-string","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 999","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 9999","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":"If an error occurred, some non-2xx code will be returned. Check the ","type":"text"},{"text":"HTTP Status Code","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"}}]},{"text":" that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following errors ","type":"text"},{"text":"may be returned","type":"text","marks":[{"type":"link","attrs":{"href":"http://fisheye.collectionspace.org/browse/collectionspace/src/services/trunk/services/client/src/main/java/org/collectionspace/services/client/test/ServiceRequestType.java?r=trunk"}}]},{"text":" in response to Read requests. Your code should check for each of these, while noting that not every CollectionSpace service may currently return all of the errors below:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"f6413ac0-4391-4099-9ef9-83f102725652"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be read because the client submitting the request was not authorized to read it.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource requested for reading does not exist. (When the ","type":"text"},{"text":"?wf_deleted=false","type":"text","marks":[{"type":"code"}]},{"text":" parameter is included in the Read request, this error may also be returned if the record exists but has been \"soft\" deleted.)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the resource from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Update an object/procedure/record instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an individual object/procedure/record instance, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" as may be returned by Create, or by a List method. Standard authentication applies, and user must have update privileges for the associated object/procedure/record type.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Update is invoked as an HTTP PUT method on an instance of a resource or sub-resource, qualified with a ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" value (e.g. ../collectionobjects/{csid} or ../personauthorities/{csid}/persons/{csid}).","type":"text"}]},{"type":"paragraph","content":[{"text":"The body of your Update request contains the data that will be used to update the existing record. In most cases, you'll be sending an XML document consisting of one or more parts, with each part contained within its own XML element.","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of an Update request to the CollectionObject service, to update the contents of the record whose ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" is 850161ed-466c-4af2-bc45, follows below. See each individual service's API documentation for further details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"361c977d-4c65-4027-9726-c41e81df2c1f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/collectionobjects/850161ed-466c-4af2-bc45 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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":" updated-objectNumber-1266003498657","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" updated-objectName-1266003498657","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":"Update service calls do not generally accept query parameters or other arguments.","type":"text"}]},{"type":"paragraph","content":[{"text":"Any XML document(s) included in your Update request must be a valid XML representation of the associated object/procedure/record whose contents you wish to update. This ","type":"text"},{"text":"may","type":"text","marks":[{"type":"em"}]},{"text":" be a sparse payload, containing only selected fields. Each service has a different schema (record format); for details, please see the individual service's documentation.","type":"text"}]},{"type":"paragraph","content":[{"text":"As a general rule, if the XML document(s) included in the payload of your Update request include one or more elements that have child elements, the update will ","type":"text"},{"text":"completely replace","type":"text","marks":[{"type":"em"}]},{"text":" (i.e. overwrite) the existing child elements with the new child elements, if any, you are sending. This means, for example, to update the contents of a multi-valued field, you will send an update request containing a new set of values for that field. To remove all of the values from a multi-valued field, you will send an update request containing no values for that field. For any per-service exceptions to this behavior, please see the individual service's documentation.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Responses","type":"text"}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code and a representation of the updated object/procedure/record instance is returned. The body of the response is the same as for the standard read operation; see ","type":"text"},{"text":"Read an object/procedure/record instance","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3576922154/Standard+CRUD+L+APIs#Read-an-object%2Fprocedure%2Frecord-instance"}}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a253af46-0085-4585-a0e1-3f3e0dc17645"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2011-08-02T23:15:06Z","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":" updated-objectNumber-1266003498657","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" atitle","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Papier mache bird cow mask with horns, painted red with black and yellow spots.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Puerto Rico. ca. 8" high, 6" wide, projects 10" (with horns).","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" updated-objectName-1266003498657","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":" test-string","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":"If an error occurred, some non-2xx code will be returned. Check the ","type":"text"},{"text":"HTTP Status Code","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"}}]},{"text":" that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following errors ","type":"text"},{"text":"may be returned","type":"text","marks":[{"type":"link","attrs":{"href":"http://fisheye.collectionspace.org/browse/collectionspace/src/services/trunk/services/client/src/main/java/org/collectionspace/services/client/test/ServiceRequestType.java?r=trunk"}}]},{"text":" in response to Update requests. Your code should check for each of these, while noting that not every CollectionSpace service may currently return all of the errors below:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6dd9b246-b6c3-484d-acf2-ef95011278af"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad Request","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be updated because the data sent in the entity body of the request was bad, as determined by the service.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be updated because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be updated because the client submitting the request was not authorized to update resources in this container.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource requested for updating does not exist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the resource from being updated.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Delete an object/procedure/record instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an individual object/procedure/record instance, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" as returned by Create, or a List method. Standard authentication applies, and user must have delete privileges for the associated object/procedure/record type.","type":"text"}]},{"type":"paragraph","content":[{"text":"This is a \"hard\" delete, which removes the record and all of its data from the CollectionSpace system. Unless an export or backup has previously been performed, the record and its data can be considered permanently deleted and unrecoverable.","type":"text"}]},{"type":"paragraph","content":[{"text":"To perform a \"soft\" delete, which simply marks a record for deletion, while retaining the record and its data, see ","type":"text"},{"text":"Common Services REST API documentation#Update workflow state of an object/procedure/record instance","type":"text","marks":[{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/pages/resumedraft.action?draftId=1565362707#CommonServicesRESTAPIdocumentation-Updateworkflowstateofanobject/procedure/recordinstance"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete is invoked as an HTTP DELETE method on an instance resource (the primary service resource qualified with a CSID value). Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"cd77c9ec-1221-4f7e-8792-2120e902300c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/collectionobjects/{csid} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Delete service calls do not generally accept query parameters or other arguments.","type":"text"}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned, with an empty entity body:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c4054269-f828-4105-9cad-cfb790f1fc6d"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following errors ","type":"text"},{"text":"may be returned","type":"text","marks":[{"type":"link","attrs":{"href":"http://fisheye.collectionspace.org/browse/collectionspace/src/services/trunk/services/client/src/main/java/org/collectionspace/services/client/test/ServiceRequestType.java?r=trunk"}}]},{"text":" in response to Delete requests. Your code should check for each of these, while noting that not every CollectionSpace service may currently return all of the errors below:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a5feeb48-1363-4c54-beef-8b7b990902b4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be deleted because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource could not be deleted because the client submitting the request was not authorized to delete it.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource requested for deletion does not exist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the resource from being deleted.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"List All object/procedure/record instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets summary information about all instances for the associated resource. Instances for which the authenticated user does not have read privileges, will not be returned in results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Each item in a list contains compact, summary information for each resource. This summary information will typically contain at least one or two displayable fields, as well as the identifier and URL for retrieving the full record for that item. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Summary information generally includes the ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" of each instance, which can be included in the URIs of subsequent requests in order to read, update, or delete specific instances. The specific information returned within the items of a list is documented with each service resource, and may include displayName or refName information for each item.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"List is invoked as an HTTP GET method on the primary resource. Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ada7bdf3-301d-446c-8dc9-957deac8297a"},"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":"paragraph","content":[{"text":"As described in the intro above, and unless noted in the specific service, List service calls support pagination of results. E.g., to get the third page of results with 20 results per page, send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"96a9a5d7-807f-4011-a427-e344245a3061"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects?pgSz=20&pgNum=2 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned (note the pagination-info elements):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"03b80cee-63fd-4e62-a059-5070f7c768b1"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 20","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 53","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" objectNumber|objectName|title|responsibleDepartment|uri|csid","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" objectNumber-1304508705716","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" title-1304508705716","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /collectionobjects/18acadbf-8e89-4520-a1f9","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 18acadbf-8e89-4520-a1f9","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":" objectNumber-1304508708473","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" title-1304508708473","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /collectionobjects/c3deb7f9-3882-46d1-b79e","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" c3deb7f9-3882-46d1-b79e","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":"The names of the root element and of the item elements in the list may vary between services. As of CollectionSpace version 1.9, most services return ","type":"text"},{"text":"abstract-common-list","type":"text","marks":[{"type":"code"}]},{"text":" as the name of the root element in the list and ","type":"text"},{"text":"list-item","type":"text","marks":[{"type":"code"}]},{"text":" as the name of each item element in the list.","type":"text"}]},{"type":"paragraph","content":[{"text":"If no individual object/procedure/record instances are found, a response with a \"200 OK\" HTTP status code, containing pagination information and an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"4229145a-7746-42e2-b676-d9cbdfaff59c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources could not be read because the client submitting the request was not authorized to read it.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources requested for reading does not exist. This may occur, for example, if a path element in the request URL is incorrect. Note that if a list of resources does exist, but currently contains zero items, a success response with a \"200 OK\" HTTP status code will be returned, containing an empty list - a list with only a root element, but no child elements.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the list of resources from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Keyword Search for object/procedure/record instances","type":"text"}]},{"type":"paragraph","content":[{"text":"This section is in process and is currently incomplete. Remaining to-do items:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"verify that read privileges affect results as described","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"identify any significant database system-specific differences, such as between PostgreSQL and MySQL. The details below are all correct for the database setup used for ","type":"text"},{"text":"https://core.dev.collectionspace.org/cspace-services","type":"text","marks":[{"type":"link","attrs":{"href":"https://core.dev.collectionspace.org/cspace-services"}}]},{"text":" as of 2022-02-01","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"provide info on what the stopwords are (or how to find that list)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify and describe the interaction between pagination and search in returned result examples (though this seems like it could be handled in a more general section, since an abstract-common-list is returned)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add error responses","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Searches on one or more keywords, and returns summary information about all instances of the associated resources which are matched by those keywords.","type":"text"}]},{"type":"paragraph","content":[{"text":"Instances for which the authenticated user does not have read privileges, will not be returned in results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Summary information generally includes the ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" of each instance, which can be included in the URIs of subsequent requests in order to read, update, or delete specific instances. The specific information returned within the items of a list is documented with each service resource, and may include displayName or refName information for each item. Note that the summary information returned often provides no indication of where your keywords were found in the record(s) returned.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"How keyword search works","type":"text"}]},{"type":"paragraph","content":[{"text":"Keyword searches:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Search the full text of all fields. See the \"Keyword search caveats\" section below for some \"gotchas\" related to this.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Are case-insensitive.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When multiple keywords are included in the query:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"By default, the search is carried out as though a Boolean AND is present between each keyword pair. For instance, a search for \"tea\" may return records having \"tea set\" and \"tea kettle\", and a search for \"set\" may return \"tea set\" and \"coffee set\", but a search for \"tea+set\" would include records having \"tea set\" (as well as \"set tea\" and \"the tea was only sold as part of a sampler set\").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You may include the OR operator in your query if you would like that behavior. A query for \"tea+OR+set\" would return records having \"tea set\", \"tea kettle\", and \"coffee set\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Order of the terms is irrelevant. For example, a record containing the option list value \"architecture-design\" will be retrieved if you search for \"architecture+design\" or \"design+architecture\"","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Will not match a database-dependent list of stopwords. If your query consists only of a stopword (e.g. \"A.\"), no results are returned. If your multiple-term query contains a stopword, that term is dropped. For example, a Person authority query for \"Jane+A.+Doe\" would return records containing \"Jane Doe\", \"Jane P. Doe\", and \"Jane A. Doe\" because it is just searching for the presence of \"Jane\" and \"Doe\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Matches whole tokens. For instance, a keyword search or Person authorities for \"Q\" will return only names like \"John Q. Public\". \"Quinn Jones\" would not be included in the results, even though the name contains a \"Q\". That said, some level of stemming is applied. For example, a keyword search for \"designs\" will retrieve records having the option list value \"architecture-design\", without \"designs\" literally appearing in the records.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Normalization/tokenization","type":"text"}]},{"type":"paragraph","content":[{"text":"The keyword index performs some normalization and tokenization of the record data. For example, the option list value \"architecture-design\" is split into \"architecture\" and \"design\". Some normalization/tokenization is performed on query parameters passed in, but the processing does not exactly match the normalization/tokenization used for the index. For example, a keyword search for \"architecture-design\" will retrieve nothing.","type":"text"}]},{"type":"paragraph","content":[{"text":"Diacritics are not normalized. For example, to retrieve a record containing \"Le Chat Qui Pêche\", you must search for \"pêche\". A search for \"peche\" will not retrieve the record.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Repeatable fields","type":"text"}]},{"type":"paragraph","content":[{"text":"Values in repeatable fields are searched. Note, however, that there is no requirement that values in repeatable groups or subgroups must appear together in one grouping for a record to be retrieved.","type":"text"}]},{"type":"paragraph","content":[{"text":"A record containing the repeatable field group shown below would be returned in the keyword search results for \"979899+lender\".","type":"text"}]},{"type":"paragraph","content":[{"text":"Repeatable Group Data in Record","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c2ccd552-cd23-4bdb-bb8a-117d34e9f633"},"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":" previous","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 979899","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":" lender","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 12131417","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":"A record containing the repeatable field subgroup data shown below would be returned in the keyword search results for \"english+pescador\".","type":"text"}]},{"type":"paragraph","content":[{"text":"Repeatable Subgroup Data in Record","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7d6fd7dd-f920-4da5-8158-58a73c61d376"},"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":" Le Chat Qui Pêche","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:vocabularies:name(languages):item:name(fra)'French'","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":" El gato pescador","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:vocabularies:name(languages):item:name(spa)'Spanish'","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":" popular","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:vocabularies:name(languages):item:name(eng)'English'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Fishing cat","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":4},"content":[{"text":"Keyword search caveats","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Data in some non-displayed system fields is searched","type":"text"}]},{"type":"paragraph","content":[{"text":"The full text of records searched by keyword search includes some system fields not displayed in the UI. This means that keywords that appear in the uri field (\"items\"), or refName field (“name”, “item”) may match large numbers of unexpected records, depending on the record type being searched.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"The underlying data stored in the record is searched, not necessarily what you see displayed in the UI","type":"text"}]},{"type":"heading","attrs":{"level":6},"content":[{"text":"Option list/static list values","type":"text"}]},{"type":"paragraph","content":[{"text":"If an option list value is defined as one \"keyword\" and its message is multiple words, searching on words from the message will not retrieve records as expected. For the loanPurposes option shown below, you cannot retrieve loans for this purpose by keyword searching for \"scientific\". You must search for the whole \"word\" representing the option in the underlying data: \"scientificorexhibitpreparation\".","type":"text"}]},{"type":"paragraph","content":[{"text":"If this option value had been defined as \"scientific-or-exhibit-preparation\", it would be tokenized into separate words and records containing this value would be retrievable by a keyword search for \"scientific\".","type":"text"}]},{"type":"paragraph","content":[{"text":"Option list display message differs from option value","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0ae3ae1e-d536-4b10-9812-e80c86e8f718"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"scientificorexhibitpreparation: {","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" id: 'option.loanPurposes.scientificorexhibitpreparation',","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" defaultMessage: 'scientific or exhibit preparation',","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"}","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":6},"content":[{"text":"Authority term values","type":"text"}]},{"type":"paragraph","content":[{"text":"You may have a Person authority record where the first Display Name value is \"Jane Doe\" and one of the subsequent Display Name values is for the variant name \"Janey Doe\". If you do a keyword search for \"Janey+Doe\" on that Person authority, you will retreive the record as expected.","type":"text"}]},{"type":"paragraph","content":[{"text":"However, if you search collectionobjects for \"Janey+Doe\", you will not retrieve any results because only the term's refName value, which contains only the first Display Name value from the authority, is in the underlying data in a collectionobject record.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Keyword search is invoked as an HTTP GET method on the primary resource, including a specific query parameter (","type":"text"},{"text":"kw=","type":"text","marks":[{"type":"code"}]},{"text":") to indicate that a keyword search is being performed, and providing a list of zero or more keywords to be used in the search as arguments to that query parameter.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3ecf8f76-2d8f-4d8a-b80d-2c3d21bed7e9"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects?kw=cucurbita HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"To search on multiple keywords, add a plus sign (\"+\") between each keyword:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"8f0e4965-518f-4f16-98fd-b75377cb19cb"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects?kw=whetstone+sharpening+sharpen HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Query parameters may follow the previous path component of the URL, either with or without a trailing slash: ","type":"text"},{"text":".../collectionobjects/?kw=","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"keyword ","type":"text","marks":[{"type":"code"}]},{"text":"and ","type":"text"},{"text":".../collectionobjects?kw=","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"keyword ","type":"text","marks":[{"type":"code"}]},{"text":"are both accepted as valid requests.","type":"text"}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned. The payload that is returned from a keyword search is identical to the payload returned from a ","type":"text"},{"text":"List All","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3576922154/Standard+CRUD+L+APIs#List-All-object%2Fprocedure%2Frecord-instances"}}]},{"text":" request:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"2235049a-f706-407f-8192-d45502cfe6ca"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","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":" 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 40","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" csid|uri|refName|updatedAt|workflowState|objectNumber|objectName|title|responsibleDepartment","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 77c07515-c0e3-4b76-aeea","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /collectionobjects/77c07515-c0e3-4b76-aeea","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:collectionobjects:id(77c07515-c0e3-4b76-aeea)'Coffee set'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2022-01-31T21:34:52.301Z","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" project","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Coffee set","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Beverage serving","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Fancy coffee set","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" decorative-arts","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":" bf51110a-0666-47b8-b9d4","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /collectionobjects/bf51110a-0666-47b8-b9d4","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:collectionobjects:id(bf51110a-0666-47b8-b9d4)'Tea Set'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2021-10-15T01:43:56.437Z","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" project","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Tea Set","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":"If no object/procedure/record instances match the keyword(s) provided, a response with a \"200 OK\" HTTP status code, containing an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"paragraph","content":[{"text":"Need to add error responses here.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Advanced Search for object/procedure/record instances","type":"text"}]},{"type":"paragraph","content":[{"text":"This section is in process and is currently incomplete.","type":"text"}]},{"type":"paragraph","content":[{"text":"Searches using a provided search expression and returns summary information about all instances of the associated resources which are matched by that expression.","type":"text"}]},{"type":"paragraph","content":[{"text":"Instances for which the authenticated user does not have read privileges, will not be returned in results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Verify whether this assertion is currently accurate for advanced search.","type":"text"}]},{"type":"paragraph","content":[{"text":"Summary information generally includes the ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" of each instance, which can be included in the URIs of subsequent requests in order to read, update, or delete specific instances. The specific information returned within the items of a list is documented with each service resource, and may include displayName or refName information for each item.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Advanced search is invoked as an HTTP GET method on the primary resource, including a specific query parameter (","type":"text"},{"text":"as=","type":"text","marks":[{"type":"code"}]},{"text":") to indicate that an advanced search is being performed, and providing a search expression as the argument to that query parameter.","type":"text"}]},{"type":"paragraph","content":[{"text":"The search expression must be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A valid NXQL expression. (NXQL is the schema-aware query language used with CollectionSpace's Nuxeo repository, and its expressions are similar to standard SQL ","type":"text"},{"text":"SELECT","type":"text","marks":[{"type":"code"}]},{"text":" statements. See ","type":"text"},{"text":"Nuxeo's NXQL search documentation","type":"text","marks":[{"type":"link","attrs":{"href":"http://doc.nuxeo.com/display/NXDOC/NXQL"}}]},{"text":".)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"URL encoded.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API) shown in these representative examples:","type":"text"}]},{"type":"paragraph","content":[{"text":"request for advanced search within the 'loanInPurpose' field in Loan In records, for case-insensitive values containing 'research'","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"3731ab92-6f75-4a32-a35a-371ac26aa938"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/loansin?as=loansin_common%3AloanPurpose%20ILIKE%20%27%25research%25%27","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Written with easier-to-read, non-URL encoded values:","type":"text"},{"type":"hardBreak"},{"text":"?as=loansin_common:loanPurpose ILIKE '%research%'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"request for advanced search within the 'loanInNumber' field in Loan In records, for case-sensitive values starting with 'LI2012'","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a33ba546-4d48-4147-b93f-140ed80b59be"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/loansin?as=loansin_common%3AloanInNumber%20LIKE%20%27LI2012%25%27","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Written with easier-to-read, non-URL encoded values:","type":"text"},{"type":"hardBreak"},{"text":"?as=loansin_common:loanInNumber LIKE 'LI2012%'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"request for Advanced search within the 'depositor' field in Intake records, providing a full refName for an authority term to be searched for in that field","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"888b9e6b-e19c-4a8d-bb78-4d194987ca5e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/intakes?as=intakes_common%3Adepositor%3D%22urn%3Acspace%3Acore.collectionspace.org%3Apersonauthorities%3Aname%28person%29%3Aitem%3Aname%28JohnDoe1327373674139%29%27John+Doe%27%22","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Written with easier-to-read, non-URL encoded values: ","type":"text"},{"text":"?as=intakes_common:depositor=\"urn:cspace:core.collectionspace.org:personauthorities:name(person):item:name(JohnDoe1327373674139)'John Doe'\"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"(the double quote marks around the refName are required in this instance, to enclose the single quote marks in the display name portion of the refName)","type":"text"}]},{"type":"paragraph","content":[{"text":"request for Advanced search in Cataloging / CollectionObject records, for records updated within a specific date range","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"098a5eb6-638a-4533-907f-5448046dba85"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects?as=collectionspace_core%3AupdatedAt+%3E%3D+TIMESTAMP+%222012-01-17T00%3A00%3A00%22+AND+collectionspace_core%3AupdatedAt+%3C%3D+TIMESTAMP+%222012-01-31T23%3A59%3A59%22","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Written with easier-to-read, non-URL encoded values:","type":"text"},{"type":"hardBreak"},{"text":"?as=collectionspace_core:updatedAt >= TIMESTAMP \"2012-01-17T00:00:00\" AND collectionspace_core:updatedAt <= TIMESTAMP \"2012-01-31T23:59:59\"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"request for Advanced search within the 'date' structured date field in Media records, for dates within a specific date range","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d76da477-028f-4374-ae33-92ffb3967367"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/media?as=media_common%3AdateGroupList%2F*%2FdateEarliestScalarValue+%3E%3D+TIMESTAMP+%222011-02-17T00%3A00%3A00%22+AND+media_common%3AdateGroupList%2F*%2FdateLatestScalarValue+%3C%3D+TIMESTAMP+%222011-03-31T23%3A59%3A59%22","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Written with easier-to-read, non-URL encoded values:","type":"text"},{"type":"hardBreak"},{"text":"?as=media_common:dateGroupList/*/dateEarliestScalarValue >= TIMESTAMP \"2011-02-17T00:00:00\" AND media_common:dateGroupList/*/dateLatestScalarValue <= TIMESTAMP \"2011-03-31T23:59:59\"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"For more details and additional examples, see Search section of CollectionSpace User Manual.","type":"text"}]},{"type":"paragraph","content":[{"text":"Query parameters may follow the previous path component of the URL, with or without a trailing slash: ","type":"text"},{"text":".../collectionobjects/?as=","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"search_expression ","type":"text","marks":[{"type":"code"}]},{"text":"and ","type":"text"},{"text":".../collectionobjects?as=","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"search_expression ","type":"text","marks":[{"type":"code"}]},{"text":"are both accepted as valid requests.","type":"text"}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned. The payload that is returned from an advanced search is identical to the payload returned from a ","type":"text"},{"text":"List All","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3576922154/Standard+CRUD+L+APIs#List-All-object%2Fprocedure%2Frecord-instances"}}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":" request.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"64e372df-38cd-4b7e-a064-9412c0a6ebbf"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","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":" 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 40","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" csid|uri|updatedAt|entryNumber|depositor|currentOwner","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 0b72fec7-7b56-4d97-8fba","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /intakes/0b72fec7-7b56-4d97-8fba","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 2012-01-24T02:54:42Z","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" EV2012.2","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:personauthorities:name(person):item:name(JohnDoe1327373674139)'John Doe'","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":"If no object/procedure/record instances match the search expression provided, a response with a \"200 OK\" HTTP status code, containing an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"paragraph","content":[{"text":"Need to add error responses here.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Partial Term Matching for object/procedure/record instances","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"This section is in process and is currently incomplete.","type":"text"}]},{"type":"paragraph","content":[{"text":"Searches on a partial term. (This functionality may also sometimes be described as term suggestion or term completion.) Returns summary information about all instances of the associated resource that are matched by the partial term.","type":"text"}]},{"type":"paragraph","content":[{"text":"As an example, a partial term search on ","type":"text"},{"text":"ally","type":"text","marks":[{"type":"code"}]},{"text":" might match on ","type":"text"},{"text":"Ally McBeal","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"June","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Ally son","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"W","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"ally Van","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that, currently, partial term matching functionality is supported only by selected services:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Vocabulary service.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The authority services (e.g. Person, Organization).","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Instances for which the authenticated user does not have read privileges, will not be returned in results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Verify whether this assertion is currently accurate for partial term matching.","type":"text"}]},{"type":"paragraph","content":[{"text":"Summary information generally includes the ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" of each instance, which can be included in the URIs of subsequent requests in order to read, update, or delete specific instances. The specific information returned within the items of a list is documented with each service resource, and may include displayName or refName information for each item.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Partial term matching is invoked as an HTTP GET method on the primary resource, including a specific query parameter and arguments to indicate that a partial term match is being performed, and providing the terms to be used in the match.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"a89d6aab-1ae9-4abd-9063-a5a9cb344691"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects?pt=jone HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If the service offers access to a sub-resource, such as to the individual Organizations in an Organization Authority, partial term matching on the subresource uses a similar request syntax:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"18d8dcae-3f8e-4110-90d1-19a5bb170443"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/orgauthorities/{csid}/items?pt=wildlife HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned. The payload that is returned from a partial term match is identical to the payload returned from a ","type":"text"},{"text":"List All","type":"text","marks":[{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/pages/resumedraft.action?draftId=1565362707#CommonServicesRESTAPIdocumentation-list-all"}}]},{"text":" request:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"50dfe468-d837-49a8-8d8d-9b618b6a8088"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If no object/procedure/record instances match the partial term provided, a response with a \"200 OK\" HTTP status code, containing an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e544c2c6-6607-4f13-a91f-3446d26d5071"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources could not be read because the client submitting the request was not authorized to read it.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources does not exist. This may occur, for example, if a path element in the request URL is incorrect. Note that if a list of resources does exist, but currently contains zero items that are matched by the partial term, a success response with a \"200 OK\" HTTP status code will be returned, containing an empty list - a list with only a root element, but no child elements.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the list of resources from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Term Status Filtering for Authority terms","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"This section is in process and is currently incomplete.","type":"text"}]},{"type":"paragraph","content":[{"text":"Filters out returned terms based upon termStatus values. This may be combined with other searches, and so returns the same list results as other list and search operations. The parameter may specify one or more string values, corresponding to values set in the termStatus field of Authority items.","type":"text"}]},{"type":"paragraph","content":[{"text":"For those items that would otherwise be returned from the list or search operation, all items will be returned ","type":"text"},{"text":"except","type":"text","marks":[{"type":"em"}]},{"text":" those that have a termStatus matching any of the specified filter values. Those values will be ","type":"text"},{"text":"excluded","type":"text","marks":[{"type":"em"}]},{"text":" from the results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that, currently, termStatus filtering functionality is supported only by selected services:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Vocabulary service.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The authority services (e.g. Person, Organization).","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Term status filtering is applied to search and list operations, and so is invoked as the corresponding HTTP GET methods on the associated resources:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"817c7788-a463-49e8-a29e-6475fc04a622"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/personauthorities/{csid}/items?ts=Rejected HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"daf55289-01d5-4b02-b428-126bc71a9b00"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/personauthorities/{csid}/items?pt=JoeBob&ts=Rejected HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the ","type":"text"},{"text":"HTTP Status Code","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"}}]},{"text":" that is returned in the response's HTTP headers for the specific error.If all terms match on (e.g. are filtered out by) the termStatus values provided in the filter, a response with a \"200 OK\" HTTP status code, containing an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"82304132-bbc3-4305-8785-db3f48b082ce"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources could not be read because the client submitting the request was not authorized to read it.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of resources does not exist. This may occur, for example, if a path element in the request URL is incorrect. Note that if a list of resources does exist, but currently contains zero items that are matched by the partial term, a success response with a \"200 OK\" HTTP status code will be returned, containing an empty list - a list with only a root element, but no child elements.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the list of resources from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Related Authority References for object/procedure/record instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves and returns all references to authorities found in an individual object or procedural record. (Stated another way, retrieves the authority terms used in a record, including the fields in which they are used, and provides links for accessing detailed information about each term.)","type":"text"}]},{"type":"paragraph","content":[{"text":"Instances for which the authenticated user does not have read privileges, will not be returned in results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Verify whether this assertion is currently accurate for related authority references.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"A call to retrieve related authority references is invoked as an HTTP GET method on the primary resource, followed by the \"authorityrefs\" path component. Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9e31b087-9893-45c0-ad09-eaa14b3dcebf"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/intakes/{csid}/authorityrefs/ HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned, with a payload similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6004cc50-9d27-4bad-a0d4-940b543bac65"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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":" depositor","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:personauthority:id(6f58aea7-defd-45a2-910c):person:id(49b382e8-b23f-4142-ad53)'James+Adams'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" James+Adams","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /personauthorities/6f58aea7-defd-45a2-910c/items/49b382e8-b23f-4142-ad53","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":"In the above example, the 'depositor' field of the specified Intake resource has been identified as containing the term \"James Adams\", which in turn comes from a specified Person Authority. Information about that term can then be accessed via the path specified in the 'uri' field.","type":"text"}]},{"type":"paragraph","content":[{"text":"Some multivalued fields may contain more than one term. In those cases, multiple list items - one for each term found - will be returned for those fields.","type":"text"}]},{"type":"paragraph","content":[{"text":"If no related authority references are found in the record, a response with a \"200 OK\" HTTP status code, containing an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"99067cfe-ce3c-4e81-9038-f5b616423afa"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of authority references could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of authority references could not be read because the client submitting the request was not authorized to read the relevant resource.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource from which a list of authority references was requested does not exist. Note that if the resource does exist, but currently contains no authority references, a success response with a \"200 OK\" HTTP status code will be returned, containing an empty list - a list with only a root element, but no child elements.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the list of authority references, or the relevant resource from which that list was requested, from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Related Object References for authority items","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves and returns all objects (procedures, etc) that reference a given authority item. Information returned includes an abstraction of the fields in which they are used.","type":"text"}]},{"type":"paragraph","content":[{"text":"Instances for which the authenticated user does not have read privileges, will not be returned in results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Verify whether this assertion is currently accurate for related object references (probably ","type":"text"},{"text":"not","type":"text","marks":[{"type":"em"}]},{"text":").","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"A call to retrieve related authority references is invoked as an HTTP GET method on the authority item resource, followed by the \"refObjs\" path component. Send an HTTP request of the form (the specific path is only an example - the appropriate path is documented in each service API):","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"f055b085-b63c-4b09-aa2d-5dd9c9bb2fac"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/personauthorities/urn:cspace:name(person)/items/{csid}/refObjs/ HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned, with a payload similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"84e0c1f2-39dc-4126-bbb3-717f3cc0671c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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":" Intake","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" d38d5652-5e51-4a15-9ab9","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" IN2011.1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" intakes_common:depositor","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:core.collectionspace.org:personauthorities:name(person):item:name(JaneDoe1705026588599)'Jane Doe'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /intakes/d38d5652-5e51-4a15-9ab9","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":"In the above example, the 'depositor' field of the specified Intake resource has been identified as containing the item of interest (from a specified Person Authority). Since any type of object or procedure could be returned, the listed information fields are abstract. The document ID is the internal CSID. The docNumber is drawn from a field configured in the tenant bindings to be a \"number\" field. A \"name\" field can also be configured. The source field in the referring record is indicated, as well as the value of that field. The value can be used to determine the exact term on that was used on the record, in the case that the given authority item contains multiple terms (synonyms).","type":"text"}]},{"type":"paragraph","content":[{"text":"If a record has multiple references to a given authority item, multiple entries for that referring record will be returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"An additional query/filter parameter may be specified: \"type\". This specifies one of a set of configured \"classes\" of document types to return. In the default configuration, there are types defined \"object\", \"procedure\", \"authority\", etc. If no type is specified, it will default to \"procedure.\"","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"54e62df6-4dcf-4e58-b98f-9e4459156f10"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/personauthorities/urn:cspace:name(person)/items/{csid}/refObjs?type=procedure HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If no related authority references are found in the record, a response with a \"200 OK\" HTTP status code, containing an empty list - a list with only a root element, but no child elements - is returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"If an error occurred, some non-2xx code will be returned. Check the HTTP status code that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"6a284795-d2bd-4e53-9648-5cb090e6bdc4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of references could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The list of references could not be read because the client submitting the request was not authorized to read the relevant resource.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource from which a list of references was requested does not exist. Note that if the resource does exist, but currently contains no references to the item, a success response with a \"200 OK\" HTTP status code will be returned, containing an empty list - a list with only a root element, but no child elements.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the list of references, or the relevant resource from which that list was requested, from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Read workflow state of an object/procedure/record instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves and returns the workflow state of an individual object or procedural record.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"A call to retrieve the workflow state is invoked as an HTTP GET method on an individual object/procedure/record instance, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":", and followed by the \"workflow\" path component. Standard authentication applies, and user must have read privileges for workflow state.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"1fe7fca1-49a9-48ba-9158-26468d41f195"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/collectionobjects/{csid}/workflow HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned, with a payload similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ef28f060-42f5-4a06-a750-51947866ab92"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" deleted","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":"If an error occurred, some non-2xx code will be returned. Check the ","type":"text"},{"text":"HTTP Status Code","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"}}]},{"text":" that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5750c961-d95f-4aca-89d6-56f5459f250b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad Request","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be updated because the data sent in the entity body of the request was bad, as determined by the service.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be read (i.e. returned) because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be read because the client submitting the request was not authorized to read the relevant resource.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource from which the workflow state was requested does not exist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the workflow state from being read.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Update workflow state of an object/procedure/record instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates the workflow state of an individual object or procedural record.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Versions 2.3 and later","type":"text"}]},{"type":"paragraph","content":[{"text":"In versions 2.3 and later, any particular type of record may have a specific set of workflow states and associated transitions to those workflow states (described collectively as a \"lifecycle\"). Currently:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Most records in CollectionSpace have a default set of workflow states and transitions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Location/Movement/Inventory records have a similar, 'locking' set of workflow states and transitions, that also includes a \"lock\" transition to a \"locked\" state. Records in a locked state can't be edited, or (generally) have their workflow state further changed, making it feasible to \"hard save\" selected records for auditing purposes.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"You can find the workflow states and state transitions available for records that use either the default (\"cs_default\") or 'locking' (\"cs_locking\") lifecycles in ","type":"text"},{"text":"this file","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/collectionspace/services/blob/master/3rdparty/nuxeo/nuxeo-platform-collectionspace/src/main/resources/OSGI-INF/default-life-cycle-contrib.xml"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"A call to update the workflow state is invoked as an HTTP PUT method on an individual object/procedure/record instance, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":", followed by the \"workflow\" path component and a path component for a specific transition to a different workflow state. Standard authentication applies, and user must have Update privileges for the type of transition being requested. No payload is sent in the body of this PUT request.","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of an Update request to the CollectionObject service, to update the workflow state of the CollectionObject record whose ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" is 850161ed-466c-4af2-bc45 to the workflow state of ","type":"text"},{"text":"deleted","type":"text","marks":[{"type":"code"}]},{"text":", follows below. See each individual service's API documentation for further details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ec929dfb-e85f-4e13-94fd-1feb11d87995"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/collectionobjects/850161ed-466c-4af2-bc45/workflow/delete HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned, with a payload similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c32b72dc-ec95-4e35-bf68-ad5e1644392b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" cs_default","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" deleted","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":"An example of an Update request to the CollectionObject service, to update the workflow state of the CollectionObject record whose ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" is 850161ed-466c-4af2-bc45 to the workflow state of ","type":"text"},{"text":"project","type":"text","marks":[{"type":"code"}]},{"text":" (i.e. active), follows below. See each individual service's API documentation for further details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"550e135c-56d3-4b7b-a299-8691186ef94c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/collectionobjects/850161ed-466c-4af2-bc45/workflow/undelete HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"On success, a response with a \"200 OK\" HTTP status code is returned, with a payload similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"acc9c0d7-ec87-45de-b2b0-82bad2bc9362"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" cs_default","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" project","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":"An example of an Update request to the Movement service, to update the workflow state of the Location/Movement/Inventory record whose ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" is ea90563a-9b34-4347-a3ab to the workflow state of ","type":"text"},{"text":"locked","type":"text","marks":[{"type":"code"}]},{"text":" (\"hard saved\"), follows below.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ffaa13eb-d6cf-4e54-8399-df509cad0eba"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/movements/ea90563a-9b34-4347-a3ab/workflow/lock HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"77dde458-9960-41c9-98da-14479fac4eab"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" cs_locking","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" locked","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":"If an error occurred, some non-2xx code will be returned. Check the ","type":"text"},{"text":"HTTP Status Code","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"}}]},{"text":" that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"00af57f9-b6de-450f-9cba-a36e7e45cb19"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be updated because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be updated because the client submitting the request was not authorized to update that state.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource on which a workflow state update was requested does not exist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the workflow state from being updated.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Versions 2.2 and earlier","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"In versions 2.2 and earlier, the only meaningful workflow states to which you can update (or \"transition\") a record in CollectionSpace are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"project","type":"text","marks":[{"type":"code"}]},{"text":" This represents an active record, and is the default workflow state for a newly-created record.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deleted","type":"text","marks":[{"type":"code"}]},{"text":" This represents a \"soft deleted\" record; i.e. a record that has been marked for deletion. The record and all of its data still exist within the CollectionSpace system, although the record may not be returned via some GET requests. (See ","type":"text"},{"text":"Filtering on workflow state","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3577544705/Common+Services+REST+API#Filtering-on-workflow-state"}}]},{"text":" for details.) The record can be \"undeleted\" by having its workflow state updated back to the ","type":"text"},{"text":"project","type":"text","marks":[{"type":"code"}]},{"text":" state.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Other workflow states may be added in future releases.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Calling method and Arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"A call to update the workflow state is invoked as an HTTP PUT method on an individual object/procedure/record instance, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":", and followed by the \"workflow\" path component. Standard authentication applies, and user must have update privileges for workflow state.","type":"text"}]},{"type":"paragraph","content":[{"text":"You can update a record to a different workflow state by specifying that state in the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" element in the payload of your UPDATE request.","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of an Update request to the CollectionObject service, to update the workflow state of the record whose ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":" is 850161ed-466c-4af2-bc45 to the workflow state of ","type":"text"},{"text":"deleted","type":"text","marks":[{"type":"code"}]},{"text":", follows below. See each individual service's API documentation for further details:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5b7fcfea-207a-40f1-8e2f-70ca333d8fae"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/collectionobjects/850161ed-466c-4af2-bc45/workflow HTTP/1.1","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" deleted","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":"On success, a response with a \"200 OK\" HTTP status code is returned, with a payload similar to the following example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"87e147ad-9e0f-4206-a2b5-c13e8aa07084"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"HTTP/1.1 200 OK","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Type: application/xml","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content-Length: nnn","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"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","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" deleted","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":"If an error occurred, some non-2xx code will be returned. Check the ","type":"text"},{"text":"HTTP Status Code","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"}}]},{"text":" that is returned in the response's HTTP headers for the specific error.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7660655e-5ac9-49bb-940d-ba313f08c0bf"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Error (Status Code)","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Meaning","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returned When","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"400","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Bad Request","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be updated because the data sent in the entity body of the request was bad, as determined by the service.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"401","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Unauthorized","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be updated because the client submitting the request either has not provided authentication credentials, or authentication failed (e.g. due to an invalid username or password) after such credentials were provided.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"403","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Forbidden","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The workflow state could not be updated because the client submitting the request was not authorized to update that state.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"404","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Not Found","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The resource on which a workflow state update was requested does not exist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Internal Server Error","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A service error prevented the workflow state from being updated.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"List related records","type":"text"}]},{"type":"paragraph","content":[{"text":"This section is an early placeholder; it needs considerable expansion and refinement.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"List related records via the Relations service","type":"text"}]},{"type":"paragraph","content":[{"text":"For a rich set of REST API calls to return related records via the Relations service, please see ","type":"text"},{"text":"Relationship Service RESTful APIs","type":"text","marks":[{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CSPACE50/pages/665882909"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"These calls all return lists of Relation records, the \"linking\" records that relate any two other types of records.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"List related records via rtSbj and rtObj","type":"text"}]},{"type":"paragraph","content":[{"text":"To list records ","type":"text"},{"text":"of a specific type","type":"text","marks":[{"type":"em"}]},{"text":" that are related to a particular 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/cstd/pages/3579052033/CollectionSpace+ID+CSID"}}]},{"text":", add the ","type":"text"},{"text":"rtSbj","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"rtObj","type":"text","marks":[{"type":"code"}]},{"text":" query parameter to the call.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, to list Movement records related to the record (which can be of nearly any type) specified by CSID 850161ed-466c-4af2-bc45, where that specified record is the ","type":"text"},{"text":"subject","type":"text","marks":[{"type":"em"}]},{"text":" of the relationship:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5a776e3a-651e-4848-a053-52057b59c7e5"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/movements?rtSbj=850161ed-466c-4af2-bc45 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Similarly, to list Movement records related to the record specified by CSID 850161ed-466c-4af2-bc45, where that record is the ","type":"text"},{"text":"object","type":"text","marks":[{"type":"em"}]},{"text":" of the relationship:","type":"text"}]},{"type":"paragraph"},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d84f3262-5052-43d5-96ac-9bbc573a263c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/movements?rtObj=850161ed-466c-4af2-bc45 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Both of the above requests return lists of Movement records.","type":"text"}]}],"version":1}

Browser not supported