Jama is accessible via a subset of the JSON-RPC 1.0 protocol over HTTP. You may use the reference client library implementation in Python.
Add access to the RPC API for the given user name with the given API key. A new user will be created if none is available with given user name.
Requires superuser.
Create a new collection based on 'title' and parent_id
Returns either the serialized new collection of null if parent does not exist.
Example output:
{
"id": 3,
"title": "paintings",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": null,
"project_id": 1,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
}
Will take a path such as '/photos/arts/paintings/' and build the corresponding hierarchy of collections. The hierarchy is returned as a list of serialized collections.
Beware: Because the collections are serialized before their children, all the children/descendants counts are set to 0.
Example output:
[
{
"id": 1,
"title": "photos",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": null,
"project_id": 1,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
{
"id": 2,
"title": "arts",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": 1,
"project_id": 1,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
{
"id": 3,
"title": "paintings",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": 2,
"project_id": 1,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
]
Add a meta value to a collection given their ids.
If recursive is True, the meta will be added to all descendants, collections and resources alike.
Add a meta value to a resource given their ids.
Use such a dict for selection:
{
"include": {
"resources_ids": [3493, 159]
"collections_ids:" [20, 31]
},
"exclude": {
"resources_ids": [12, 10, 15]
"collections_ids:" [4, 254, 17]
}
}
Add a new metadata to metadata set.
Set optional 'metadatatypeid'. Defaults to string type.
Create new metadata set from title.
Add a resource to a collection given ids.
Add tag to a collection based on tag uid and collection id.
Add tag to a resource based on tag uid and resource id.
Performs a complex search using terms such as 'contains', 'is', 'doesnotcontain'.
Multiple conditions can be added.
Example input:
[
{"property": "title", "term": "contains", "value": "cherbourg"},
{"meta": 123, "term": "is", "value": "35mm"},
{"exclude_meta": 145},
{"tags": ["PAINTINGS", "PHOTOS"]}
{"exclude_tags": ["DRAWINGS"]}
]
Example output:
{
"collections": [],
"resources": [
{
"id": 1,
"title": "Cherbourg by night",
"original_name": "cherbourg_by_night.jpg",
"type": "image/jpeg",
"hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e",
"metas": null,
"urls": [],
"tags": [],
}
]
}
Return terms conditions to be used in advanced search.
Example output:
[
"is",
"contains",
"does_not_contain"
]
Get ancestors from collection id as a list of serialized collections.
If 'include_self' is true, will add the current collection at the begining.
Example output:
[
{
"id": 1,
"title": "photos",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": null,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
{
"id": 2,
"title": "arts",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": 1,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
{
"id": 3,
"title": "paintings",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": 2,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
]
Get ancestors from resource id as a list of serialized collections.
Example output:
[
{
"id": 1,
"title": "photos",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": null,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
{
"id": 2,
"title": "arts",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": 1,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
{
"id": 3,
"title": "paintings",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": 2,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
},
]
Tries to determine skew angle of image with text.
Change the value of a meta for a collection.
Change the value of a meta for a resource
Get a particular collection given its id.
Example output:
{
"id": 2,
"title": "art works",
"resources_count": 23,
"children_count": 5,
"parent": 1,
"children": None,
"metas": [],
"public_access": False,
"tags": [],
}
Get infos from given collection:
Return the user's collections under the parent collection specified by 'parent_id'. If 'recursive' is true, will return all the descendants recursively in the 'children' key. If recursive is false, 'children' is null.
Special case:
If flatlist is True, collections are returned as a flat list and parentid is effectively IGNORED.
Example output:
[
{
"id": 2,
"title": "art works",
"resources_count": 23,
"children_count": 5,
"descendants_count": 12,
"descendants_resources_count": 58,
"parent": 1,
"children": None,
"metas": [],
"public_access": False,
"tags": [],
}
]
Create a new project.
Requires superuser.
Deactivate access to the RPC API for the given user name and API key. Only the access (API key) is removed, not the user.
Requires superuser.
Delete collection given its id.
Collection MUST be empty of any content (no children collections and no resources), unless the 'recursive'parameter is set to True, in which case ALL descendants will be deleted.
Delete metadata based on its id.
Delete metadata set based on its id. Optional recursive call.
Delete a property from the project.
property_key is NOT case sensitive, ie. "ProPertY" is the same as "pRoperTy" or "property".
Permanently (soft) delete a resource given its id.
Delete role within given project.
Requires superuser
Remove (delete) a tag based on its uid.
Beware: This will remove ALL associations with the tag.
Test current user for given permission.
Lists all available permissions in the application:
[
{'id': 1, 'label': 'collection.create'},
{'id': 2, 'label': 'collection.read'},
{'id': 3, 'label': 'collection.update'},
{'id': 4, 'label': 'collection.delete'},
{'id': 5, 'label': 'resource.create'},
{'id': 6, 'label': 'resource.read'},
{'id': 7, 'label': 'resource.update'},
{'id': 8, 'label': 'resource.delete'},
{'id': 9, 'label': 'metadata.create'},
{'id': 10, 'label': 'metadata.read'},
{'id': 11, 'label': 'metadata.update'},
{'id': 12, 'label': 'metadata.delete'},
{'id': 13, 'label': 'metadataset.create'},
{'id': 14, 'label': 'metadataset.read'},
{'id': 15, 'label': 'metadataset.update'},
{'id': 16, 'label': 'metadataset.delete'},
{'id': 17, 'label': 'file.create'},
{'id': 18, 'label': 'file.read'},
{'id': 19, 'label': 'file.update'},
{'id': 20, 'label': 'file.delete'},
{'id': 21, 'label': 'tag.create'},
{'id': 22, 'label': 'tag.read'},
{'id': 23, 'label': 'tag.update'},
{'id': 24, 'label': 'tag.delete'},
{'id': 25, 'label': 'file.download_source'}
]
Fetch all roles defined in the project, no matter the user.
Count metadata usage.
Get one particular metadata given its id.
Example output:
{
"id": 2,
"title": "ICC_Profile:GrayTRC",
"set_id": 1,
"set_title": "exif metas",
"rank": 1,
"project_id": 1,
}
Get all metadatas given a metadata set id.
Metadatas MAY be ordered with the rank attribute.
Example output:
[
{
"id": 1,
"title": "PNG:ProfileName",
"set_id": 1,
"set_title": "exif metas",
"rank": 0,
"project_id": 1,
},
{
"id": 2,
"title": "ICC_Profile:GrayTRC",
"set_id": 1,
"set_title": "exif metas",
"rank": 1,
"project_id": 1,
}
]
Get the list of all the project's metadata sets. For each metadatas set, the number of metadatas is given in metas_count.
Example output:
[
{"id": 1, "title": "exif metas", "project_id": 1, "metas_count": 23},
{"id": 2, "title": "dublin core", "project_id": 1, "metas_count": 17}
]
Get a list of available data types
Example output:
[
{"id": 1, "title": "text"},
{"id": 2, "title": "numeric"},
]
Move a collection from a parent to another.
Will raise ServiceException in the following cases:
Move items (collections or resources) from one Collection to another
Will mass move items (resources AND collections) based on parent collection and destination collection
Use such an object for inclusion/exclusion:
{
"include": {
"resources_ids": [3493, 159]
"collections_ids:" [20, 31]
},
"exclude": {
"resources_ids": [12, 10, 15]
"collections_ids:" [4, 254, 17]
}
}
Rotate and crop an image. The resulting image then replaces the original in the current resource.
Will return the resource upon success. Throws a ServiceException otherwise.
This is a test method to ensure the server-client communication works. Will return "pong [name authenticated of user]"
Example output:
pong john
Alias to advanced_search.
Get ALL properties from a project.
Get a property value from the project.
property_key is NOT case sensitive, ie. "ProPertY" is the same as "pRoperTy" or "property".
Will raise an exception if property does not exist.
Get infos from given project:
Get all rights for the current user.
Example output:
[
{
'project': {'id': 7, 'label': 'john doe main project'},
'role': {'id': 7, 'label': 'admin', 'permissions': [{"id": 1, "label": "do_anything"}]},
'user': 'john doe'
}
]
Get public collections
Mark a collection as public
Gets deleted elements:
Remove a meta value from a collection given their ids.
Remove a meta_value from a resource given their ids.
Use such a dict for selection:
{
"include": {
"resources_ids": [3493, 159]
"collections_ids:" [20, 31]
},
"exclude": {
"resources_ids": [12, 10, 15]
"collections_ids:" [4, 254, 17]
}
}
Remove a resource from a collection given ids.
Will mass remove items (resources AND collections) based on parent collection
Use such an object for inclusion/exclusion:
{
"include": {
"resources_ids": [3493, 159]
"collections_ids:" [20, 31]
},
"exclude": {
"resources_ids": [12, 10, 15]
"collections_ids:" [4, 254, 17]
}
}
deleteCollection (with recursion) and deleteResource are used under the hood.
The parent collection is left as-is.
Remove tag from a collection based on tag uid and collection id.
Remove tag from a resource based on tag uid and resource id.
Rename a collection (ie. change its title).
Rename a metadata (ie. change its title).
Rename a resource (ie. change its title).
Replace a file by another using two existing resources.
The two resources are expected to be of File type. Then the following operations are performed:
Such that all title/metas/tags/collections of the destination resource instance are untouched, excluding exif metas that are transfered from the source.
Get a resource given its id.
Example output (file resource):
{
"id": 1,
"title": "letter",
"original_name": "letter.txt",
"type": "text/plain",
"hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e",
"metas": null,
"urls": [],
"tags": [],
}
Get all resources from a collection.
If 'includemetas' is true, will return the resources metadatas. If 'includemetas' is false, 'metas' will be null.
Different resources types may have different object keys. The bare minimum is 'id', 'title' and 'tags'.
Example output (file resource):
[
{
"id": 1,
"title": "letter",
"original_name": "letter.txt",
"type": "text/plain",
"hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e",
"metas": null,
"urls": [],
"tags": [],
}
]
Restore a deleted collection from the recycle bin
Restore a deleted resource from the recycle bin
Sets all metas for a unique metadata set.
Metas is a list of metadata id => metadata value dictionaries.
All metas must share the same metadata set.
If recursive is True, the meta will be set to all direct children resources.
/!\ Not actually recursive: Descendants (sub-collections and sub-collections resources) are IGNORED.
async_mode is IGNORED
Sets all metas for a unique metadata set.
Metas is a list of metadata id => metadata value dictionaries.
All metas must share the same metadata set.
Set a property value to the project.
property_key is NOT case sensitive, ie. "ProPertY" is the same as "pRoperTy" or "property".
Choose a Resource that is the best representation of a collection. Typical use case: set a miniature for a collection.
The Resource does not have to be contained in the collection.
Resource id may be set set to None/Null.
Create or update a role on a project, with the given permissions.
Requires superuser.
Get or create a Tag by uid (unique identifier). 'label' is an optional human-readable name.
Example output:
{
"id": 1,
"uid": "PAINTINGS",
"label": "peintures",
"ark": null,
}
Performs a simple search on resources and collections, based on their titles.
Example output:
{
"collections": [
{
"id": 1,
"title": "photos",
"resources_count": 0,
"children_count": 0,
"descendants_count": 0,
"descendants_resources_count": 0,
"parent": null,
"children": null,
"metas": [],
"public_access": false,
"tags": [],
}
],
"resources": [
{
"id": 1,
"title": "letter",
"original_name": "letter.txt",
"type": "text/plain",
"hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e",
"metas": null,
"urls": [],
"tags": [],
}
]
}
Get a list of all supported file type, complete with their mimes.
Example output:
[
{
"mime": "image/jpeg",
"extensions": [".jpg", ".jpeg"],
"iiif_support": true,
}
]
Returns all tags available in the project.
Example output:
[
{
"id": 1,
"uid": "PAINTINGS",
"label": "peintures",
"ark": null,
},
{
"id": 2,
"uid": "PHOTOS",
"label": "photos",
"ark": null,
}
]
Mark a collection as private
Compound method to update resource and resources metadata from a xlsx file row.
Get information for an upload based on the file hash.
Example output:
{
"status": "not available",
"id": null,
"available_chunks":[]
}
"status" being one of "not available", "available" or "incomplete"
Returns list of user tasks. Each task being serialized like so:
{
"object_type": "task",
"id": user_task_instance.id,
"description": user_task_instance.description,
"created_at": user_task_instance.created_at.isoformat(),
"started_at": user_task_instance.started_at.isoformat(),
"finished_at": user_task_instance.finished_at.isoformat(),
"failed_at": user_task_instance.failed_at.isoformat(),
"project_id": user_task_instance.project_id
}
'key' metas on resources & collections with 'valueitem' as value will be removed. Exemple : valueitem = 'Bibliothéque Pierre Sineux', key = 'library'
Status should be one of: todo, wip, done.
Use such a dict for selection:
{
"include": {
"resources_ids": [3493, 159]
"collections_ids:" [20, 31]
},
"exclude": {
"resources_ids": [12, 10, 15]
"collections_ids:" [4, 254, 17]
}
}
Sets meta value given its key
Get the list of collections given a topic. Topic ('collection' in french scd language) is an scd metadata
Get the list of collections given a list of dc types
List Resource model facets for Meilisearch:
[
"project",
"metas.Dublin Core / title",
"metas.Dublin Core / contributor",
"metas.Dublin Core / publisher",
"metas.Dublin Core / date",
"metas.Dublin Core / format",
"metas.Dublin Core / description",
"metas.Dublin Core / subject",
"metas.Dublin Core / language",
"metas.Dublin Core / source",
"metas.scd / cote",
"metas.scd / library",
"metas.scd / period",
"tags"
]
Performs a query on the Meilisearch index.
query searches in resource title, and meta "metas.OCR / tesseract output" if available. Set to None or empty string if no plain-text search is required.
optparams_ is the optional parameters for Meilisearch. See Meilisearch documentation .
Example opt_params:
{
"facets": [
"title",
"metas.Dublin Core / date"
],
"filter": "'metas.Dublin Core / date='1999'",
"hitsPerPage": 50,
"page": 1,
"sort": [
"title:asc"
]
}