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.

FieldTypeDescription
idstring
The set id. Should be used in subsequent queries.
Output parameter.
namestring
The set name.
Mandatory.
descriptionstringThe set description.
typestring with attr.
The type of the set (Logical/Itemized).
Possible codes are listed in 'SetType' code table.
Mandatory.

The valid values for this parameter are controlled by the code-table: SetType. These are the currently defined values for your institution:
CodeDescription
contentstring with attr.
The type of the content of the set.
Possible codes are listed in 'SetContentType' code table.
Mandatory.

The valid values for this parameter are controlled by the code-table: SetContentType. These are the currently defined values for your institution:
CodeDescription
privatestring with attr.
Indication if the set is private.
Possible codes are listed in 'SetPrivacy' code table.
Default is true.

The valid values for this parameter are controlled by the code-table: SetPrivacy. These are the currently defined values for your institution:
CodeDescription
statusstring with attr.
Status of the set (Active/Inactive).
Possible codes are listed in 'SetStatus' code table.
Default is 'Active'.

The valid values for this parameter are controlled by the code-table: SetStatus. These are the currently defined values for your institution:
CodeDescription
status_datedateTime
Date of the last status change of the set.
Output parameter.
notestringThe sets' related note.
created_bystring with attr.
Creator of the set.
Output parameter.
created_datedateTime
Creation date of the set.
Output parameter.
querystring with attr.
The logical set's related query.
Relevant and mandatory for logical sets.
number_of_membersint with attr.
A count of the number of members.
Output parameter.
membersmembers
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_infostring 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.
originstring 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.

The valid values for this parameter are controlled by the code-table: SetOrigin. These are the currently defined values for your institution:
CodeDescription

 

Samples

XML
JSON
__