Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Div
stylefont-weight:bold;font-size:1.2em;
Vocabulary Service Home

Brief Description

Wiki Markup
{multi-excerpt-include:Vocabulary Service Description and Assumptions|name=brief-description|nopanel=true}
For a full description, visit the Service Description and Assumptions page.

Assumptions

Wiki Markup
{multi-excerpt-include:Vocabulary Service Description and Assumptions|name=brief-assumptions|nopanel=true}
For a complete list of assumptions, visit the Service Description and Assumptions page.

References

Vocabulary and Authority Overview
Vocabulary Service Description and Assumptions
Vocabulary Service Entity Diagrams

REST-based API

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. These follow the Common model for CollectionSpace REST services.

...

Creates a new Vocabulary record. Assigns a unique, service-specified CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 to that Vocabulary record. Follows standard Create model. See the documentation of the Vocabulary schema, below. Example:

...

Reads an existing Vocabulary record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the Vocabulary schema, below.

...

An alternate form reads an existing Vocabulary record, specified by its short identifier /wiki/spaces/collectionspace/pages/666273476, which matches the value of the shortIdentifier field in the record. Otherwise follows standard Read model. See the documentation of the Vocabulary schema, below.

...

Updates an existing Vocabulary record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the Vocabulary schema, below. Example:

...

Deletes an existing Vocabulary record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:

...

Creates a new VocabularyItem record. Assigns a unique, service-specified CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 to that VocabularyItem record. Follows standard Create model. See the documentation of the VocabularyItem schema, below. Example:

...

Reads an existing VocabularyItem record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the VocabularyItem schema, below. Example:

...

Updates an existing VocabularyItem record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the VocabularyItem schema, below. Example:

...

Deletes an existing VocabularyItem record, specified by its CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:

...