Atlas JSON-RPC service reference

Atlas is accessible via a subset of the JSON-RPC 1.0 protocol over HTTP.

add_user

Parameters
  • project_id (number)
  • user_name (string)
  • first_name (string defaults to null)
  • last_name (string defaults to null)
  • email (string defaults to null)
  • usable_password (boolean defaults to false)
Return type
boolean

Add a user to the system.

ing user must have ROLE_ADMIN

↑ back to available methods

all_study_translation_texts

Parameters
  • study_translation_id (number)
Return type
array[object]

Get all study translation text for the given study translation.

↑ back to available methods

all_study_translations

Parameters
  • study_id (number)
Return type
array[object]

Get all study version for the given study.

↑ back to available methods

apply_typographeur

Parameters
  • body (string)
Return type
string
No documentation available

↑ back to available methods

archive_study

Parameters
  • study_id (number)
Return type
object
No documentation available

↑ back to available methods

ask_proofreading

Parameters
  • study_translation_id (number)
Return type
boolean

Ask for proofreading. This is intended for author and editor.

↑ back to available methods

cancel_proofreading

Parameters
  • study_translation_id (number)
Return type
boolean

Cancel a demand for proofreading (reverts version status to draft). is intended for author and editor.

↑ back to available methods

concept

Parameters
  • ark (string)
Return type
object

Get a concept

↑ back to available methods

create_study

Parameters
  • title (string defaults to null)
  • language_iso639_1 (string defaults to null)
  • topic_id (number defaults to null)
  • project_id (number defaults to null)
  • authors (List[int] defaults to null)
Return type
object

Add a new study

↑ back to available methods

create_study_translation

Parameters
  • title (string defaults to null)
  • language_iso639_1 (string defaults to null)
  • study_id (number defaults to null)
  • translators (List[int] defaults to null)
Return type
object

Create a new study translation

↑ back to available methods

create_topic

Parameters
  • parent_topic_id (number defaults to null)
  • project_id (number defaults to null)
  • translations (object defaults to null)
  • rank (number defaults to 0)
  • jama_visual_resource_id (number defaults to null)
Return type
object

Create a new topic.

nslations" is a lang_code => title value dict:

": "titre du thème", "en": "topic title"}

↑ back to available methods

current_user

Parameters
no parameters
Return type
object

Get infos about current user

↑ back to available methods

delete_study

Parameters
  • study_id (number)
Return type
boolean

Remove a study (keep the associated Jama collection, this is a soft delete)

↑ back to available methods

delete_study_translation

Parameters
  • study_translation_id (number)
  • delete_associated_jama_collection (boolean defaults to false)
Return type
boolean

Remove a study translation and optionally the associated Jama collection.

↑ back to available methods

delete_topic

Parameters
  • topic_id (number)
Return type
boolean
No documentation available

↑ back to available methods

delete_user

Parameters
  • project_id (number)
  • user_id (number)
Return type
boolean
No documentation available

↑ back to available methods

jama_activate_rpc_access

Parameters
  • user_name (string)
  • api_key (string)
Return type
boolean

Add access to the RPC API for the given username with the given API key. w user will be created if none is available with given username.

ires superuser.

↑ back to available methods

jama_add_collection

Parameters
  • title (string)
  • parent_id (number)
Return type
object

Create a new collection based on 'title' and parent_id

rns either the serialized new collection of null if parent does exist.

ple output:

"id": 3, "title": "paintings", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": null, "projectid": 1, "children": null, "metas": [], "public_access": false, "tags": [],

↑ back to available methods

jama_add_collection_from_path

Parameters
  • path (string)
  • project_id (number)
Return type
array[object]

Will take a path such as '/photos/arts/paintings/' build the corresponding hierarchy of collections. The hierarchy eturned as a list of serialized collections.

re: Because the collections are serialized before their children, the children/descendants counts are set to 0.

ple output:

