Service de gestion des champs de la base
Contrat WSDLhttp://apitmapreprod.dolist.net/CustomFieldManagementService.svc?wsdl
Exemple disponible
  • Implémentation en .NET C# 4.0

  • Définition

    Le service de gestion des champs de la base vous permet de récupérer l'ensemble des champs disponibles pour un contact.
    Récupérez le typage du champ, sa taille maximale, son nom système, son nom personnalisé... et intégrez les directement dans votre système d'informations afin d'avoir un mapping complet entre vos données et les données hébergées sur Dolist-V8.

    Récupération de la liste des champs

    Nom de la méthode : GetFieldList

    Cette méthode récupère le descriptif complet (nom système, type de champs, taille maximale...) des champs de la base, disponibles sur la plateforme DOLIST-V8.
    Les paramètres attendus en entrée
    ChampTypeDescription
    tokenAuthenticationTokenContextJeton d'authentification
    requestGetFieldListRequestParamètres de la requête (filtres)
    Les valeurs renvoyées
    TypeDescription
    GetFieldListResultObjet contenant la liste des champs, le nombre retourné ainsi que le total

    Les objets du service de gestion des champs de la base

    AuthenticationTokenContext

    ChampTypeDescription
    AccountIDintIdentifiant du client
    KeystringClé du jeton d'authentification
    ListIDintIdentifiant du client: obsolète. Utilisez AccountID à la place

      ServiceException

      ChampTypeDescription
      TicketstringLe numéro de ticket
      MessagestringLe message d'erreur
      DescriptionstringLa description de l'erreur
      ErrorCodeTypeErrorCodeTypeType du code de l'erreur
      ErrorCodeintCode de l'erreur

        ValidationFault

        ChampTypeDescription
        DetailsValidationDetail[] Liste des détails de l'erreur de validation de la requête

          GetFieldListRequest

          la classe hérite de : BaseServiceRequest
          ChampTypeDescription
          Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
          UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur
          ProfileIDint(Facultatif) - Identifiant du profil
          Offsetint(Facultatif) - Offset de lecture
          Limitint(Facultatif) - Nombre d'éléments à retourner
          • Les paramètres Offset et Limit ne peuvent pas fonctionner séparément. L'Offset définit la position de départ et la Limit le nombre d'enregistrements à retourner.
          • Pour récupérer les champs affichés sur la plateforme Dolist-V8, vous devez définir le ProfileId à 1. Si vous ne l'indiquez pas, l'ensemble des champs de la base vous sera retourné. La gestion de profils différents est prévue dans un développement futur.
          • Les cultures possibles sont EN_US et FR_FR.

          GetFieldListResult

          ChampTypeDescription
          TotalintNombre total de champs
          CountintNombre de champs retournés
          FieldListField[] Liste des champs

            Field

            ChampTypeDescription
            IDintIdentifiant du champ
            TypeFieldTypeType du champ
            NamestringNom système du champ
            TitlestringNom personalisé du champ
            DisplayRankintOrdre d'affichage du champ
            IsCustombooleanFlag, champ personnalisé / champ système
            AccessFieldRightDroits du champ
            DisplayDisplayTypeType d'affichage (déprécié)
            TranslationKeystringClé de traduction (système)
            LengthValueintTaille / Valeur maximale du champ
            CreatedDatedateTimeDate de création du champ
            ValueListFieldValue[] Liste de valeurs possible du champ (système)
            PendingDeletebooleanFlag, champ en cours de suppression
            IsCompositeKeyPropertybooleanAPI.DOC.CUSTOMFIELD.FIELD.ISCUSTOMKEYPROPERTY

            Les valeurs possibles pour Type sont :
            • String
            • Int
            • Date (Format : YYYY-MM-DD HH:MM:SS)

            FieldRight

            ChampTypeDescription
            CanDisplaybooleanCe champ peut-il être affiché?
            CanDeletebooleanCe champ peut-il être supprimé?
            CanRenamebooleanCe champ peut-il être renommé?
            CanChangeTypebooleanLe type du champ peut-il être changé?
            CanChangeSizebooleanLa taille du champ peut-elle être modifiée?
            CanChangeOrderbooleanCe champ peut-il être réordonné?

              FieldValue

              ChampTypeDescription
              IDintIdentifiant de la valeur
              NamestringNom de la valeur

                BaseServiceRequest

                ChampTypeDescription
                Culturestring(Facultatif) - Langue de l'utilisateur (ex: fr-FR)
                UserEmailstring(Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur

                  ValidationDetail

                  ChampTypeDescription
                  KeystringNom du champ à valider
                  MessagestringRésultat de la validation
                  TagstringTag de validation

                    Liste des erreurs communes

                    CodeNomDescription
                    0UnexpectedExceptionErreur inattendue
                    1AuthenticationExceptionErreur d'authentification
                    2NullTokenExceptionLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
                    3NullRequestExceptionL'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
                    4ForbiddenActionExceptionL'action demandée n'est pas autorisée
                    5InvalidArgumentExceptionLes arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité
                    6BadRequestExceptionLa requête n'est pas correcte
                    7NothingToDoExceptionLa requête demandée n'effectue aucun traitement, car les données soient déjà à jour, il est possible que la requête ai été exécuté plusieurs fois
                    8InvalidDataTypeExceptionLe type de donnée n'est pas valide
                    9UnknownTicketExceptionLe ticket n'est pas connu, vérifiez la valeur de celui-ci
                    10UnavailableTicketResultExceptionLe résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard.
                    11InvalidDatePeriodExceptionL'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête
                    999998TokenNullLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
                    999999TokenNotAuthorizedL'objet 'token' n'est pas autorisé, vérifiez les propriétés