{"type":"doc","content":[{"type":"layoutSection","content":[{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"paragraph","content":[{"text":"Table of Contents","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"style":{"value":"disc"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"61238332-bf9b-4488-b70b-6e3bac86513a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c4d3f7d6-82a9-4778-af33-6fd7dc6cffa8"}}]},{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"blockquote","content":[{"type":"paragraph","content":[{"text":"About Vocabulary Service","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The Vocabulary Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Vocabulary instances, and on the associated VocabularyItem instances. ","type":"text"}]},{"type":"paragraph","content":[{"text":"These follow the ","type":"text"},{"text":"Common model for CollectionSpace REST services","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3577544705"}}]},{"text":".","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Note that the VocabularyItem instances are not directly \"addressible\"; they can only be accessed via the parent Vocabulary.","type":"text"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Vocabulary CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new Vocabulary record. Assigns a unique, service-specified ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":" to that Vocabulary record. Follows standard Create model. See the documentation of the Vocabulary schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b4f26df4-701d-453e-b3bb-6a33eca476d4"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/vocabularies HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing Vocabulary 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/CSPACE50/pages/665882927"}}]},{"text":". Follows standard Read model. See the documentation of the Vocabulary schema, below.","type":"text"}]},{"type":"paragraph","content":[{"text":"General form:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b376c158-3302-4de5-b0a6-4b34e0ac9467"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Example, reading an existing record with a CSID of e450e8e8-9f12-49f3-aba4-43b7c46344a2:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"616f6fad-b373-4b84-be64-e31f00641100"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/e450e8e8-9f12-49f3-aba4-43b7c46344a2 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"An alternate form reads an existing Vocabulary record, specified by its ","type":"text"},{"text":"short identifier","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052069"}}]},{"text":", which matches the value of the ","type":"text"},{"text":"shortIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" field in the record. Otherwise follows standard Read model. See the documentation of the Vocabulary schema, below.","type":"text"}]},{"type":"paragraph","content":[{"text":"General form:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"4bec93e1-472b-4a1f-a157-12c792e63ad2"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/urn:cspace:name({id}) HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Example, reading an existing record with a ","type":"text"},{"text":"shortIdentifier","type":"text","marks":[{"type":"code"}]},{"text":" value of ","type":"text"},{"text":"myDefaultVocabulary","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"31af987b-0ab3-4c01-9efe-e89fb7cf177b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/urn:cspace:name(myDefaultVocabulary) HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing Vocabulary record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Update model. See the documentation of the Vocabulary schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"14df75f7-d44c-4c59-acd8-a7fff6e20c77"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/vocabularies/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing Vocabulary record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"9f3695b1-218f-4c92-8029-0a7938a9e1e2"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/vocabularies/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List Vocabulary instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing Vocabulary records, with summary information for each. Follows standard List model. See the documentation of the Vocabulary-List schema, below.","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b9eb6b83-d71b-4a95-a311-4e8a2fd7acb5"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"55dafc37-5a71-4973-b353-ddf710644f5b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies?pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List also supports query parameters for searching for matching records, including keyword search. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"4b8410a5-943b-409f-b0a8-227cc8ca70fc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies?kw=foo&pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Vocabulary REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Vocabulary instance schema","type":"text"}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema. The value of ","type":"text"},{"text":"vocabType","type":"text","marks":[{"type":"em"}]},{"text":" must be \"enum\".","type":"text"}]},{"type":"paragraph","content":[{"text":"Validation constraints:","type":"text","marks":[{"type":"strong"}]},{"text":" Values for ","type":"text"},{"text":"shortIdentifier","type":"text","marks":[{"type":"em"}]},{"text":" must be non-null and may only include word characters (\"a-zA-Z0-9_\"), or call will return 400 Bad Request.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"dd4610db-b82c-405c-b636-55ad4d056c34"},"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":" Gender Values","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" gender","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:vocabulary:name(gender)'Gender Values'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" enum","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Read will return the above, plus additional fields (","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":") for access:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"3c1f7d0b-6bb4-4ab2-af61-d1634abe9d92"},"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":" /vocabularies/f0cf4c50-8f8a-4df0-869a","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" f0cf4c50-8f8a-4df0-869a","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Vocabulary-List schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return the following schema. Note the standard pagination support.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"6b9eef88-857c-4987-bfa6-858b7484cbcf"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 40","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 3","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Gender Values","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:vocabulary:name(gender)'Gender Values'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" enum","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /vocabularies/f0cf4c50-8f8a-4df0-869a","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" f0cf4c50-8f8a-4df0-869a","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"VocabularyItem CRUD+L services","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"VocabularyItem instances are only accessible via the owning Vocabulary. The sub-resource is accessed with \"","type":"text"},{"text":"items","type":"text","marks":[{"type":"em"}]},{"text":"\" (this is consistent across all vocabulary-like services). In the examples below, the ","type":"text"},{"text":"{vocabulary-id}","type":"text","marks":[{"type":"em"}]},{"text":" parameter represents an identifier (such as a CSID value) of an existing Vocabulary instance.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create a VocabularyItem in a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new VocabularyItem record. Assigns a unique, service-specified ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":" to that VocabularyItem record. Follows standard Create model. See the documentation of the VocabularyItem schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"8b4492a2-4cde-4792-aee4-d28c299d5edc"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST /cspace-services/vocabularies/{vocabulary-id}/items HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Read a VocabularyItem in a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Reads an existing VocabularyItem record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Read model. See the documentation of the VocabularyItem schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"b0e8c5ef-244a-4952-a85d-594c68b38105"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/{vocabulary-id}/items/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update a VocabularyItem in a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing VocabularyItem record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Update model. See the documentation of the VocabularyItem schema, below. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"45a42b44-fb13-4d57-9453-2ef19023a1c3"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PUT /cspace-services/vocabularies/{vocabulary-id}/items/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete a VocabularyItem in a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an existing VocabularyItem record, specified by its ","type":"text"},{"text":"CollectionSpace ID (CSID)","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/CTDN/pages/3579052033"}}]},{"text":". Follows standard Delete model. Example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"6b333f10-0fbd-47da-b14b-24080900cf69"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE /cspace-services/vocabularies/{vocabulary-id}/items/{id} HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List VocabularyItem instances in a Vocabulary","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists existing VocabularyItem records, with summary information for each. Follows standard ","type":"text"},{"text":"List","type":"text","marks":[{"type":"underline"},{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/DOC/pages/2930128458"}}]},{"text":" model. The vocabulary may be specified either using the CSID or the shortIdentifier, using the syntax described for vocabulary read, described above. See the documentation of the VocabularyItem-List schema, below.","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"2871b1bc-8977-4145-be3f-0f76dc1318df"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/{vocabulary-id}/items HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"f744d4f3-5a5f-4810-9ac8-aeebed880e9c"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/{vocabulary-id}/items?pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"List also supports query parameters for searching for matching records, including:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"keyword search","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"partial term matching search, for term completion","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"term status filtering, to exclude (filter out) records matching one or more statuses","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"61e43c93-3c74-408b-9a81-ab8c187ddee3"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET /cspace-services/vocabularies/{vocabulary-id}/items?pt=foo&pgSz=10 HTTP/1.1","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"VocabularyItem REST payload schemas","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"VocabularyItem instance schema","type":"text"}]},{"type":"paragraph","content":[{"text":"Create and Update should use the following schema. The value of ","type":"text"},{"text":"inVocabulary","type":"text","marks":[{"type":"em"}]},{"text":" must match the parent vocabulary, and must not be modified once the instance is created.","type":"text"}]},{"type":"paragraph","content":[{"text":"Validation constraints:","type":"text","marks":[{"type":"strong"}]},{"text":" On create and update, ","type":"text"},{"text":"displayName","type":"text","marks":[{"type":"em"}]},{"text":" must be non-null and at least 2 characters long, or call will return 400 Bad Request. Values for ","type":"text"},{"text":"shortIdentifier","type":"text","marks":[{"type":"em"}]},{"text":" must be non-null and may only include word characters (\"a-zA-Z0-9_\").","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"5c11ce8c-7448-4029-80ba-26524cdd68c9"},"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":" f0cf4c50-8f8a-4df0-869a","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" Male Gender","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" male","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:vocabulary:name(gender):item:name(male)'Male Gender'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Note: You might need to wrap some of the payload in tags, e.g.,","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"59a5cff7-8409-4563-974e-da89fc26ac20"},"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":" 42f984c3-4e24-4702-8825","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" active","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" box","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" box","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:ucjeps.cspace.berkeley.edu:vocabularies:name(locationtype):item:name(box)'box'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Read will return the above, plus additional fields (","type":"text"},{"text":"uri","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"csid","type":"text","marks":[{"type":"em"}]},{"text":") for access:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"aed05609-536e-48ab-9ce6-31b80a00069d"},"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":"/vocabularies/f0cf4c50-8f8a-4df0-869a/items/a256aed3-0b0a-44e6-84b0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"a256aed3-0b0a-44e6-84b0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"VocabularyItem-List schema","type":"text"}]},{"type":"paragraph","content":[{"text":"List (and variants) will return the following schema. Note the standard pagination support.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"87580951-0493-4ab0-9d90-435ff362132b"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"initial","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 40","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 3","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" male","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" urn:cspace:org.collectionspace.demo:vocabulary:name(Gender):item:name(male)'Male Gender'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" /vocabularies/f0cf4c50-8f8a-4df0-869a/items/a256aed3-0b0a-44e6-84b0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" a256aed3-0b0a-44e6-84b0","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ...","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"rule"}],"version":1}

Browser not supported