Action getcontext (REST info)

De Wiki1000
(Différences entre les versions)
 
(5 révisions intermédiaires par un utilisateur sont masquées)
Ligne 1 : Ligne 1 :
 
Cette action (authentifié) retourne des informations sur le contextes de l'utilisateur.
 
Cette action (authentifié) retourne des informations sur le contextes de l'utilisateur.
  
−
<pre>http://hostname/servicename/rpc.l1000/rest/info.context?SID=xxxx</pre>
+
<pre>http://hostname/servicename/server/rpc.l1000/rest/info.getcontext?SID=xxxx</pre>
  
 
{|class="wikitable"
 
{|class="wikitable"
Ligne 10 : Ligne 10 :
  
 
'''Informations retournées :'''
 
'''Informations retournées :'''
−
 
+
{{:Informations de session (server)}}
 
{|class="wikitable"
 
{|class="wikitable"
 
|-
 
|-
Ligne 38 : Ligne 38 :
 
|}
 
|}
  
−
'''Informations multi-sociétés retournées :'''
+
'''Informations multi-sociétés retournées (vue du contexte):'''
  
 
{|class="wikitable"
 
{|class="wikitable"
Ligne 46 : Ligne 46 :
 
!Valeur
 
!Valeur
 
|-
 
|-
−
|glbGroupMode
+
|glbShareGroupMode
 
|boolean
 
|boolean
 
|Le contexte est en mode groupe.
 
|Le contexte est en mode groupe.
 
|-
 
|-
 
|glbShareSocietyPerimeter
 
|glbShareSocietyPerimeter
−
|string
+
|OID
 
|OID du périmètre société.<br>
 
|OID du périmètre société.<br>
 
(Société active)
 
(Société active)
 
|-
 
|-
 
|glbShareGroupPerimeter
 
|glbShareGroupPerimeter
−
|string
+
|OID
 
|OID du périmètre dossier.
 
|OID du périmètre dossier.
 +
|-
 +
|glbShareSocieties
 +
|OIDs
 +
|Liste des périmètres sociétés actives
 
|-
 
|-
 
|glbSharePerimeters
 
|glbSharePerimeters
−
|string
+
|OIDs
−
|Liste de tous les périmètres de la société active
+
|Liste de tous les périmètres des sociétés actives<br>
 +
Inclus les périmètres sociétés, les périmètres de partage et le périmètre dossier.
 
|-
 
|-
 
|glbShareRestitution
 
|glbShareRestitution
Ligne 70 : Ligne 75 :
 
|boolean
 
|boolean
 
|Le mode restitution est sur toutes les sociétés du dossier.
 
|Le mode restitution est sur toutes les sociétés du dossier.
−
|-
 
−
|glbShareSocieties
 
−
|string
 
−
|Liste des sociétés de restitution
 
 
|-
 
|-
 
|glbShareRestitutionName
 
|glbShareRestitutionName
Ligne 79 : Ligne 80 :
 
|Nom de la famille de restitution
 
|Nom de la famille de restitution
 
|}
 
|}
 +
 +
'''Informations multi-sociétés retournées (vue API):'''
  
 
Exemple de réponse :  
 
Exemple de réponse :  
 +
 +
<source lang="xml">
 +
<result status="-1">
 +
<error>
 +
  Le service "info.getcontext" requière une authentification.
 +
</error>
 +
</result>
 +
</source>
  
 
<source lang="xml">
 
<source lang="xml">
 
<methodResponse>
 
<methodResponse>
 
  <params>
 
  <params>
−
   <param>
+
   <username>syfre</username>
−
  <value>
+
  <groupname>GrpAdmin</groupname>
−
  </value>
+
  <authdirname>Annuaire entreprise</authdirname>
−
   </param>
+
  <socname>Test Multi-société</socname>
 +
  <appname>Test Multi-Société</appname>
 +
  <glbShareState>
 +
DA1B000000000008000A000000020002;0;0;DA1B000000000008000A0000001C0008;DA1B000000000008000A0000001C0008;DA1B000000000008000A000000020002,DA1B000000000008000A0000001C0008,DA1B000000000008000A0000001C0004,DA1B000000000008000A0000001C0007;
 +
  </glbShareState>
 +
  <glbShareRestitution>false</glbShareRestitution>
 +
  <glbShareAllPerimeters>false</glbShareAllPerimeters>
 +
  <glbShareRestitutionName/>
 +
  <glbShareSocieties>DA1B000000000008000A0000001C0008</glbShareSocieties>
 +
  <glbSharePerimeters>
 +
DA1B000000000008000A000000020002,DA1B000000000008000A0000001C0008,DA1B000000000008000A0000001C0004,DA1B000000000008000A0000001C0007
 +
  </glbSharePerimeters>
 +
  <glbShareGroupMode>false</glbShareGroupMode>
 +
  <glbShareGroupPerimeter>DA1B000000000008000A000000020002</glbShareGroupPerimeter>
 +
  <glbShareSocietyPerimeter>DA1B000000000008000A0000001C0008</glbShareSocietyPerimeter>
 +
  <ShareSociety>DA1B000000000008000A0000001C0008</ShareSociety>
 +
  <ShareSocietyName>S1</ShareSocietyName>
 +
  <ShareRestitution>false</ShareRestitution>
 +
  <ShareAllPerimeters>false</ShareAllPerimeters>
 +
   <ShareResitutionSocieties/>
 
  </params>
 
  </params>
 
</methodResponse>
 
</methodResponse>
Ligne 96 : Ligne 126 :
  
 
*[[Service REST de session (server)|Service REST de session]]
 
*[[Service REST de session (server)|Service REST de session]]
 +
*[[Action setcontext (REST info)|Action setcontext du service REST de session]]
 +
  
 
{{footer}}
 
{{footer}}
 
[[Category:Actions REST]]
 
[[Category:Actions REST]]

Version actuelle en date du 8 octobre 2013 à 16:19

Cette action (authentifié) retourne des informations sur le contextes de l'utilisateur. 

http://hostname/servicename/server/rpc.l1000/rest/info.getcontext?SID=xxxx
Paramètre Valeur

Informations retournées : Informations sur le dossier

Paramètre Usage
socname Dossier de la session.
appname Nom de l'application de la session
glbShareEnable Le contexte est en mode partage

Informations sur l'utilisateur

Paramètre Usage
username Nom de l'utilisateur.
userfullname Nom complet de l'utilisateur.
userlanguage Langue de l'utilisateur.
useremail Email de l'utilisateur.
groupname Autorisé en tant que membre du groupe.
authdirname Intitulé de l'annuaire utilisé.

Si le dossier est multi-société les informations suivantes sont retournées :

Vue contexte :

Paramètre Usage
glbShareRestitution Le contexte est mode restitution
glbShareAllPerimeters Le contexte est en mode restitution sur toutes les sociétés
glbShareSocieties Liste des sociétés du contexte de restitution
glbShareGroupMode Le contexte est en mode groupe
glbShareGroupPerimeter Périmètre groupe du contexte.
glbShareSocietyPerimeter Périmètre sociétés du contexte
glbSharePerimeters Périmètres actifs du contexte
glbShareSocietyName Nom de la société du contexte
glbSharePerimeterNames Nom de tous les périmètres actifs du contexte
glbShareSocietyNames Nom de toutes les sociétés du dossier
GlbShareAutorizedReadSocieties Nom des sociétés sur lesquelles l'utilisateur à des droits de lecture
GlbShareAutorizedWriteSocieties Nom des sociétés sur lesquelles l'utilisateur à des droits d'écriture

Vue API :

Information Type Valeur
ShareState string Une chaîne contenant la sérialisation de l'état du contexte de partage.
ShareSociety OID Le périmètre de la société active
ShareSocietyName string le nom de la société active.
ShareRestitution boolean Le contexte est en mode restitution.
ShareAllPerimeters boolean Le mode restitution est sur toutes les sociétés du dossier.
ShareRestitutionSocieties StringList Liste des noms de toutes les périmètres des sociétés actives
Information Type Valeur
username string Nom de l'utilisateur
groupname string Nom du groupe ayant authentifié l'utilisateur
authdirname string Nom de l'annuaire
socname string Nom du dossier
appname string Nom de l'application

Informations multi-sociétés retournées (vue du contexte):

Information Type Valeur
glbShareGroupMode boolean Le contexte est en mode groupe.
glbShareSocietyPerimeter OID OID du périmètre société.

(Société active)

glbShareGroupPerimeter OID OID du périmètre dossier.
glbShareSocieties OIDs Liste des périmètres sociétés actives
glbSharePerimeters OIDs Liste de tous les périmètres des sociétés actives

Inclus les périmètres sociétés, les périmètres de partage et le périmètre dossier.

glbShareRestitution boolean Le contexte est en mode restitution.
glbShareAllPerimeters boolean Le mode restitution est sur toutes les sociétés du dossier.
glbShareRestitutionName string Nom de la famille de restitution

Informations multi-sociétés retournées (vue API):

Exemple de réponse : 

<result status="-1">
 <error>
  Le service "info.getcontext" requière une authentification.
 </error>
</result>
<methodResponse>
 <params>
  <username>syfre</username>
  <groupname>GrpAdmin</groupname>
  <authdirname>Annuaire entreprise</authdirname>
  <socname>Test Multi-société</socname>
  <appname>Test Multi-Société</appname>
  <glbShareState>
DA1B000000000008000A000000020002;0;0;DA1B000000000008000A0000001C0008;DA1B000000000008000A0000001C0008;DA1B000000000008000A000000020002,DA1B000000000008000A0000001C0008,DA1B000000000008000A0000001C0004,DA1B000000000008000A0000001C0007;
  </glbShareState>
  <glbShareRestitution>false</glbShareRestitution>
  <glbShareAllPerimeters>false</glbShareAllPerimeters>
  <glbShareRestitutionName/>
  <glbShareSocieties>DA1B000000000008000A0000001C0008</glbShareSocieties>
  <glbSharePerimeters>
DA1B000000000008000A000000020002,DA1B000000000008000A0000001C0008,DA1B000000000008000A0000001C0004,DA1B000000000008000A0000001C0007
  </glbSharePerimeters>
  <glbShareGroupMode>false</glbShareGroupMode>
  <glbShareGroupPerimeter>DA1B000000000008000A000000020002</glbShareGroupPerimeter>
  <glbShareSocietyPerimeter>DA1B000000000008000A0000001C0008</glbShareSocietyPerimeter>
  <ShareSociety>DA1B000000000008000A0000001C0008</ShareSociety>
  <ShareSocietyName>S1</ShareSocietyName>
  <ShareRestitution>false</ShareRestitution>
  <ShareAllPerimeters>false</ShareAllPerimeters>
  <ShareResitutionSocieties/>
 </params>
</methodResponse>

Voir aussi :


— Développement DSM —

Récupérée de « https://frp.sage.fr/wiki1000/index.php?title=Action_getcontext_(REST_info)&oldid=7613 »
Outils personnels