API Docs
Rest Set
Overview
A set is a collection of items, such as users or the results of a repository search.
Sets may be used for publishing metadata in bulk, moving a group of records, or to run jobs.
Data Dictionary
Click here to download rest_set.xsd
set
Description: Set Object.
| Field | Type | Description | ||
|---|---|---|---|---|
id | string | The set id. Should be used in subsequent queries. Output parameter. | ||
name | string | The set name. Mandatory. | ||
description | string | The set description. | ||
type | string with attr. | The type of the set (Logical/Itemized). Possible codes are listed in 'SetType' code table. Mandatory.
| ||
content | string with attr. | The type of the content of the set. Possible codes are listed in 'SetContentType' code table. Mandatory.
| ||
private | string with attr. | Indication if the set is private. Possible codes are listed in 'SetPrivacy' code table. Default is true.
| ||
status | string with attr. | Status of the set (Active/Inactive). Possible codes are listed in 'SetStatus' code table. Default is 'Active'.
| ||
status_ | dateTime | Date of the last status change of the set. Output parameter. | ||
note | string | The sets' related note. | ||
created_ | string with attr. | Creator of the set. Output parameter. | ||
created_ | dateTime | Creation date of the set. Output parameter. | ||
query | string with attr. | The logical set's related query. Relevant and mandatory for logical sets. | ||
number_ | int with attr. | A count of the number of members. Output parameter. | ||
members | members | List members of the set. After the set exists, it is possible to add/delete list of members using Manage members API. The payload for this action is a set structure including the members list in this field. The following id types are expected: - Titles: mms_id - Item: item pid or barcode - User: primary id or other id - PO line: pol number - Collections : collection id - Portfolios: portfolio id - File: file id | ||
additional_ | string with attr. | Details about submission of a 'create itemized set' job. Output parameter. This information will be returned when creating a set from MD import population (POST set with population parameter). The "link" attribute will include link for retrieving information about the submitted job instance. | ||
origin | string with attr. | The origin of the members of the set (Institution only/Community Zone). Possible codes are listed in 'SetOrigin' code table. Default is UI.
|
Samples
XML
JSON
__