{ "id": 1, "title": "photos", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": null, "projectid": 1, "children": null, "metas": [], "publicaccess": false, "tags": [], }, { "id": 2, "title": "arts", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": 1, "projectid": 1, "children": null, "metas": [], "publicaccess": false, "tags": [], }, { "id": 3, "title": "paintings", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": 2, "projectid": 1, "children": null, "metas": [], "public_access": false, "tags": [], },

↑ back to available methods

jama_add_meta_to_collection

Parameters
  • collection_id (number)
  • meta_id (number)
  • meta_value (string)
  • recursive (boolean defaults to false)
Return type
number

Add a meta value to a collection given their ids.

ecursive is True, the meta will be added to all descendants, ections and resources alike.

↑ back to available methods

jama_add_meta_to_resource

Parameters
  • resource_id (number)
  • meta_id (number)
  • meta_value (string)
Return type
number

Add a meta value to a resource given their ids.

↑ back to available methods

jama_add_meta_to_selection

Parameters
  • from_collection_id (number)
  • selection (object)
  • meta_id (number)
  • meta_value (string)
Return type
boolean

Use such a dict for selection:

"include": { "resourcesids": [3493, 159] "collectionsids:" [20, 31] }, "exclude": { "resourcesids": [12, 10, 15] "collectionsids:" [4, 254, 17] }

↑ back to available methods

jama_add_metadata

Parameters
  • title (string)
  • metas_set_id (number)
Return type
number

Add a new metadata to metadata set.

↑ back to available methods

jama_add_metadataset

Parameters
  • title (string)
  • project_id (number)
Return type
number

Create new metadata set from title.

↑ back to available methods

jama_add_resource_to_collection

Parameters
  • resource_id (number)
  • collection_id (number)
Return type
boolean

Add a resource to a collection given ids.

↑ back to available methods

jama_add_tag_to_collection

Parameters
  • tag_uid (string)
  • collection_id (number)
Return type
boolean

Add tag to a collection based on tag uid and collection id.

↑ back to available methods

jama_add_tag_to_resource

Parameters
  • tag_uid (string)
  • resource_id (number)
Return type
boolean

Add tag to a resource based on tag uid and resource id.

↑ back to available methods

jama_advanced_search

Parameters
  • search_terms (array[object])
  • project_id (number)
  • include_metas (boolean defaults to false)
  • collection_id (number defaults to null)
  • limit_from (number defaults to 0)
  • limit_to (number defaults to 2000)
  • order_by (string defaults to 'title')
  • fetch_resources (boolean defaults to true)
  • fetch_collections (boolean defaults to true)
  • public_access (boolean defaults to null)
Return type
object

Performs a complex search using terms such as 'contains', 'is', 'doesnotcontain'.

iple conditions can be added.

ple input:

{"property": "title", "term": "contains", "value": "cherbourg"}, {"meta": 123, "term": "is", "value": "35mm"}, {"excludemeta": 145}, {"tags": ["PAINTINGS", "PHOTOS"]} {"excludetags": ["DRAWINGS"]}

ple output:

"collections": [], "resources": [ { "id": 1, "title": "Cherbourg by night", "originalname": "cherbourgby_night.jpg", "type": "image/jpeg", "hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e", "metas": null, "urls": [], "tags": [], } ]

↑ back to available methods

jama_advanced_search_terms

Parameters
no parameters
Return type
array[string]

Return terms conditions to be used in advanced search.

ple output:

"is", "contains", "doesnotcontain"

↑ back to available methods

jama_ancestors_from_collection

Parameters
  • collection_id (number)
  • include_self (boolean defaults to false)
Return type
array[object]

Get ancestors from collection id as a list of serialized collections.

include_self' is true, will add the current collection at the begining.

ple output:

{ "id": 1, "title": "photos", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": null, "children": null, "metas": [], "publicaccess": false, "tags": [], }, { "id": 2, "title": "arts", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": 1, "children": null, "metas": [], "publicaccess": false, "tags": [], }, { "id": 3, "title": "paintings", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": 2, "children": null, "metas": [], "publicaccess": false, "tags": [], },

↑ back to available methods

jama_ancestors_from_resource

Parameters
  • resource_id (number)
Return type
array[object]

Get ancestors from resource id as a list of serialized collections.

ple output:

{ "id": 1, "title": "photos", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": null, "children": null, "metas": [], "publicaccess": false, "tags": [], }, { "id": 2, "title": "arts", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": 1, "children": null, "metas": [], "publicaccess": false, "tags": [], }, { "id": 3, "title": "paintings", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": 2, "children": null, "metas": [], "publicaccess": false, "tags": [], },

↑ back to available methods

jama_auto_find_rotate_angle

Parameters
  • resource_id (number)
Return type
number

Tries to determine skew angle of image with text.

↑ back to available methods

jama_change_collection_meta_value

Parameters
  • meta_value_id (number)
  • meta_value (string)
Return type
boolean

Change the value of a meta for a collection.

↑ back to available methods

jama_change_resource_meta_value

Parameters
  • meta_value_id (number)
  • meta_value (string)
Return type
boolean

Change the value of a meta for a resource

↑ back to available methods

jama_collection

Parameters
  • collection_id (number)
Return type
object

Get a particular collection given its id.

ple output:

"id": 2, "title": "art works", "resourcescount": 23, "childrencount": 5, "parent": 1, "children": None, "metas": [], "public_access": False, "tags": [],

↑ back to available methods

jama_collection_stats

Parameters
  • collection_id (number)
Return type
object

Get infos from given collection:

mber of descendants mber of descendant resources mber of resources mber of children collections

↑ back to available methods

jama_collections

Parameters
  • parent_id (number)
  • recursive (boolean defaults to false)
  • limit_from (number defaults to 0)
  • limit_to (number defaults to 2000)
  • flat_list (boolean defaults to false)
  • only_published (boolean defaults to false)
  • order_by (string defaults to 'title')
  • only_deleted_items (boolean defaults to false)
Return type
array[object]

Return the user's collections under the parent collection ified by 'parent_id'. If 'recursive' is true, will rn all the descendants recursively in the 'children' key. ecursive is false, 'children' is null.

ial case:

latlist is True, collections are returned as a flat list and parentid is effectively IGNORED.

ple output:

{ "id": 2, "title": "art works", "resourcescount": 23, "childrencount": 5, "descendantscount": 12, "descendantsresourcescount": 58, "parent": 1, "children": None, "metas": [], "publicaccess": False, "tags": [], }

↑ back to available methods

jama_create_project

Parameters
  • project_label (string)
  • project_description (string defaults to null)
Return type
object

Create a new project.

ires superuser.

↑ back to available methods

jama_current_user

Parameters
no parameters
Return type
object

Returns current user.

↑ back to available methods

jama_deactivate_rpc_access

Parameters
  • user_name (string)
  • api_key (string)
Return type
boolean

Deactivate access to the RPC API for the given user name and API key. the access (API key) is removed, not the user.

ires superuser.

↑ back to available methods

jama_delete_collection

Parameters
  • collection_id (number)
  • recursive (boolean defaults to false)
Return type
object

Delete collection given its id.

ection MUST be empty of any content (no children collections and no resources), ss the 'recursive'parameter is set to True, in which case ALL descendants will be ted.

↑ back to available methods

jama_delete_metadata

Parameters
  • metadata_id (number)
Return type
boolean

Delete metadata based on its id.

↑ back to available methods

jama_delete_metadataset

Parameters
  • metadataset_id (number)
  • recursive (boolean defaults to false)
Return type
object

Delete metadata set based on its id. Optional recursive .

↑ back to available methods

jama_delete_project_property

Parameters
  • project_id (number)
  • property_key (string)
Return type
boolean

Delete a property from the project.

erty_key is NOT case sensitive, ie. "ProPertY" is the same as "pRoperTy" or "property".

↑ back to available methods

jama_delete_resource

Parameters
  • resource_id (number)
Return type
boolean

Permanently (soft) delete a resource given its id.

↑ back to available methods

jama_delete_role

Parameters
  • project_id (number)
  • role_label (string)
Return type
boolean

Delete role within given project.

ires superuser

↑ back to available methods

jama_delete_tag

Parameters
  • uid (string)
  • project_id (number)
Return type
boolean

Remove (delete) a tag based on its uid.

re: This will remove ALL associations with the tag.

↑ back to available methods

jama_has_permission

Parameters
  • project_id (number)
  • permission (string)
Return type
boolean

Test current user for given permission.

↑ back to available methods

jama_infos

Parameters
no parameters
Return type
object

Get infos for dependent Jama project.

rn:

oject_id": 1}

↑ back to available methods

jama_list_annotations

Parameters
  • resource_id (number)
Return type
array[object]

Get annotations for a resource.

↑ back to available methods

jama_list_permissions

Parameters
no parameters
Return type
array[object]

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'}

↑ back to available methods

jama_list_roles

Parameters
  • project_id (number)
Return type
array[object]

Fetch all roles defined in the project, no matter the user.

↑ back to available methods

jama_meta_count

Parameters
  • metadata_id (number)
  • collection_id (number)
Return type
object

Count metadata usage.

↑ back to available methods

jama_metadata

Parameters
  • metadata_id (number)
Return type
object

Get one particular metadata given its id.

ple output:

"id": 2, "title": "ICCProfile:GrayTRC", "setid": 1, "settitle": "exif metas", "rank": 1, "projectid": 1,

↑ back to available methods

jama_metadatas

Parameters
  • metadata_set_id (number)
Return type
array[object]

Get all metadatas given a metadata set id.

datas MAY be ordered with the rank attribute.

ple output:

{ "id": 1, "title": "PNG:ProfileName", "setid": 1, "settitle": "exif metas", "rank": 0, "projectid": 1, }, { "id": 2, "title": "ICCProfile:GrayTRC", "setid": 1, "settitle": "exif metas", "rank": 1, "project_id": 1, }

↑ back to available methods

jama_metadatasets

Parameters
  • project_id (number)
Return type
array[object]

Get the list of all the project's metadata sets. each metadatas set, the number of metadatas is given in metas_count.

ple output:

{"id": 1, "title": "exif metas", "projectid": 1, "metascount": 23}, {"id": 2, "title": "dublin core", "projectid": 1, "metascount": 17}

↑ back to available methods

jama_metadatatypes

Parameters
no parameters
Return type
array[object]

Get a list of available data types

ple output:

{"id": 1, "title": "text"}, {"id": 2, "title": "numeric"},

↑ back to available methods

jama_move_collection

Parameters
  • child_collection_id (number)
  • parent_collection_id (number)
Return type
boolean

Move a collection from a parent to another.

raise ServiceException in the following cases:

hildcollectionid' and 'parentcollectionid' are equal rent collection does not exist rent collection is a descendant of child collection

↑ back to available methods

jama_move_items

Parameters
  • from_collection_id (number)
  • to_collection_id (number)
  • collections_ids (List[int])
  • resources_ids (List[int])
Return type
Dict[str, Dict]

Move items (collections or resources) from one Collection to another

↑ back to available methods

jama_move_selection

Parameters
  • from_collection_id (number)
  • selection (object)
  • to_collection_id (number)
Return type
Dict[str, Dict]

Will mass move items (resources AND collections) based on parent collection and destination collection

such an object for inclusion/exclusion:

"include": { "resourcesids": [3493, 159] "collectionsids:" [20, 31] }, "exclude": { "resourcesids": [12, 10, 15] "collectionsids:" [4, 254, 17] }

↑ back to available methods

jama_picture_rotate_crop

Parameters
  • resource_id (number)
  • rotation (number defaults to 0)
  • top_crop (number defaults to 0)
  • right_crop (number defaults to 0)
  • bottom_crop (number defaults to 0)
  • left_crop (number defaults to 0)
Return type
object

Rotate and crop an image. The resulting image then replaces the inal in the current resource.

return the resource upon success. Throws a ServiceException rwise.

↑ back to available methods

jama_ping

Parameters
no parameters
Return type
string

This is a test method to ensure the server-clients communication works. return "pong [name authenticated of user]"

ple output:

john

↑ back to available methods

jama_project_items

Parameters
  • search_terms (array[object])
  • project_id (number)
  • include_metas (boolean defaults to false)
  • collection_id (number defaults to null)
  • limit_from (number defaults to 0)
  • limit_to (number defaults to 2000)
  • order_by (string defaults to 'title')
  • public_access (boolean defaults to null)
Return type
object

Alias to advanced_search.

↑ back to available methods

jama_project_properties

Parameters
  • project_id (number)
Return type
array[object]

Get ALL properties from a project.

↑ back to available methods

jama_project_property

Parameters
  • project_id (number)
  • property_key (string)
Return type
object

Get a property value from the project.

erty_key is NOT case sensitive, ie. "ProPertY" is the same as "pRoperTy" or "property".

raise an exception if property does not exist.

↑ back to available methods

jama_project_stats

Parameters
  • project_id (number)
Return type
object

Get infos from given project:

of project collection root mber of descendants mber of descendant resources mber of resources mber of children collections

↑ back to available methods

jama_projects_user_permissions

Parameters
  • advanced_permissions (boolean defaults to false)
Return type
array[object]

Get all rights for the current user.

ple output:

{ 'project': {'id': 7, 'label': 'john doe main project'}, 'role': {'id': 7, 'label': 'admin', 'permissions': [{"id": 1, "label": "do_anything"}]}, 'user': 'john doe' }

↑ back to available methods

jama_public_collections

Parameters
  • project_id (number)
Return type
array[object]

Get public collections

↑ back to available methods

jama_publish_collection

Parameters
  • collection_id (number)
Return type
boolean

Mark a collection as public

↑ back to available methods

jama_recycle_bin

Parameters
  • project_id (number)
Return type
array[object]

Gets deleted elements:

ject type bel

leted_at

↑ back to available methods

jama_remove_meta_value_from_collection

Parameters
  • collection_id (number)
  • meta_value_id (number)
  • recursive (boolean defaults to false)
Return type
boolean

Remove a meta value from a collection given their ids.

↑ back to available methods

jama_remove_meta_value_from_resource

Parameters
  • resource_id (number)
  • meta_value_id (number)
Return type
boolean

Remove a meta_value from a resource given their ids.

↑ back to available methods

jama_remove_meta_value_from_selection

Parameters
  • from_collection_id (number)
  • selection (object)
  • meta_value_id (number)
Return type
boolean

Use such a dict for selection:

"include": { "resourcesids": [3493, 159] "collectionsids:" [20, 31] }, "exclude": { "resourcesids": [12, 10, 15] "collectionsids:" [4, 254, 17] }

↑ back to available methods

jama_remove_resource_from_collection

Parameters
  • resource_id (number)
  • collection_id (number)
Return type
boolean

Remove a resource from a collection given ids.

↑ back to available methods

jama_remove_selection

Parameters
  • parent_collection_id (number)
  • selection (object)
Return type
boolean

Will mass remove items (resources AND collections) based on parent collection

such an object for inclusion/exclusion:

"include": { "resourcesids": [3493, 159] "collectionsids:" [20, 31] }, "exclude": { "resourcesids": [12, 10, 15] "collectionsids:" [4, 254, 17] }

teCollection (with recursion) and deleteResource are used under the hood.

parent collection is left as-is.

↑ back to available methods

jama_remove_tag_from_collection

Parameters
  • tag_uid (string)
  • collection_id (number)
Return type
boolean

Remove tag from a collection based on tag uid and collection id.

↑ back to available methods

jama_remove_tag_from_resource

Parameters
  • tag_uid (string)
  • resource_id (number)
Return type
boolean

Remove tag from a resource based on tag uid and resource id.

↑ back to available methods

jama_rename_collection

Parameters
  • collection_id (number)
  • title (string)
Return type
boolean

Rename a collection (ie. change its title).

↑ back to available methods

jama_rename_meta

Parameters
  • meta_id (number)
  • title (string)
Return type
boolean

Rename a metadata (ie. change its title).

↑ back to available methods

jama_rename_resource

Parameters
  • resource_id (number)
  • title (string)
Return type
boolean

Rename a resource (ie. change its title).

↑ back to available methods

jama_replace_file

Parameters
  • from_resource_id (number)
  • to_resource_id (number)
Return type
boolean

Replace a file by another using two existing resources.

two resources are expected to be of File type. Then the owing operations are performed:

tas from the "ExifTool" set are removed from the destination resource instance tas from the "ExifTool" set are transfered from the source resource instance to the destination resource instance e destination resource instance gets the file hash from the source resource instance e source resource instance is (hard) deleted e destination resource instance is saved

that all title/metas/tags/collections of the destination resource instance are untouched, uding exif metas that are transfered from the source.

↑ back to available methods

jama_resource

Parameters
  • resource_id (number)
  • include_metas (boolean defaults to true)
Return type
object

Get a resource given its id.

ple output (file resource):

"id": 1, "title": "letter", "original_name": "letter.txt", "type": "text/plain", "hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e", "metas": null, "urls": [], "tags": [],

↑ back to available methods

jama_resources

Parameters
  • collection_id (number)
  • include_metas (boolean defaults to false)
  • limit_from (number defaults to 0)
  • limit_to (number defaults to 2000)
  • order_by (string defaults to 'title')
  • only_deleted_items (boolean defaults to false)
  • only_tags (array[string] defaults to null)
Return type
array[object]

Get all resources from a collection.

includemetas' is true, will return the resources metadatas. includemetas' is false, 'metas' will be null.

erent resources types may have different object keys. The bare mum is 'id', 'title' and 'tags'.

ple output (file resource):

{ "id": 1, "title": "letter", "original_name": "letter.txt", "type": "text/plain", "hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e", "metas": null, "urls": [], "tags": [], }

↑ back to available methods

jama_restore_collection

Parameters
  • collection_id (number)
  • destination_collection_id (number)
Return type
boolean

Restore a deleted collection from the recycle bin

↑ back to available methods

jama_restore_resource

Parameters
  • resource_id (number)
  • destination_collection_id (number)
Return type
boolean

Restore a deleted resource from the recycle bin

↑ back to available methods

jama_set_is_oai_record

Parameters
  • collection_id (number)
  • is_oai_record (boolean defaults to true)
Return type
boolean

Set/unset the collection as a OAI-PMH record. The creation date be used in OAI-PMH requests.

↑ back to available methods

jama_set_metas_to_collection

Parameters
  • collection_id (number)
  • metas (array[object])
  • recursive (boolean defaults to false)
  • async_mode (boolean defaults to true)
Return type
boolean

Sets all metas for a unique metadata set.

s is a list of metadata id => metadata value dictionaries.

metas must share the same metadata set.

ecursive is True, the meta will be added to all descendants, ections and resources alike.

↑ back to available methods

jama_set_metas_to_resource

Parameters
  • resource_id (number)
  • metas (array[object])
Return type
boolean

Sets all metas for a unique metadata set.

s is a list of metadata id => metadata value dictionaries.

metas must share the same metadata set.

↑ back to available methods

jama_set_project_property

Parameters
  • project_id (number)
  • property_key (string)
  • property_value (object)
Return type
object

Set a property value to the project.

erty_key is NOT case sensitive, ie. "ProPertY" is the same as "pRoperTy" or "property".

↑ back to available methods

jama_set_representative_resource

Parameters
  • collection_id (number)
  • resource_id (number defaults to null)
Return type
boolean

Choose a Resource that is the best representation of a collection. cal use case: set a miniature for a collection.

Resource does not have to be contained in the collection.

urce id may be set set to None/Null.

↑ back to available methods

jama_set_role

Parameters
  • project_id (number)
  • role_label (string)
  • permissions (array[object])
Return type
object

Create or update a role on a project, with the given permissions.

ires superuser.

↑ back to available methods

jama_set_tag

Parameters
  • uid (string)
  • project_id (number)
  • label (string defaults to null)
  • ark (string defaults to null)
Return type
object

Get or create a Tag by uid (unique identifier). 'label' is an optional human-readable name.

ple output:

"id": 1, "uid": "PAINTINGS", "label": "peintures", "ark": null,

↑ back to available methods

jama_simple_search

Parameters
  • query (string)
  • project_id (number)
  • limit_from (number defaults to 0)
  • limit_to (number defaults to 2000)
  • order_by (string defaults to 'title')
Return type
object

Performs a simple search on resources and collections, based on their titles.

ple output:

"collections": [ { "id": 1, "title": "photos", "resourcescount": 0, "childrencount": 0, "descendantscount": 0, "descendantsresourcescount": 0, "parent": null, "children": null, "metas": [], "publicaccess": false, "tags": [], } ], "resources": [ { "id": 1, "title": "letter", "original_name": "letter.txt", "type": "text/plain", "hash": "0dd93a59aeaccfb6d35b1ff5a49bde1196aa90dfef02892f9aa2ef4087d8738e", "metas": null, "urls": [], "tags": [], } ]

↑ back to available methods

jama_supported_file_types

Parameters
no parameters
Return type
array[object]

Get a list of all supported file type, complete with their mimes.

ple output:

{ "mime": "image/jpeg", "extensions": [".jpg", ".jpeg"], "iiif_support": true, }

↑ back to available methods

jama_tags

Parameters
  • project_id (number)
Return type
array[object]

Returns all tags available in the project.

ple output:

{ "id": 1, "uid": "PAINTINGS", "label": "peintures", "ark": null, }, { "id": 2, "uid": "PHOTOS", "label": "photos", "ark": null, }

↑ back to available methods

jama_unpublish_collection

Parameters
  • collection_id (number)
Return type
boolean

Mark a collection as private

↑ back to available methods

jama_upload_infos

Parameters
  • sha256_hash (string)
  • project_id (number)
Return type
object

Get information for an upload based on the file hash.

ple output:

"status": "not available", "id": null, "available_chunks":[]

tus" being one of "not available", "available" or "incomplete"

↑ back to available methods

jama_user_tasks_status

Parameters
  • project_id (number defaults to null)
Return type
array[object]

Returns list of user tasks.

↑ back to available methods

languages

Parameters
no parameters
Return type
array[object]

Get all available languages.

rn:

", "en", "es"]

↑ back to available methods

list_studies

Parameters
  • role_label (string)
  • project_id (number)
  • digest (boolean defaults to true)
  • from_item (number defaults to 0)
  • to_item (number defaults to 20)
  • search (string defaults to null)
  • sort_by (array[object] defaults to null)
  • filtered_by (object defaults to null)
  • start_date (string defaults to null)
  • end_date (string defaults to null)
  • date_filter_type (string defaults to null)
Return type
dict[str, list[dict]]

List all studies according to current user role

↑ back to available methods

list_topics

Parameters
  • project_id (number)
  • recursive (boolean defaults to true)
Return type
array[object]
No documentation available

↑ back to available methods

management_events

Parameters
  • from_item (number defaults to 0)
  • to_item (number defaults to 10)
  • project_id (number defaults to null)
Return type
dict[str, list[dict] | typing.Any]
No documentation available

↑ back to available methods

move_topic

Parameters
  • topic_id (number)
  • to_parent_id (number)
  • rank (number defaults to null)
Return type
boolean
No documentation available

↑ back to available methods

order_topics

Parameters
  • topics (array[object])
Return type
boolean
No documentation available

↑ back to available methods

permissions

Parameters
no parameters
Return type
array[string]
No documentation available

↑ back to available methods

project_roles

Parameters
  • project_id (number)
Return type
array[object]

List all roles available in a project

↑ back to available methods

projects

Parameters
no parameters
Return type
array[object]

List all projects for current user

↑ back to available methods

publish_atlas

Parameters
  • project_id (number)
Return type
object

extract and copy Atlas pages to the production server

↑ back to available methods

restore_archived_study

Parameters
  • study_id (number)
Return type
object
No documentation available

↑ back to available methods

restore_study

Parameters
  • study_id (number)
Return type
boolean

Restore a study

↑ back to available methods

search_concepts

Parameters
  • query (string)
  • project_id (number)
  • lang (string)
  • limit_from (number defaults to 0)
  • limit_to (number defaults to 2000)
Return type
List

Search concepts

↑ back to available methods

set_roles

Parameters
  • project_id (number)
  • user_id (number)
  • roles_ids (List[int])
Return type
boolean

Only admin role is allowed to call set_roles.

↑ back to available methods

set_topic_rank

Parameters
  • topic_id (number)
  • rank (number)
Return type
boolean
No documentation available

↑ back to available methods

set_topic_visual

Parameters
  • topic_id (number)
  • jama_visual_resource_id (number)
Return type
boolean
No documentation available

↑ back to available methods

set_translation_status

Parameters
  • study_translation_id (number)
  • status_id (number)
  • role_id (number)
Return type
boolean
No documentation available

↑ back to available methods

study

Parameters
  • study_id (number)
Return type
object

Get a study

↑ back to available methods

study_translation

Parameters
  • study_translation_id (number)
Return type
object

Get a study version

↑ back to available methods

study_translation_text

Parameters
  • study_translation_text_id (number)
Return type
object

" a study translation text

↑ back to available methods

toggle_active_ser

Parameters
  • project_id (number)
  • user_id (number)
Return type
boolean
No documentation available

↑ back to available methods

toggle_active_user

Parameters
  • project_id (number)
  • user_id (number)
Return type
boolean

Only admin role is allowed to call toggleactiveuser.

↑ back to available methods

topic

Parameters
  • topic_id (number)
  • recursive (boolean defaults to false)
Return type
object
No documentation available

↑ back to available methods

translations_statuses

Parameters
no parameters
Return type
array[object]

Get all possible study statuses.

↑ back to available methods

update_concepts

Parameters
  • project_id (number)
Return type
object

Fetch concepts from thesaurus.

↑ back to available methods

update_study_metas

Parameters
  • study_id (number)
  • topic_id (number)
  • authors_ids (List[int])
  • concepts (array[string])
Return type
object
No documentation available

↑ back to available methods

update_study_translation

Parameters
  • title (string defaults to null)
  • text (string defaults to null)
  • sub_title (string defaults to null)
  • study_translation_id (number defaults to null)
  • translators (List[int] defaults to null)
  • project_id (number defaults to null)
Return type
object

Update a new study translation.

↑ back to available methods

update_study_translation_metas

Parameters
  • study_translation_id (number defaults to null)
  • title (string defaults to null)
  • sub_title (string defaults to null)
  • translators (List[int] defaults to null)
Return type
object

Update study translations metadata.

↑ back to available methods

update_topic

Parameters
  • topic_id (number)
  • translations (object defaults to null)
  • rank (number defaults to null)
  • jama_visual_resource_id (number defaults to null)
Return type
object
No documentation available

↑ back to available methods

update_user

Parameters
  • project_id (number)
  • user_id (number)
  • email (string)
  • first_name (string)
  • last_name (string)
  • usable_password (boolean defaults to false)
Return type
boolean
No documentation available

↑ back to available methods

user_roles

Parameters
  • user_id (number)
  • project_id (number)
Return type
array[object]

Get user's roles for the given project

↑ back to available methods

users

Parameters
  • from_item (number defaults to 0)
  • to_item (number defaults to 10)
  • search (string defaults to null)
  • sort_by (array[object] defaults to null)
  • has_role (boolean defaults to true)
  • project_id (number defaults to null)
Return type
dict[str, list[dict] | typing.Any]

Get all users, or project's users if project_id is defined

↑ back to available methods