Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{div:style=}[Group Service Home|Generic Group Service Home] {div}
Wiki Markup
Div
stylefont-weight:bold;font-size:1.2em;

Group Service Home

Brief Description

Insert excerpt
collectionspace:Generic Group Service Description and Assumptions
collectionspace:Generic Group Service Description and Assumptions
namebrief-description
nopaneltrueGeneric Group Service Description and Assumptions
For a full description, visit the Service Description and Assumptions page.

Assumptions

For a complete list of assumptions, visit the Service Description and Assumptions page.

References

Group User Story Summary
Generic Group Service Description and Assumptions
Group Schema

REST-based API

Note

To obtain a list of items in a group, use the Relations Service to obtain a list of items that are related to that group, via the CollectionSpace ID (CSID) /wiki/spaces/collectionspace/pages/666274321 of the group record.

The Group Service offers a REST-based Application Programming Interface (API) to CRUD (create, read, update, and delete) operations on individual Group instances, plus list operations on multiple Group instances. These follow the Common model for CollectionSpace REST services.

...

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

...

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

...

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

...

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

...