| Service de gestion des champs de la base |
|
DéfinitionLe 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 |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
GetFieldListResult | Objet contenant la liste des champs, le nombre retourné ainsi que le total |
|
|
Les objets du service de gestion des champs de la base |
AuthenticationTokenContext |
|
| Champ | Type | Description |
|---|
| AccountID | int | Identifiant du client | | Key | string | Clé du jeton d'authentification | | ListID | int | Identifiant du client: obsolète. Utilisez AccountID à la place |
|
ServiceException |
|
| Champ | Type | Description |
|---|
| Ticket | string | Le numéro de ticket | | Message | string | Le message d'erreur | | Description | string | La description de l'erreur | | ErrorCodeType | ErrorCodeType | Type du code de l'erreur | | ErrorCode | int | Code de l'erreur |
|
ValidationFault |
|
| Champ | Type | Description |
|---|
| Details | ValidationDetail[]
| Liste des détails de l'erreur de validation de la requête |
|
GetFieldListRequest |
| la classe hérite de : BaseServiceRequest | ||
|
| Champ | Type | Description |
|---|
| Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur | | ProfileID | int | (Facultatif) - Identifiant du profil | | Offset | int | (Facultatif) - Offset de lecture | | Limit | int | (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 |
|
| Champ | Type | Description |
|---|
| Total | int | Nombre total de champs | | Count | int | Nombre de champs retournés | | FieldList | Field[]
| Liste des champs |
|
Field |
|
| Champ | Type | Description |
|---|
| ID | int | Identifiant du champ | | Type | FieldType | Type du champ | | Name | string | Nom système du champ | | Title | string | Nom personalisé du champ | | DisplayRank | int | Ordre d'affichage du champ | | IsCustom | boolean | Flag, champ personnalisé / champ système | | Access | FieldRight | Droits du champ | | Display | DisplayType | Type d'affichage (déprécié) | | TranslationKey | string | Clé de traduction (système) | | LengthValue | int | Taille / Valeur maximale du champ | | CreatedDate | dateTime | Date de création du champ | | ValueList | FieldValue[]
| Liste de valeurs possible du champ (système) | | PendingDelete | boolean | Flag, champ en cours de suppression | | IsCompositeKeyProperty | boolean | API.DOC.CUSTOMFIELD.FIELD.ISCUSTOMKEYPROPERTY |
Les valeurs possibles pour Type sont : - String
- Int
- Date (Format : YYYY-MM-DD HH:MM:SS)
|
FieldRight |
|
| Champ | Type | Description |
|---|
| CanDisplay | boolean | Ce champ peut-il être affiché? | | CanDelete | boolean | Ce champ peut-il être supprimé? | | CanRename | boolean | Ce champ peut-il être renommé? | | CanChangeType | boolean | Le type du champ peut-il être changé? | | CanChangeSize | boolean | La taille du champ peut-elle être modifiée? | | CanChangeOrder | boolean | Ce champ peut-il être réordonné? |
|
FieldValue |
|
| Champ | Type | Description |
|---|
| ID | int | Identifiant de la valeur | | Name | string | Nom de la valeur |
|
BaseServiceRequest |
|
| Champ | Type | Description |
|---|
| Culture | string | (Facultatif) - Langue de l'utilisateur (ex: fr-FR) | | UserEmail | string | (Facultatif) - [Options et Droits de l'utilisateur] - Adresse e-mail de l'utilisateur |
|
ValidationDetail |
|
| Champ | Type | Description |
|---|
| Key | string | Nom du champ à valider | | Message | string | Résultat de la validation | | Tag | string | Tag de validation |
|
Liste des erreurs communes |
|
| Code | Nom | Description |
|---|
| 0 | UnexpectedException | Erreur inattendue | | 1 | AuthenticationException | Erreur d'authentification | | 2 | NullTokenException | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 3 | NullRequestException | L'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée | | 5 | InvalidArgumentException | Les arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité | | 6 | BadRequestException | La requête n'est pas correcte | | 7 | NothingToDoException | La 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 | | 8 | InvalidDataTypeException | Le type de donnée n'est pas valide | | 9 | UnknownTicketException | Le ticket n'est pas connu, vérifiez la valeur de celui-ci | | 10 | UnavailableTicketResultException | Le résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard. | | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | | 999998 | TokenNull | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 999999 | TokenNotAuthorized | L'objet 'token' n'est pas autorisé, vérifiez les propriétés |
|