ObjectDataTypes Endpoints
Last modified by Achraf El Kari on 2022/06/13 13:17
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 [ { "alias": "id", "isId": true, "translations": { "fr": "Identifiant", "en": "Key" }, "type": "STRING", "dataType": "orderLine", "size": 40, "defaultValue": null, "mandatory": false, "children": [], "isList": false }, { "alias": "_metadata", "isId": false, "translations": { "fr": "Metadata", "en": "Metadata" }, "type": "OBJECT", "dataType": "metadata", "size": 40, "defaultValue": null, "mandatory": false, "children": [ { "size": 40, "children": [], "defaultValue": null, "dataType": "metadata", "alias": "jobID", "label": { "en": "Job ID", "fr": "ID du Job" }, "type": "STRING", "mandatory": false, "isList": false }, { "size": 40, "children": [], "defaultValue": null, "dataType": "metadata", "alias": "fileID", "label": { "en": "fileID", "fr": "fileID" }, "type": "LIST", "mandatory": false, "isList": true }, { "size": 40, "children": [], "defaultValue": null, "dataType": "metadata", "alias": "envID", "label": { "en": "envID", "fr": "envID" }, "type": "STRING", "mandatory": false, "isList": false }, { "size": 40, "children": [], "defaultValue": null, "dataType": "metadata", "alias": "statusTracking", "label": { "en": "Tracking status", "fr": "Status tracking" }, "type": "STRING", "mandatory": false, "isList": false }, { "size": 40, "children": [], "defaultValue": null, "dataType": "metadata", "alias": "creationDate", "label": { "en": "Creation's date", "fr": "Date de création" }, "type": "DATE", "mandatory": false, "isList": false }, { "size": 40, "children": [], "defaultValue": null, "dataType": "metadata", "alias": "statusTrackingHistory", "label": { "en": "Tracking status history", "fr": "Historique des status tracking" }, "type": "LIST", "mandatory": false, "isList": true } ], "isList": false }, { "alias": "orderLineNumber", "isId": false, "translations": { "fr": "Numéro de commande", "en": "Order Number" }, "type": "NUMBER", "dataType": "orderLine", "size": 10, "defaultValue": null, "mandatory": true, "children": [], "isList": false }, { "alias": "Column1", "isId": false, "translations": { "fr": "Column 1", "en": "C1" }, "type": "LIST<OBJECT>", "dataType": "orderLine", "size": null, "defaultValue": null, "mandatory": false, "children": [ { "alias": "description1", "isId": false, "translations": { "fr": "Comment 1", "en": "Order Number" }, "type": "STRING", "dataType": "comment", "size": 10, "defaultValue": null, "mandatory": false, "children": [], "isList": false }, { "alias": "description2", "isId": false, "translations": { "fr": "Column 1", "en": "C1" }, "type": "STRING", "dataType": "comment", "size": null, "defaultValue": null, "mandatory": false, "children": [], "isList": false } ], "isList": true } ] | |
| /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 = environment [ { "isId": true, "size": 10, "children": [], "translations": { "en": "Environment ID", "fr": "Environnement ID" }, "defaultValue": null, "dataType": "environment", "alias": "envid", "type": "NUMBER", "mandatory": false, "isList": false }, { "size": 10, "children": [], "translations": { "en": "parent Environment ID", "fr": "parent Environment ID" }, "defaultValue": null, "dataType": "environment", "alias": "parent", "type": "NUMBER", "mandatory": false, "isList": false }, { "size": 10, "children": [], "translations": { "en": "Alias", "fr": "Alias" }, "defaultValue": null, "dataType": "environment", "alias": "alias", "type": "STRING", "mandatory": true, "isList": false }, { "size": 10, "children": [], "translations": { "en": "Code", "fr": "Code" }, "defaultValue": null, "dataType": "environment", "alias": "code", "type": "STRING", "mandatory": false, "isList": false }, { "size": 10, "children": [], "translations": { "en": "Send URL", "fr": "Envoi de l'URL" }, "defaultValue": null, "dataType": "environment", "alias": "sendurl", "type": "BOOLEAN", "mandatory": false, "isList": false }, { "size": 10, "children": [], "translations": { "en": "Enabled", "fr": "Active" }, "defaultValue": null, "dataType": "environment", "alias": "active", "type": "BOOLEAN", "mandatory": true, "isList": false }, { "size": 10, "children": [], "translations": { "en": "Time zone", "fr": "fuseau horaire" }, "defaultValue": null, "dataType": "environment", "alias": "timezone", "type": "STRING", "mandatory": true, "isList": false }, { "size": 10, "children": [], "translations": { "en": "git repository", "fr": "git repository" }, "defaultValue": null, "dataType": "environment", "alias": "gitRepository", "type": "STRING", "mandatory": false, "isList": false } ]
|
NB :
- Detail of each field:
- "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, LIST)
- "alias": the path to the field