ObjectDataTypes Endpoints
Version 1.4 by Outhman Moustaghfir on 2021/11/26 10:36
Introduction
The following table will explain how to get the list of DataTypes using the endpoints.
Endpoints
| URL [method] | Description | Input example | Output example | Comments |
| /rest/dataTypes/tracking/{trackingType} [GET] | Get the dataTypes list of an indicated tracking type. | The {trackingType} bracket should be replaced by the environment's Tracking type alias. | eg : for trackingType = orderLine [ { "labelEn": "Order Number", "dataType": "orderLine", "alias": "orderLineNumber", "labelFr": "Numéro de commande", "type": "NUMBER", "mandatory": "true" }, { "labelEn": "C1", "dataType": "orderLine", "alias": "comment", "labelFr": "Column 1", "type": "LIST<OBJECT>", "mandatory": "false" }, { "labelEn": "Order Number", "dataType": "comment", "alias": "comment.description1", "labelFr": "Comment 1", "type": "STRING", "mandatory": "false" }, { "labelEn": "C1", "dataType": "comment", "alias": "comment.description2", "labelFr": "Column 1", "type": "STRING", "mandatory": "false" } ] | |
| /rest/dataTypes/system/{data} | Get the dataTypes list of indicated data. | The {data} bracket should be replaced by the environment's data's alias. | eg : for data = user [ { "labelEn": "User ID", "dataType": "user", "alias": "userid", "labelFr": "Identifiant de l'utilisateur", "type": "NUMBER", "mandatory": "false" }, { "labelEn": "Person", "dataType": "user", "alias": "person", "labelFr": "Personne", "type": "OBJECT", "mandatory": "true" }, { "labelEn": "Person ID", "dataType": "person", "alias": "person.trkid", "labelFr": "Identifiant person", "type": "NUMBER", "mandatory": "false" }, { "labelEn": "first name", "dataType": "person", "alias": "person.firstname", "labelFr": "prénom", "type": "STRING", "mandatory": "true" }, { "labelEn": "last name", "dataType": "person", "alias": "person.lastname", "labelFr": "nom", "type": "STRING", "mandatory": "true" }, { "labelEn": "mail address", "dataType": "person", "alias": "person.mailaddress", "labelFr": "adresse mail", "type": "STRING", "mandatory": "true" }, { "labelEn": "phone", "dataType": "person", "alias": "person.phone", "labelFr": "mobile", "type": "STRING", "mandatory": "true" }, { "labelEn": "role", "dataType": "person", "alias": "person.role", "labelFr": "role", "type": "STRING", "mandatory": "false" }, { "labelEn": "service", "dataType": "person", "alias": "person.service", "labelFr": "service", "type": "STRING", "mandatory": "false" }, { "labelEn": "Group", "dataType": "user", "alias": "group", "labelFr": "Groupe", "type": "OBJECT", "mandatory": "true" }, { "labelEn": "Group ID", "dataType": "group", "alias": "group.id", "labelFr": "Identifiant groupe", "type": "NUMBER", "mandatory": "false" }, { "labelEn": "alias", "dataType": "group", "alias": "group.alias", "labelFr": "alias", "type": "STRING", "mandatory": "true" }, { "labelEn": "group parent ID", "dataType": "group", "alias": "group.parent", "labelFr": "groupe parent ID", "type": "NUMBER", "mandatory": "true" }, { "labelEn": "permission", "dataType": "group", "alias": "group.permission", "labelFr": "permission", "type": "STRING", "mandatory": "true" }, { "labelEn": "Alias", "dataType": "user", "alias": "alias", "labelFr": "Alias", "type": "STRING", "mandatory": "false" }, { "labelEn": "password", "dataType": "user", "alias": "password", "labelFr": "mot de passe", "type": "STRING", "mandatory": "true" }, { "labelEn": "apssword delay", "dataType": "user", "alias": "passworddelay", "labelFr": "délai du mot de passe", "type": "NUMBER", "mandatory": "true" }, { "labelEn": "Main environment", "dataType": "user", "alias": "envId", "labelFr": "Environnment principal", "type": "NUMBER", "mandatory": "false" }, { "labelEn": "Enabled", "dataType": "user", "alias": "active", "labelFr": "Active", "type": "BOOLEAN", "mandatory": "true" }, { "labelEn": "Time zone", "dataType": "user", "alias": "timezone", "labelFr": "fuseau horaire", "type": "STRING", "mandatory": "true" }, { "labelEn": "Language", "dataType": "user", "alias": "language", "labelFr": "Langue", "type": "STRING", "mandatory": "true" }, { "labelEn": "last connected", "dataType": "user", "alias": "lastconnected", "labelFr": "dernière connexion", "type": "DATE", "mandatory": "true" }, { "labelEn": "last password", "dataType": "user", "alias": "lastpassword", "labelFr": "Dernier mot de passe", "type": "DATE", "mandatory": "true" }, { "labelEn": "default page", "dataType": "user", "alias": "defaultpage", "labelFr": "Page par defaut", "type": "NUMBER", "mandatory": "true" }, { "labelEn": "first access", "dataType": "user", "alias": "firstaccess", "labelFr": "premier acces", "type": "BOOLEAN", "mandatory": "true" }, { "labelEn": "Logged", "dataType": "user", "alias": "logged", "labelFr": "Connecté", "type": "STRING", "mandatory": "true" }, { "labelEn": "authorized environments", "dataType": "user", "alias": "envs", "labelFr": "Environnments autorisés", "type": "LIST<OBJECT>", "mandatory": "true" }, { "labelEn": "Environment ID", "dataType": "environment", "alias": "envs.envid", "labelFr": "Environnement ID", "type": "NUMBER", "mandatory": "false" }, { "labelEn": "parent Environment ID", "dataType": "environment", "alias": "envs.parent", "labelFr": "parent Environment ID", "type": "NUMBER", "mandatory": "true" }, { "labelEn": "Alias", "dataType": "environment", "alias": "envs.alias", "labelFr": "Alias", "type": "STRING", "mandatory": "true" }, { "labelEn": "Code", "dataType": "environment", "alias": "envs.code", "labelFr": "Code", "type": "STRING", "mandatory": "false" }, { "labelEn": "Send URL", "dataType": "environment", "alias": "envs.sendurl", "labelFr": "Envoi de l'URL", "type": "BOOLEAN", "mandatory": "false" }, { "labelEn": "Enabled", "dataType": "environment", "alias": "envs.active", "labelFr": "Active", "type": "BOOLEAN", "mandatory": "true" }, { "labelEn": "Time zone", "dataType": "environment", "alias": "envs.timezone", "labelFr": "fuseau horaire", "type": "STRING", "mandatory": "true" }, { "labelEn": "git repository", "dataType": "environment", "alias": "envs.gitRepository", "labelFr": "git repository", "type": "STRING", "mandatory": "false" }, { "labelEn": "blocked environments", "dataType": "user", "alias": "envsbloque", "labelFr": "Environnments bloqués", "type": "LIST<OBJECT>", "mandatory": "true" }, { "labelEn": "Environment ID", "dataType": "environment", "alias": "envsbloque.envid", "labelFr": "Environnement ID", "type": "NUMBER", "mandatory": "false" }, { "labelEn": "parent Environment ID", "dataType": "environment", "alias": "envsbloque.parent", "labelFr": "parent Environment ID", "type": "NUMBER", "mandatory": "true" }, { "labelEn": "Alias", "dataType": "environment", "alias": "envsbloque.alias", "labelFr": "Alias", "type": "STRING", "mandatory": "true" }, { "labelEn": "Code", "dataType": "environment", "alias": "envsbloque.code", "labelFr": "Code", "type": "STRING", "mandatory": "false" }, { "labelEn": "Send URL", "dataType": "environment", "alias": "envsbloque.sendurl", "labelFr": "Envoi de l'URL", "type": "BOOLEAN", "mandatory": "false" }, { "labelEn": "Enabled", "dataType": "environment", "alias": "envsbloque.active", "labelFr": "Active", "type": "BOOLEAN", "mandatory": "true" }, { "labelEn": "Time zone", "dataType": "environment", "alias": "envsbloque.timezone", "labelFr": "fuseau horaire", "type": "STRING", "mandatory": "true" }, { "labelEn": "git repository", "dataType": "environment", "alias": "envsbloque.gitRepository", "labelFr": "git repository", "type": "STRING", "mandatory": "false" } ]
|
NB :
- Detail of each field:
- "labelEn": Label in English
- "labelFr": Label in French
- "dataType" : the tracking type concerned
- "mandatory": is it obligatory or not? true or false.
- "type": type of data (STRING, NUMBER, BOOLEAN, DATE, LIST<OBJECT>, OBJECT)
- "alias": the path to the field