Brief Description

Assumptions

References

Vocabulary and Authority Overview
Organization Service Description and Assumptions
Organization Service Entity Diagrams
Name Authority Schema and Name Authority Schema - Limited for Release 0.4 and 0.5

REST-based API

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

Note that the Organization instances are not directly "addressible"; they can only be accessed via the parent OrganizationAuthority.

• OrganizationAuthority CRUD+L services
• OrganizationAuthority REST payload schemas
• Organization CRUD+L services
• Organization REST payload schemas

OrganizationAuthority CRUD+L services

Create an OrganizationAuthority

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

Read an OrganizationAuthority

Reads an existing OrganizationAuthority record, specified by its /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the OrganizationAuthority schema, below. Example:

Update an OrganizationAuthority

Updates an existing OrganizationAuthority record, specified by its /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the OrganizationAuthority schema, below. Example:

Delete an OrganizationAuthority

Deletes an existing OrganizationAuthority record, specified by its /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:

List OrganizationAuthority instances

Lists existing OrganizationAuthority records, with summary information for each. Follows standard List model, with pagination support. See the documentation of the OrganizationAuthority-List schema, below. List supports the following common parameters for List results, pagination controls and query filters:

• pgSz for page size
• pgNum for page size

Examples:

OrganizationAuthority REST payload schemas

OrganizationAuthority instance schema

Create and Update should use the following schema. The value of vocabType must be "OrgAuthority".

Read will return the above, plus additional fields (uri and csid) for access:

OrganizationAuthority-List schema

List (and variants) will return the following schema.

Organization CRUD+L services

Organization instances are only accessible via the owning OrganizationAuthority. The sub-resource is accessed with "items" (for consistency across all vocabulary-like services). In the examples below, the {org-auth-id} parameter represents the CSID value of an existing OrganizationAuthority instance.

Create an Organization in an OrganizationAuthority

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

Read an Organization in an OrganizationAuthority

Reads an existing Organization record, specified by its /wiki/spaces/collectionspace/pages/666274321. Follows standard Read model. See the documentation of the Organization schema, below. Example:

Update an Organization in an OrganizationAuthority

Updates an existing Organization record, specified by its /wiki/spaces/collectionspace/pages/666274321. Follows standard Update model. See the documentation of the Organization schema, below. Example:

Delete an Organization in an OrganizationAuthority

Deletes an existing Organization record, specified by its /wiki/spaces/collectionspace/pages/666274321. Follows standard Delete model. Example:

List Organization instances in an OrganizationAuthority

Lists existing Organization records, with summary information for each. Follows standard List model, with pagination support. See the documentation of the Organization-List schema, below. List supports the following common parameters for List results, pagination controls and query filters:

• pgSz for page size
• pgNum for page size
• pt for partial-term matching, to support term completion.

Examples:

Organization REST payload schemas

Organization instance schema

Create and Update should use the following schema. The value of inAuthority must match the parent authority, and must not be modified once the instance is created. The displayName will be computed from the shortName and foundingPlace, if the value of displayNameComputed is TRUE. Note that a number of values must be from authorities, and use the refName value for an authority term.

Validation constraints: On create and update, if displayNameComputed is false, then displayName must be non-null, or call will return 400 Bad Request.

Read will return the above, plus additional fields (uri and csid) for access:

Organization-List schema

List (and variants) will return the following schema.