Resource functions
- get_resource_field_data
- create_resource
- delete_resource
- copy_resource
- get_resource_log
- update_resource_type
- get_resource_path
- get_resource_data
- get_alternative_files
- get_resource_types
- add_alternative_file
- delete_alternative_file
- upload_file
- upload_file_by_url
- upload_multipart
- get_related_resources
- resource_log_last_rows
- replace_resource_file
- get_resource_all_image_sizes
- put_resource_data
- update_related_resource
- relate_all_resources
- get_edit_access
- get_resource_access
- resource_file_readonly
Collection functions
Search functions
IIIF
Metadata functions
User functions
System
Message functions
Plugin functions
- consentmanager_get_consents
- licensemanager_get_licenses
- consentmanager_get_consent
- consentmanager_delete_consent
- consentmanager_batch_link_unlink
- consentmanager_link_consent
- consentmanager_unlink_consent
- consentmanager_create_consent
- consentmanager_update_consent
- consentmanager_get_all_consents
- consentmanager_get_all_consents_by_collection
save_collection
Save collection data.
Please note that due to the nature of how the web works, it is best to POST the request for this API binding to avoid URL limits being reached.
Variable | Description | Data type |
---|---|---|
$ref * | The ID of the collection | integer |
$coldata * |
JSON encoded collection data. The data should be an array containing any of the allowed collection properties:
Example: {"keywords":"apitest1,apitest2","allow_changes":1,"users":"john.doe"} |
array |
Options marked ** apply to Featured collections only
Return values
Returns false if access control fails or invalid arguments have been received (e.g ref not a number), true otherwise.