GeoNetwork

GeoNetwork: `GN_API`

Create the client directly to configure GeoNetwork-specific options:

from geOrchestra.meta_apis import GN_API

server = "https://demo.georchestra.org"
username = "testadmin"
password = "testadmin"

gn = GN_API(
    server,
    username,
    password,
    verifytls=True,
    prefix_gn_url="/geonetwork",
    xsrf_via_get=False,
)

TLS certificate verification is enabled by default. xsrf_via_get=True uses /srv/api/me; the default uses the legacy /srv/fre/info?type=me endpoint to establish the XSRF cookie.

Examples

The following examples come from the __main__ blocks and comments in the sources.

Add a thesaurus keyword to a metadata file and upload it

from geOrchestra.meta_apis import GN_API, Meta_manipulation

gn = GN_API("https://demo.georchestra.org", "testadmin", "testadmin", verifytls=False)

with open("sample_meta.xml") as f:
    metadata = f.read()

metadata = Meta_manipulation.add_thesaurus(
    metadata,
    title="Category",
    server="https://demo.georchestra.org",
    thesaurus_value="test1",
    local_thesaurus_name="exemple",
)

gn.upload_metadata(metadata=metadata, uuidprocessing="OVERWRITE", publish=True)

for thesaurus in gn.get_thesaurus_dict():
    print("Key name:", thesaurus["key"])

gn.closesession()

List active filesystem harvests

all_harvests = geOr_api.gn.get_harvests()
filesystem = [h for h in all_harvests if h["@type"] == "filesystem"]
active = [h for h in filesystem if h["options"]["status"] == "active"]

uuid = "4b5f8e1b-de37-47cd-9203-37a59f318b09"

zip_bytes = geOr_api.gn.get_metadata_mef_zip(uuid, with_related=True)
if zip_bytes:
    with open(f"{uuid}.zip", "wb") as f:
        f.write(zip_bytes)

# groupOwner and isPublishedToAll, to resubmit with an OVERWRITE upload
privileges = geOr_api.gn.get_record_privileges(uuid)

Batch edit records from a search selection

Create and feed a selection first, check its content, then apply the change:

results = geOr_api.gn.search_keyword("Mayotte")
uuids = [hit["_source"]["uuid"] for hit in results["hits"]["hits"]]

geOr_api.gn.feed_search_bucket("geoutilsbucket", uuids)
print(geOr_api.gn.get_search_bucket("geoutilsbucket"))

geOr_api.gn.batch_edit_search_and_replace(
    "geoutilsbucket", search="old text", replace="new text", regex_flags="i"
)

geOr_api.gn.purge_search_bucket("geoutilsbucket")

Catalog and metadata

Method	Purpose	Result notes
`get_gnversion()`	Read GeoNetwork site details and node ID	Parsed JSON object
`get_all_catalog(steps=100, portal=None)`	Collect catalog record UUIDs using CSW paging	List of UUIDs, or `None` if no records/request failure
`get_metadataxml(uuid)`	Read a record XML document	XML text on HTTP 200; otherwise `None`
`get_metadata_mef_zip(uuid, with_related=True, timeout=120)`	Download a MEF ZIP export	ZIP bytes on HTTP 200; otherwise `None`
`upload_metadata(metadata, groupid="100", uuidprocessing="GENERATEUUID", publish=False)`	Upload a metadata file-like object; `uuidprocessing` supports the GeoNetwork values `NOTHING`, `OVERWRITE`, and `GENERATEUUID`	Parsed JSON on success; `False` for handled failures
`get_record_privileges(uuid)`	Read owner group and public visibility	Dictionary on success; otherwise `None`

Thesauri

Method	Purpose
`get_thesaurus_dict(thesaurus_key=None)`	Retrieve thesaurus information, optionally for one key
`searchin_thesaurus_dict(keyword="", thesaurus_key=False)`	Search vocabulary terms, optionally restricted to thesaurus keys
`add_thesaurus_dict(filename)`	Upload a thesaurus file; implementation is experimental and prints request details
`delete_thesaurus_dict(name)`	Delete a thesaurus by its name/key

Harvests

Method	Purpose	Result notes
`get_harvests()`	List harvest configurations	Parsed JSON on success; `"Error"` otherwise
`make_harvest_local(uuid)`	Assign a harvest to the local GeoNetwork node	`"Okay"` or `False`; request timeout is up to one hour
`delete_harvest(id)`	Remove a harvest configuration	Parsed JSON response

Search selections and batch editing

Method	Purpose
`search_keyword(keywords)`	Search records using the configured GeoNetwork query
`get_search_buckets()`	List saved search selections
`get_search_bucket(name)`	Read a selection by name
`feed_search_bucket(name, uuid)`	Add one or more record UUIDs to a selection
`purge_search_bucket(name, uuid=None)`	Remove selected UUIDs, or delete/clear the selection when UUIDs are omitted
`batch_edit_search_and_replace(bucket_name, search, replace, regex_flags="", use_regex="false", update_date_stamp="false")`	Search and replace metadata values for records in a selection
`batch_edit_xpath(bucket_name, xpath, value, update_timestamps=False, action="replace", condition="")`	Apply an XPath-based batch edit to records in a selection

Batch edit methods operate on records in a search bucket. Review the bucket contents before applying changes. Response JSON is returned without a common error wrapper.

Call closesession() when finished with a standalone GN_API client to close its requests session.