Documentation : Module scenaripy_api⚓
Complément - create_or_update_group⚓
Crée ou met un groupe à jour.
# Création d'un groupe d'auteurs et ajout de ce groupe à 2 groupes existantsscenaripy_api.create_or_update_group(server, account="mon-groupe-auteurs", group_name="Mon Groupe d'auteurs", email="email@domain.org", groups=["site-Paris", "site-Montpellier"], roles=["main:author"])
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséaccount<str>: le compte du groupegroup_name<Optional[str]>: le nom du groupe (facultatif)email<Optional[str]>: l'email du groupe (facultatif)groups<Optional[list[str]]>: les groupes auxquels appartiennent ce groupe (facultatif)roles<Optional[list[str]]>: les roles attribués au groupe (facultatif)portlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Le groupe sous forme d'un Dict.
Complément - create_or_update_user⚓
Crée ou met un utilisateur à jour.
# Creation d'un userscenaripy_api.create_or_update_user(portal, account="mon-compte-user", first_name="Prénom", last_name="Nom", roles=["main:reader"], other_props={"password" : "Mon-Password"})
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséaccount<str>: le compte de l'utilisateurnick_names<Optional[list[str]]>: les surnoms (pseudos) de l'utilisateur (facultatif)first_name<Optional[str]>: le prénom de l'utilisateur (facultatif)last_name<Optional[str]>: le nom de famille de l'utilisateur (facultatif)email<Optional[str]>: l'email de l'utilisateur (facultatif)groups<Optional[list[str]]>: les groupes de l'utilisateur (facultatif)roles<Optional[list[str]]>: les rôles attribués à l'utilisateur (facultatif)auth_method<Optional[str]>: la méthode d'authentification de l'utilisateur (facultatif)other_props<Optional[dict[str, any]]>: dict contenant d'autres propriétés (facultatif). Ce paramètre n'est pas normalisé. Son contenu dépend de la configuration du système de gestion des utilisateurs (stockage en base de données ou système de fichier, méthode d'authentification locale ou centralisée via LDAP ou autre...). Dans le cas général d'une authentification locale, le mot de passe se définit dans ce champother_propsavec la clépassword.portlet_code<str>: Le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : l'utilisateur sous forme d'un Dict.
Complément - create_or_update_wsp⚓
Crée ou met un atelier à jour.
Exemple d'appels :
# Création ou mise à jour d'un atelier avec la dernière version d'Opale installée sur le serveur et l'extension Tutoriel (ex-Émeraude).create_or_update_wsp(portal, wsp_type_key="Opale", wsp_type_options=[{"wsp_type_key":"OpaleExtEmeraude"}], title="Mon atelier Opale", alias="opale")
# Création ou mise à jour d'un atelier avec la dernière version d'Opale 5 installée sur le serveur sans extension.create_or_update_wsp(portal, wsp_type_key="Opale", wsp_type_version="5", title="Mon atelier Opale", alias="opale")
# Création d'un atelier brouillon.create_or_update_wsp(portal, wsp_type_key="Opale", alias="testDrf", wsp_drf_ref="opale", drf_title="Mon atelier brouillon")
# Création d'un atelier dérivé.create_or_update_wsp(portal, wsp_type_key="Opale", alias="testDrv", wsp_drv_master="opale", drv_axis="fc")
# Création d'un second atelier dérivé dont le chemin de dérivation passe par le premier avant d'aller sur le master.create_or_update_wsp(portal, wsp_type_key="Opale", alias="testDrv2", wsp_drv_master="opale", drv_axis="alternance", drv_axis_path=["fc"])
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet ScPortal représentant le serveur Scenari viséwsp_type_key<str>: la clé du modèle documentaire visé. Par exemple "Opale".wsp_type_version<Optional[str]>: la version cible du modèle documentaire. La dernière version est prise si ce paramètre est absent. Ce paramètre accepte au choix une version majeure ("5"), majeur et medium ("5.0") ou complète ("5.0.5"). Si la version n'est pas complète, la dernière version correspondante (la dernière 5 ou la dernière 5.0) sera utilisée.wsp_type_lang<Optional[str]>: la langue du modèle documentaire (par exemple "fr-FR" ou "en-US"). Si non précisé, le premier modèle correspondant aux autres critères est sélectionné.wsp_type_options<Optional[list[any]]>: les extensions à utiliser. Ce paramètre attend un tableau de dict {wsp_type_key:str, wsp_type_version:Option[str], wsp_type_lang:Option[str]}title<Optional[str]>: le titre de l'atelier. Ce paramètre ne peut pas être utilisé lors de la création d'un atelier brouillon ou dérivé.alias<Optional[str]>: l'alias de cet atelier. L'alias se substitue au code de l'atelier. Il est unique et stable sur un même serveur. Fonction supportée uniquement en DB.desc<Optional[str]>: la description de l'ateliercode<Optional[str]>: le code de cet atelier (FS uniquement). Le code est unique et stable sur un même serveur.folder_content<Optional[str]>: le chemin vers le dossier de l'atelier. Paramètre supporté uniquement pour la création d'un atelier sur un serveur FS.folder_gen<Optional[str]>: le chemin vers le répertoire des générations de cet atelier. Paramètre supporté uniquement pour la création d'un atelier sur un serveur FS.skins<Optional[list[str]]>: les skins à utiliser avec cet atelier. Fonction supportée uniquement en DB.public<Optional[bool]>: statut public de l'atelier. (pour être pointé par des items externes depuis d'autres ateliers). La fonction doit être permise dans la configuration du serveur. Fonction supportée uniquement en DB.support_air_item<Optional[bool]>: activer la fonction desairitems. La fonction doit être permise dans la configuration du serveur. Fonction supportée uniquement en DB.support_ext_item<Optional[bool]>: activer la fonction des items externes. La fonction doit être permise dans la configuration du serveur. Fonction supportée uniquement en DB.wsp_drf_ref<Optional[str]>: ce paramètre permet de préciser que l'atelier créé est un atelier brouillon. Il doit contenir le wspCd ou l'alias vers l'atelier de référence. La fonction doit être permise dans la configuration du serveur. Fonction supportée uniquement en DB.drf_title<Optional[str]>: le titre de l'atelier brouillon.wsp_drv_master<Optional[str]>: ce paramètre permet de préciser que l'atelier créé est un atelier dérivé. Il doit contenir le wspCd ou l'alias vers l'atelier maître. La fonction doit être permise dans la configuration du serveur. Fonction supportée uniquement en DB.drv_axis<Optional[str]>: l'axe de dérivation d'un atelier dérivé.drv_axis_path<Optional[list[str]]>: ce paramètre permet de définir le chemin de dérivation dans le cas où plusieurs ateliers sont dérivés d'un même atelier maître.scwsp<Optional[bytes]>: ce paramètre, valide uniquement pour une création d'atelier, permet d'importer un scwsp lors de la création de l'atelier (passé sous forme debytes). Si ce paramètre est défini, les paramètres de wsp_type ne sont pas nécessaires. Si ce paramètre est défini, le paramètre local_file_path est ignoré.local_file_path<Optional[str]>: ce paramètre, valide uniquement pour une création d'atelier, permet d'importer un scwsp lors de la création de l'atelier (le paramètre contient le chemin vers le fichier scwsp). Si ce paramètre est défini, les paramètres de wsp_type ne sont pas nécessaires.portlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer).
Retour : le code de l'atelier créé.
Complément - list_users_or_groups⚓
Retourne la liste des utilisateurs et/ou groupes.
# Liste des utilisateurs en excluant les groupesscenaripy_api.list_users_or_groups(server, include_users=True, include_groups=False)
# Liste des groupes en excluant les utilisateursscenaripy_api.list_users_or_groups(server, include_users=True, include_groups=False)
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséinclude_users<bool>: si true, les accounts de type "user" seront inclus dans la liste retournéeinclude_groups<bool>: si true, les accounts de type "group" seront inclus dans la liste retournéeportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : La liste des utilisateurs ou groupes. Chaque objet est un dict contenant les propriétés retournées par le serveur.
Complément - search_wsp_code⚓
Recherche le code d'un atelier (wspCode) par titre, alias, type d'atelier, modèle documentaire...
Exemples d'appels
# Cherche un code d'atelier par son titre exactwsp_code = scenaripy_api.search_wsp_code(server, title="Mon titre d'atelier de documentation complet")
# Cherche un code d'atelier en cherchant un fragment de texte dans son Titre.wsp_code = scenaripy_api.search_wsp_code(server, title_fragment="documentation")
# Cherche uniquement parmi les ateliers draftwsp_code = scenaripy_api.search_wsp_code(server, title_fragment="documentation", is_drf=True)
# Cherche un atelier utilisant du modèle Dokiel en français ayant pour fragment de titre documentation et étant un atelier publicwsp_code = scenaripy_api.search_wsp_code(server, title_fragment="documentation", wsp_key="dokiel", wsp_lang="fr-FR", is_public=True)
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet ScPortal représentant le serveur Scenari visétitle<Optional[str]>: recherche exacte par le titre de cet ateliertitle_fragment<Optional[str]>: recherche un wsp dont le titre contient title_fragmentalias<Optional[str]>: recherche par l'alias de l'atelieris_drf<Optional[bool]>: recherche un atelier calque de travaildrf_Ref_wsp<Optional[str]>: recherche un atelier calque de travail par le code de l'atelier de référenceis_drv<Optional[bool]>: recherche un atelier dérivédrv_axis<Optional[str]>: recherche un atelier dérivé par le code de dérivationdrv_master<Optional[str]>: recherche un atelier dérivé par le code de l'atelier maîtreis_public<Optional[bool]>: recherche un atelier publiquewsp_key<Optional[str]>: recherche un atelier par la clé du modèle documentaire (par exemple 'Opale')wsp_uri<Optional[str]>: recherche un atelier l'URI du modèle documentaire (par exemple 'Opale_fr-FR_5-0-3')wsp_version<Optional[str]>: recherche un atelier par la version du modèle documentaire (par exemple '5.0.3')wsp_lang<Optional[str]>: recherche un atelier par langue du modèle documentaire (par exemple 'fr-FR')portlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : le code du wsp trouvé. None si aucun wsp trouvé.
Complément - set_granted_roles⚓
Définit les rôles associés à un utilisateur au niveau du portal, d'un atelier, d'un espace de l'atelier ou d'un dossier du dépôt.
Si on_wsp_code et on_urltree_path sont à None, les rôles sont modifiés au niveau du portal.
Si on_wsp_code est défini et on_wsp_path est à None, les rôles sont modifiés au niveau de l'atelier.
Si on_wsp_code et on_wsp_path sont définis, les rôles sont modifiés au niveau de l'espace de l'atelier.
Si on_urltree_path est défini, les rôles sont modifiés au niveau du dossier du dépôt.
# Association d'un role sur un atelierscenaripy_api.set_granted_roles(server, account="user1", granted_roles=["main:author"], on_wsp_code=wsp_code)
# Association d'un role sur l'espace "/user1" d'un atelierscenaripy_api.set_granted_roles(server, account="user1", granted_roles=["main:author"], on_wsp_code=wsp_code, on_wsp_path="/user1")
# Association d'un role sur un dossier "/user1" du depotscenaripy_api.set_granted_roles(server, account="user1", granted_roles=["main:author"], on_urltree_path="/user1")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséaccount<str>: le comptegranted_roles<list[str]>: la liste des rôles associés à ce compteon_wsp_code<str>: le code de l'atelier sur lequel définir les rôleson_wsp_path<str>: l'espace de l'atelier sur lequel définir les rôleson_urltree_path<str>: le path de l'URLtree sur lequel définir les rôles dans le dépôtauth_portlet_code: le code du portlet qui porte l'authentification (chain par défaut)chain_portlet_code<str>: le code du portlet chain sur lequel définir les rôles d'un atelier ou espace (chain par défaut)depot_portlet_code<str>: le code du portlet dépôt sur lequel définir les rôles d'un dossier de l'urlTree (depot par défaut)
Complément - write_depot_request⚓
Envoi d'une requête en écriture sur le dépôt.
# Import d'une ressource dans le depot depuis un fichier sur disquescenaripy_api.write_depot_request(server, metas={"path": "path/du/depot/res", "processing": "archive", "title": "Mon site"}, content="./monSite.zip")
# Import d'une ressource dans le depot avec passage de la ressource en variablescenaripy_api.write_depot_request(server, metas={"path": "path/du/depot/res", "processing": "file", "title": "Mon titre"}, content=flux_binaire)
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari visémetas<dict[str, str]>: les métadonnées de la requête (ne pas indiquer les métadonnées "system" scContent ou createMetascontent<bytes | str>: si la requête inclut un contenu binaire, le contenu binaire ou le chemin vers le fichiersync<bool>: indiquer False pour basculer sur un envoi asynchrone. Une requête est envoyée à intervalle régulier jusqu'à fin du traitement.portlet_code<str>: le code du portlet sur lequel faire la recherche ("depot" par défaut, spécifier ce paramètre pour le changer)
Complément - wsp_export_scar⚓
Export un scar depuis un ref_uri (espace ou item).
# Téléchargement d'un scar incluant tout le réseau déscendant de l'item et respectant les espaces de l'atelier. Stockage du scar obtenu dans une variable pythonflux_binaire = scenaripy_api.wsp_export_scar(server, wsp_code, ref_uri="/path/vers/mon/item.xml", include_items_graph=True, keep_spaces=True)
# Téléchargement de deux items dans un scar sans conserver les espaces de l'atelier et sans inclure le réseau descendant. Stockage du résultat sur disquescenaripy_api.wsp_export_scar(server, wsp_code, ref_uri=["/path/vers/mon/item1.xml", "/path/vers/mon/item2.xml"], include_items_graph=False, keep_spaces=True, local_file_path="./mon-export.scar")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelierref_uri<str | list[str]>: le chemin vers l'item ou l'espace (ou son ID) racine de l'export (un tableau de chemins peut être passé dans ce paramètre)include_items_graph<bool>: inclure le réseau descendant complet de cet itemkeep_spaces<bool>: préserver les espaces de l'atelierlocal_file_path<Optional[str]>: si spécifié, l'item est téléchargé sur disque vers ce cheminportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Aucun retour si local_file_path est spécifié. Le scar sous forme de bytes sinon.
Complément - wsp_export_scwsp⚓
Export un scwsp d'un atelier.
# Téléchargement du scwsp dans une variable pythonflux_binaire = scenaripy_api.wsp_export_scwsp(server, wsp_code)
# Enregistrement du scwsp sur disquescenaripy_api.wsp_export_scwsp(server, wsp_code, local_file_path="./mon-atelier.scwsp")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelierlocal_file_path<Optional[str]>: si spécifié, l'item est téléchargé sur disque vers ce cheminportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Aucun retour si local_file_path est spécifié. Le scwsp sous forme de bytes sinon.
Complément - wsp_generate⚓
Lance puis télécharge une génération.
# Pour télécharger la génération dans une variable pythonflux_binaire = scenaripy_api.wsp_generate(server, wsp_code, ref_uri="/path/mon/item/de/publication.xml", code_gen_stack="web", props={"skin": "default"})
# Enregistrer le résultat de génération sur disque en utilisant un skin produit par SCENARIstyler (le code du skin doit alors être préfixé par le caractère ~).scenaripy_api.wsp_generate(server, wsp_code, ref_uri="/path/mon/item/de/publication.xml", code_gen_stack="web", props={"skin": "~DokielTitania25"}, local_file_path="./mon-gen.zip")
# Envoyer le résultat de génération depuis le serveur# Définition d'un objet SendProps pour réaliser l'envoi par le serveursend_by_server_props = {
"method": "PUT",
"url": "https://mon-domaein.org/API/set/backup",
"headerProps": {"Authorization:": "Bearer xxxx"}
"addQSParams": {"token":"xxx"}
}
scenaripy_api.wsp_generate(server, wsp_code, ref_uri="/path/mon/item/de/publication.xml", code_gen_stack="web", props={"skin": "default"}, send_props=send_by_server_props)
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernéref_uri<str>: le chemin vers l'item (ou l'ID de l'item)code_gen_stack<str>: le code du générateur (défini dans le modèle. À demander à votre modélisateur ou sur les forums pour un modèle libre)props<Optional[dict[str, typing.Any]]>: dict optionnel pour spécifier des propriétés de génération. Attention, pour utiliser un skin produit avec SCENARIstyler, le code du skin doit être préfixé par le caractère~. Par exemple :{"skin": "~DokielTitania25"}.send_props<Optional[dict[str, any]]>: ce paramètre optionnel permet d'envoyer le résultat de génération par une requête HTTP envoyée par le serveur. Valeur attendue : scapp_6_4.api.item.JSendPropslocal_file_path<Optional[str]>: si spécifié, la génération est téléchargée sur disque vers ce cheminportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Aucun retour si local_file_path ou send_props sont spécifiés. Des bytes contenant la génération sinon.
Complément - wsp_get_item⚓
Récupération d'un item XML.
# Récupération d'un item sous forme de String stocké dans une variable pythonitem_xml = scenaripy_api.wsp_get_item(server, wsp_code, ref_uri="/path/vers/mon/item.xml")
# Récupération d'un item dans un fichier sur disquescenaripy_api.wsp_get_item(server, wsp_code, ref_uri="/path/vers/mon/item.xml", local_file_path="./item.xml")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernéref_uri<str>: le chemin vers l'item (ou l'ID de l'item)local_file_path<Optional[str]>: si spécifié, l'item est téléchargé sur disque vers ce cheminportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Aucun retour si local_file_path est spécifié. Une str contenant l'item sinon.
Complément - wsp_get_res⚓
Récupération d'une ressource binaire.
# Récupération d'un flux binaire dans une variable pythonflux_binaire = scenaripy_api.wsp_get_res(server, wsp_code, src_uri="/path/vers/mon/image.png")
# Récupération d'un flux binaire dans un fichier sur disquescenaripy_api.wsp_get_res(server, wsp_code, src_uri="/path/vers/mon/image.png", local_file_path="./mon-image.png")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernésrc_uri<str>: le chemin vers la ressourcelocal_file_path<Optional[str]>: si spécifié, l'item est téléchargé sur disque vers ce cheminportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Aucun retour si local_file_path est spécifié. la ressourc binaire sous forme de bytes sinon.
Complément - wsp_get_res_meta⚓
Récupération des métadonnées d'une ressource binaire.
# Récupération d'un fichier de méta sous forme de String dans une variable pythonmeta_xml = scenaripy_api.wsp_get_res_meta(server, wsp_code, src_uri="/path/vers/mon/image.png")
# Récupération d'un fichier de meta dans un fichier sur disquescenaripy_api.wsp_get_res_meta(server, wsp_code, src_uri="/path/vers/mon/image.png", local_file_path="./meta.xml")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernésrc_uri<str>: le chemin vers l'itemlocal_file_path<Optional[str]>: si spécifié, l'item est téléchargé sur disque vers ce cheminportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : Aucun retour si local_file_path est spécifié. Une str contenant le fichier de métadonnées sinon.
Complément - wsp_import_scar⚓
Import d'un scar dans un atelier
# Import d'un scar dont le flux binaire est passé en variable. On remplace les items existants de l'atelier.scenaripy_api.wsp_import_scar(server, wsp_code, scar=flux_binaire, replace_if_exist=True)
# Import d'un scar stocké sur disque. On remplace les items existants de l'atelier. On upload dans un dossier spécifiquescenaripy_api.wsp_import_scar(server, wsp_code, ref_uri="/path/vers/mon/espace", replace_if_exist=False, local_file_path="./mon-export.scar")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelierscar<Optional[bytes]>: le contenu du scar au formatbytes. Ne peut pas être spécifié en doublon avec le paramètrelocal_file_pathlocal_file_path<Optional[str]>: le chemin local sur le disque où récupérer le fichier scar à envoyer.ref_uri<Optional[str]>: le chemin vers le dossier vers lequel envoyer l'archive (par défaut, le contenu de l'archive est envoyé à la racine de l'atelier)replace_if_exist<bool>: SpécifierTruepour permettre l'écrasement d'une ressource existanteportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Complément - wsp_search⚓
Appel au moteur de recherche d'un atelier. Cet appel nécessite la création d'un objet scapp_6_4.api.search.Request.
# Recherche des items ayant le mot clé documentationcrit = SearchFullText("documentation")
search_request = Request(criterions=crit)
result = scenaripy_api.wsp_search(server, wsp_code, search_request)
# Spécifier ses propres champs à retournersearch_request = Request(criterions=crit, columns=[ESrcField.srcUri, ESrcField.itTi, ESrcField.itModel])
# Agrandir ou déplacer la fenêtre de recherchesearch_request = Request(criterions=crit, columns=[ESrcField.srcUri, ESrcField.itTi, ESrcField.itModel], number_of_results=1000, start_offset=10)
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet ScPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier ciblérequest<scapp_6_4.api.search.Request>: l'objet Request à envoyer au serveurportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Retour : une liste contenant une liste par résultat puis un champ par colonne définie dans la request.
Complément - wsp_send_scar⚓
Envoie d'un scar par requête HTTP par le serveur depuis un portlet chain.
# Définition d'un objet SendProps pour réaliser l'envoi par le serveursend_by_server_props = {
"method": "PUT",
"url": "https://mon-domaein.org/API/set/backup",
"headerProps": {"Authorization:": "Bearer xxxx"}
"addQSParams": {"token":"xxx"}
}
# Envoi du scarscenaripy_api.wsp_send_scar(server, wsp_code, ref_uri="/path/vers/mon/item/racine.xml", send_props=send_by_server_props)
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernéref_uri<str>: le chemin vers l'item (ou l'ID de l'item)send_props<dict[str, any]>: ce paramètre optionnel permet d'envoyer le résultat de génération par une requête HTTP envoyée par le serveur. Valeur attendue : scapp_6_4.api.item.JSendPropsportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Complément - wsp_set_item⚓
Upload d'un item sur le serveur depuis une chaîne de caractères ou un fichier.
# Upload d'un item stocké dans une variable pythonscenaripy_api.wsp_set_item(server, wsp_code, ref_uri="/path/vers/mon/item.xml", item=item_xml)
# Upload d'un item depuis un fichier sur disquescenaripy_api.wsp_set_item(server, wsp_code, ref_uri="/path/vers/mon/item.xml", local_file_path="./item.xml")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernéref_uri<str>: le chemin vers l'item (ou l'ID de l'item)item<Union[str, bytes, NoneType]>: le contenu de l'item au formatstroubytes. Ne peut pas être spécifié en doublon avec le paramètrelocal_file_pathlocal_file_path<Optional[str]>: le chemin local sur le disque où récupérer le fichier XML de l'item à envoyer.portlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Complément - wsp_set_res⚓
Upload d'un item sur le serveur depuis une chaîne de caractères ou un fichier.
# Upload d'un flux binaire depuis une variable pythonscenaripy_api.wsp_set_res(server, wsp_code, src_uri="/path/vers/mon/image.png", res=flux_binaire)
# Upload d'un fichier binaire depuis un fichier sur disquescenaripy_api.wsp_set_res(server, wsp_code, src_uri="/path/vers/mon/image.png", local_file_path="./mon-image.png")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernésrc_uri<str>: le chemin vers l'itemres<Optional[bytes]>: le contenu du fichier binaire sous forme debytes. Ne peut pas être spécifié en doublon avec le paramètrelocal_file_pathlocal_file_path<Optional[str]>: le chemin local sur le disque où récupérer le fichier binaire à envoyerportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)
Complément - wsp_set_res_meta⚓
Upload d'un item sur le serveur depuis une chaîne de caractères ou un fichier.
# Upload d'un fichier de métadonnées d'un flux binaire depuis une variable pythonscenaripy_api.wsp_set_res_meta(server, wsp_code, src_uri="/path/vers/mon/image.png", meta=meta_xml)
# Upload d'un fichier de métadonnées d'un flux binaire depuis un fichier sur disquescenaripy_api.wsp_set_res_meta(server, wsp_code, src_uri="/path/vers/mon/image.png", local_file_path="./meta.xml")
Paramètre(s) :
portal<scapp_6_4.portal.ScPortal>: l'objet scPortal représentant le serveur Scenari viséwsp_code<str>: le code de l'atelier concernésrc_uri<str>: le chemin vers le fichier des métadonnéesmeta<Union[str, bytes, NoneType]>: le contenu des métadonnées au formatstroubytes. Ne peut pas être spécifié en doublon avec le paramètrelocal_file_pathlocal_file_path<Optional[str]>: le chemin local sur le disque où récupérer le fichier XML de métadonnées à envoyerportlet_code<str>: le code du portlet sur lequel faire la recherche ("chain" par défaut, spécifier ce paramètre pour le changer)