Skip to end of metadata
Go to start of metadata

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

Valuation Control CRUD+L services

Create a Valuation Control

Creates a new Valuation Control record. Assigns a unique, service-specified CollectionSpace ID (CSID) to that Valuation Control record. Follows standard Create model. See the documentation of the Valuation Control schema, below. Example:

Read a Valuation Control

Reads an existing Valuation Controlv record, specified by its CollectionSpace ID (CSID). Follows standard Read model. See the documentation of the Valuation Control schema, below. Example:

Update a Valuation Control

Updates an existing Valuation Control record, specified by its CollectionSpace ID (CSID). Follows standard Update model. See the documentation of the Valuation Control schema, below. Example:

Delete a Valuation Control

Deletes an existing Valuation Control record, specified by its CollectionSpace ID (CSID). Follows standard Delete model. Example:

List Valuation Control instances

Lists existing Valuation Control records, with summary information for each. Follows standard List model. See the documentation of the Valuation Control list schema, below. Example:

List supports query parameters for customizing list results, such as pagination controls, query filters, and sorting options. For example:

List also supports query parameters for searching for matching records, including keyword search. For example:

Valuation Control REST payload schemas

Valuation Control instance schema
Icon

The schemas below are severely abbreviated, and are thus illustrative. For a full list of the fields that may potentially be present in payloads when creating, updating, or reading individual Valuation Control records, please see the Valuation Control record schema.

Create and Update should use the following schema:

Read will return the following schema:

Valuation Control list schema

List (and variants) will return the following schema. This schema includes the uri and csid fields to help facilitate access to individual records:

See also

Common Services REST API documentation

  • No labels