API Docs

__METHOD= GET . __PATH= /almaws/v1/acq/licenses/ .

Get Licenses

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

Resource URL

GET /almaws/v1/acq/licenses/

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
qxs:stringOptional. Default: allSearch query. Optional. Searched fields: name, code, licensor. (see Brief Search)
statusxs:stringOptional. Default: ALLLicense status. Optional. Valid values are ACTIVE, DELETED, DRAFT, EXPIRED, RETIRED, ALL. Unless specified, deleted records are excluded.
typexs:stringOptional. Default: LICENSELicense type. Optional. Valid values are LICENSE, NEGOTIATION, ADDENDUM, ALL. Default: LICENSE
review_statusxs:stringOptional. Default: ALLLicense review status. Optional. Valid values are ALL, and the listed values in LicenseReviewStatuses code table. Default: ALL
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
expandxs:stringOptional. Default: noneThis parameter allows for expanding on some information. Currently only one option is available: attachments.
create_date_fromxs:stringOptional.Retrieve licenses with create date after this Date (YYYY-MM-DD). Optional.
create_date_toxs:stringOptional.Retrieve licenses with create date before this Date (YYYY-MM-DD). Optional.
modify_date_fromxs:stringOptional.Retrieve licenses with modify date after this Date (YYYY-MM-DD). Optional.
modify_date_toxs:stringOptional.Retrieve licenses with modify date before this Date (YYYY-MM-DD). Optional.

Body Parameters

None

Output

This method returns a Licenses object. See doc

Possible Error Codes

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