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.
Click here to download
Description: Set Object.
The set id. Should be used in subsequent queries.
The set name.
|The set description.|
The type of the set (Logical/Itemized).
Possible codes are listed in 'SetType' code table.
The type of the content of the set.
Possible codes are listed in 'SetContentType' code table.
Indication if the set is private.
Possible codes are listed in 'SetPrivacy' code table.
Default is true.
Status of the set (Active/Inactive).
Possible codes are listed in 'SetStatus' code table.
Default is 'Active'.
Date of the last status change of the set.
|The sets' related note.|
Creator of the set.
Creation date of the set.
The logical set's related query.
Relevant and mandatory for logical sets.
A count of the number of 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
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.
The origin of the members of the set (Institution only/Community Zone).
Possible codes are listed in 'SetOrigin' code table.
Default is UI.