API Docs

Ex Libris Developer Network Alma Documentation REST APIs API Docs

Create a Set

Resource URL
API Description
URL Parameters
Query string Parameters
Body Parameters
Output
Possible Error Codes

Web service for creating or combining a set.

If you are creating a new set, you can use this API to create 2 types of sets: Itemized set, Logical set
In order to create an itemized set, first create an empty set using this API, and then use the Manage Members API to populate it.
Creating logical sets is supported for Inventory related entities, Users and Vendors (not supported for PO-Lines, etc).
Details regarding the syntax for creating Logical Sets can be found here.

In addtion, it is possible to create an itemized set and populate it from a logical set by setting the logical set id in the from_logical_set parameter.
It is also possible to create an itemized Bib record set which is based on MD Import job by providing job instance id and population.
For more details about MD import based itemized set see here.
If you are combining sets, then set1 and set2 must be provided. Those two sets will be combined with a new combined set created.

TRY IT NOW

Resource URL

POST /almaws/v1/conf/sets

API Description

WADL documentation: Download
Swagger (OpenAPI) documentation: Download

URL Parameters

None

Querystring Parameters

Parameter	Type	Required	Description
`population`	xs:string	Optional.	The population on which a set should be created. Optional.
`job_instance_id`	xs:string	Optional.	The id of MD Import Job instance from which a set should be created. Supported for sets of Bib records. Optional.
`from_logical_set`	xs:string	Optional.	An id of a logical set to create an Itemized Set based on it. Optional.
`combine`	xs:string	Optional. Default: None	The logical operator. Choose between AND, OR, NOT. Default is AND. Optional
`set1`	xs:string	Optional. Default: None	The primary combining set. Optional.
`set2`	xs:string	Optional. Default: None	The secondary combining set. Optional.
`nz_set_from_iz_set`	xs:string	Optional.	An id of an Institution Zone set which will be used as a base to create a set in the Network Zone. The new set will include the Network Zone records to which the Institution Zone records are linked. Optional.
`filter_set`	xs:string	Optional.	An id of a set to create a new filtered set based on it, according to the indication_rule parameter. Optional.
`indication_rule`	xs:string	Optional.	The name of the Indication Rule to be used to filter the set defined in filter_set. Relevant if filter_set is used.

Body Parameters

This method takes a Set object. See doc

Output

This method returns a Set object. See doc

Possible Error Codes

Code	Message
402119	General Error - An error has occurred while processing the request.
500127	'job_instance_id' and 'population' must be provided together.
402262	Set type is invalid. Only 'ITEMIZED' and 'LOGICAL' sets are supported.
402263	The set name already exists. Please choose a different name.
402264	Set ID is invalid.
402265	Failed to create a set.
402266	Population value is invalid.
402267	Job instance type for the provided job_instance_id is not MD_IMPORT - the operation is not supported.
60204	Set combine operator not valid.
60205	Combining sets are not the same type.
60206	Sets combine operation failed.
60209	Set private value not valid.
60210	Set status not valid.
60311	Combining sets are not the same origin.
402218	Invalid job instance id.
60334	Failed to create a set in Network.
60335	The From Institution Zone is not allowed for institution not in Network.
60107	The set ID provided for the Institution Zone set is not valid.
60336	The set type is not allowed for creation as network set.