Roam
- class roamPy.roamClass.license(url, header)[source]
- getLicenses()[source]
Iterates through the paginated ‘License’ endpoint to return metadata for all Licenses in the Roam instance.
- Parameters
self – Inherits URL and Header constructors from the Roam Class
- Returns
Returns a list of json objects with metadata for all licenses. One list item for each page of 40 datasets from the endpoint
- getLicenseswRels(relations)[source]
Iterates through the paginated ‘License’ endpoint to return metadata for all Licenses in the Roam instance. Includes urls for related licensePeriods and Publishers.
- Params self
Inherits URL and Header constructors from the Roam Class
- Params relations
A list for strings containing the relations to be included. Can contain licensePeriods, publisher or both
- Returns
Returns a list of json objects with metadata for all licenses. One list item for each page of 40 datasets from the endpoint
- class roamPy.roamClass.products(url, header)[source]
- getAllProducts()[source]
Iterates through the paginated ‘Products’ endpoint to return metadata for all Products in the Roam instance
- Parameters
self – Inherits URL and Header constructors from the Roam Class
- Returns
Returns a list of json objects with metadata for all products. One list item for each page of 40 datasets from the endpoint
- getAllProductswithPub()[source]
Iterates through the paginated ‘Products’ endpoint to return metadata for all Products in the Roam instance. Includes the url for Publisher information.
- Parameters
self – Inherits URL and Header constructors from the Roam Class
- Returns
Returns a list of json objects with metadata for all products. One list item for each page of 40 datasets from the endpoint
- class roamPy.roamClass.subscriptions(url, header)[source]
- getAllSubscriptions()[source]
Iterates through the paginated ‘Subscriptions’ endpoint to return metadata for all Subscriptions in the Roam instance
- Parameters
self – Inherits URL and Header constructors from the Roam Class
- Returns
Returns a list of json objects with metadata for all subsriptions. One list item for each page of 40 datasets from the endpoint
- getOneSubscription(id)[source]
Exports the metadata for a single subscription identified by its subscription ID
- Parameters
self – Inherits URL and Header variables from Roam Class
id – A string that contains the numeric ID of the subscription
- Returns
A json object with metadata for a single subscription
- getOneSubwithRelations(id, relations)[source]
Retrieves the metadata for a subscription and includes corresponding urls to related records
- Parameters
self – Inherits URL and header variables from Roam Class
id – A string that contains the numeric ID of the subscription
relations – A list of strings naming the relations that should be included in the response. Relations can be any of the following: product, subscriptionPeriods, notes, links, files, licensePeriods.license.publisher, licensePeriods.licensePeriodStatus
- class roamPy.roamClass.subscriptionPeriod(url, header)[source]
- getAllSubPeriods()[source]
Exports metadata for all subscription periods. A subscription period refers to a specific time frame for an agreement for a subscription. Cost information is associated with the subscription period. A subscription period relates to one subscription but one subscription can have multiple subscription periods: one period for each signed agreement.
- Parameters
self – Inherits url and header constructor values from the Roam class
- Returns
A json object for every subscription period in the Roam.plus instance
- getSubPeriodById(id)[source]
Exports the metadata for a subscription period with a given id
- Parameters
self – Inherits url and header constructor values from the Roam class
id – String containing numeric identifier of a subscription period
- Returns
Metadata for the subscription with the given id number
- getSubPeriodByIdwithRel(id, relations)[source]
!This Method does not work. The endpoint is listed in the API docs but returns an error!
Exports metadata for a subscription period with a given id and includes URLs of related objects.
- Parameters
self – Inherits url and header constructor values from the Roam class
id – String containing numeric identifier of a subscription period
relations – List of strings describing the realted record urls to return. Can be ‘products’ or ‘vendor’ or both.
- Returns
Currently nothing as endpoint does not work yet.
- getSubPeriodsAfter(date)[source]
Exports the metadata for all subscriptions periods that begin after a given date
- Parameters
self – Inherits url and header constructor values from the Roam class
date – A string containing the data after which the subscription periods should be returned. Must be fomatted ‘YYYY-MM-DD’.
- Returns
Metadata for all subscription periods beginning after the given date
- getSubPeriodsBefore(date)[source]
Exports the metadata for all subscriptions periods that begin before a given date
- Parameters
self – Inherits url and header constructor values from the Roam class
date – A string containing the data before which the subscription periods should be returned. Must be fomatted ‘YYYY-MM-DD’.
- Returns
Metadata for all subscription periods beginning before the given date
- getSubPeriodsBetween(startDate, endDate)[source]
Exports the metadata for all subscriptions periods that begin between two given dates
- Parameters
self – Inherits url and header constructor values from the Roam class
startDate – A string containing the data after which the subscription periods should be returned. Must be fomatted ‘YYYY-MM-DD’.
endDate – A string containing the data before which the subscription periods should be returned. Must be fomatted ‘YYYY-MM-DD’.
- Returns
Metadata for all subscription periods beginning between the two dates.