API Docs

Get Licenses

This API returns a list of licenses.
Templates and deleted licenses are not included.

GET /almaws/v1/acq/licenses/

None

Parameter	Type	Required	Description
`q`	xs:string	Optional. Default: all	Search query. Optional. Searched fields: name, code, licensor. (see Brief Search)
`status`	xs:string	Optional. Default: ALL	License status. Optional. Valid values are ACTIVE, DELETED, DRAFT, EXPIRED, RETIRED, ALL. Unless specified, deleted records are excluded.
`type`	xs:string	Optional. Default: LICENSE	License type. Optional. Valid values are LICENSE, NEGOTIATION, ADDENDUM, ALL. Default: LICENSE
`review_status`	xs:string	Optional. Default: ALL	License review status. Optional. Valid values are ALL, and the listed values in LicenseReviewStatuses code table. Default: ALL
`limit`	xs:int	Optional. Default: 10	Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
`offset`	xs:int	Optional. Default: 0	Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
`expand`	xs:string	Optional. Default: none	This parameter allows for expanding on some information. Currently only one option is available: attachments.
`create_date_from`	xs:string	Optional.	Retrieve licenses with create date after this Date (YYYY-MM-DD). Optional.
`create_date_to`	xs:string	Optional.	Retrieve licenses with create date before this Date (YYYY-MM-DD). Optional.
`modify_date_from`	xs:string	Optional.	Retrieve licenses with modify date after this Date (YYYY-MM-DD). Optional.
`modify_date_to`	xs:string	Optional.	Retrieve licenses with modify date before this Date (YYYY-MM-DD). Optional.

None

This method returns a Licenses object. See doc

Code	Message
402119	General error.
40166411	Param value is invalid.
40166404	Given field X has invalid value Y, please use one of the valid values listed under the Z code table.
401873	Request failed: X