Accéder au contenu principal Passer au contenu complémentaire

Obtenir le schéma XML d'un modèle de données

Availability-noteDéprécié·e

Obtient le schéma XML d'un modèle de données par son nom.

Note InformationsRemarque : Seuls les utilisateurs et utilisatrices de type Super Admin ayant le rôle administrateur ont accès à cette API. Pour plus d'informations concernant les types d'utilisateur·trices MDM, consultez Types d'utilisateurs et rôles système MDM.
Requête
GET /services/rest/system/models/{model}
Paramètres
  • model : valeur String qui représente le nom du modèle de données dont vous souhaitez obtenir le schéma XML.
En-têtes
  • Accept : application/xml
  • Authorization : schéma d'authentification basique
Réponse Schéma XML du modèle de données spécifié.
Statut
  • 200 OK : l'opération a bien été exécutée.
  • 400 BAD REQUEST : la requête contient un paramètre invalide.
  • 401 UNAUTHORIZED : la connexion échoue, l'identifiant ou le mot de passe est invalide.
  • 403 FORBIDDEN : l'autorisation requise est manquante.
  • 404 NOT FOUND : la ressource n'existe pas, par exemple le nom du modèle de données est invalide.
  • 500 INTERNAL SERVER ERROR : autres erreurs, par exemple un schéma incorrect.

Exemple de réponse

L'exemple suivant montre le schéma XML d'un modèle de données Company, avec deux entités Employee et Team.

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <xsd:import namespace="http://www.w3.org/2001/XMLSchema"/>
    <xsd:element name="Employee">
        <xsd:annotation>
            <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
            <xsd:appinfo source="X_Write">Company_User</xsd:appinfo>
        </xsd:annotation>
        <xsd:complexType>
            <xsd:all>
                <xsd:element maxOccurs="1" minOccurs="1" name="Id" type="xsd:string">
                    <xsd:annotation>
                        <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
                        <xsd:appinfo source="X_Write">Company_User</xsd:appinfo>
                    </xsd:annotation>
                </xsd:element>
                <xsd:element maxOccurs="1" minOccurs="1" name="Name" type="xsd:string">
                    <xsd:annotation>
                        <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
                        <xsd:appinfo source="X_Write">Company_User</xsd:appinfo>
                    </xsd:annotation>
                </xsd:element>
                <xsd:element maxOccurs="1" minOccurs="1" name="Team" type="xsd:string">
                    <xsd:annotation>
                        <xsd:appinfo source="X_ForeignKey">Team/Id</xsd:appinfo>
                        <xsd:appinfo source="X_ForeignKey_NotSep">true</xsd:appinfo>
                        <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
                        <xsd:appinfo source="X_Write">Company_User</xsd:appinfo>
                    </xsd:annotation>
                </xsd:element>
            </xsd:all>
        </xsd:complexType>
        <xsd:unique name="Employee">
            <xsd:selector xpath="."/>
            <xsd:field xpath="Id"/>
        </xsd:unique>
    </xsd:element>
    <xsd:element name="Team">
        <xsd:annotation>
            <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
        </xsd:annotation>
        <xsd:complexType>
            <xsd:all>
                <xsd:element maxOccurs="1" minOccurs="1" name="Id" type="xsd:string">
                    <xsd:annotation>
                        <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
                    </xsd:annotation>
                </xsd:element>
                <xsd:element maxOccurs="1" minOccurs="1" name="Name" type="xsd:string">
                    <xsd:annotation>
                        <xsd:appinfo source="X_Write">Company_Manager</xsd:appinfo>
                    </xsd:annotation>
                </xsd:element>
            </xsd:all>
        </xsd:complexType>
        <xsd:unique name="Team">
            <xsd:selector xpath="."/>
            <xsd:field xpath="Id"/>
        </xsd:unique>
    </xsd:element>
</xsd:schema>

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !