Changes for page Tracking Type

Last modified by Achraf El Kari on 2022/06/13 13:17
<
From version < 7.3 >
edited by Achraf El Kari
on 2021/11/23 11:35
To version < 9.3 >
edited by Achraf El Kari
on 2021/11/25 11:35
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,31 +8,58 @@
8 8  
9 9  = Endpoints =
10 10  
11 -**PS :** __//For all those endpoints, the env params is andatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
11 +**PS:** __//For all those endpoints, the env params are mandatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
12 12  
13 13  
14 -|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
15 -|(% style="width:166px" %)(((
14 +|(% style="width:202px" %)**URL [method]**|(% style="width:126px" %)**Description**|(% style="width:250px" %)**Input example**|(% style="width:449px" %)**Output example**
15 +|(% style="width:202px" %)(((
16 16  /rest/trackingType [GET]
17 17  
18 18  
19 19  hedear : Authorization + env => Mandatory
20 -\\PS :** If the env does not exist on the header, you got an error 400 (bad params)**
21 -)))|(% style="width:238px" %)get all tracking Type of the giving environment|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
22 - "timestamp": 1620216790744,
23 - "status": "200",
24 - "data": [
25 - {
26 - "fileName": "FileToF.txt",
27 - "status": "Untracked"
28 - },
29 - {
30 - "fileName": "newfile.txt",
31 - "status": "Modified"
32 - }
33 - ]
34 -}{{/code}}
35 -|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:238px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
20 +
21 +)))|(% style="width:126px" %)(((
22 +get **all **tracking Types of the giving environment ==>
23 +
24 +order, orderLine...
25 +)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)[[attach:TrackingTypes.json||target="_blank"]]
26 +|(% style="width:202px" %)/rest/trackingType [POST]|(% style="width:126px" %)(((
27 +Insert or update new TrackingType
28 +
29 +
30 +If the trackingType already exists, then it will be updated
31 +)))|(% style="width:250px" %){{code language="json"}}{
32 + "alias":"order",
33 + "env":"iXPath",
34 + "label":{
35 + "fr":"Commande de Merde",
36 + "en":"Order"
37 + },
38 + "dataTypes":[
39 + {
40 + "alias":"orderNumber",
41 + "label":{
42 + "fr":"Numéro de commande",
43 + "en":"Order Number"
44 + },
45 + "type":"NUMBER",
46 + "size":10,
47 + "mandatory":true,
48 + "isList":false
49 + },
50 + {
51 + "alias":"orderLine",
52 + "label":{
53 + "fr":"Ligne de commande",
54 + "en":"Order Lines"
55 + },
56 + "type":"TRACKING",
57 + "trackingType":"orderLine",
58 + "mandatory":true,
59 + "isList":false
60 + }
61 + ]
62 +}{{/code}}|(% style="width:449px" %){{code language="JSON"}}{
36 36   "timestamp": 1620217014704,
37 37   "status": "200",
38 38   "data": [
... ... @@ -52,7 +52,7 @@
52 52   }
53 53   ]
54 54  }{{/code}}
55 -|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
82 +|(% style="width:202px" %)/rest/git/commit [POST]|(% style="width:126px" %)commit changes in files with a message|(% style="width:250px" %){{code language="JSON"}}{
56 56  "files":
57 57  [
58 58  {"fileName" : "newFile.xml"},
... ... @@ -70,23 +70,19 @@
70 70   "data": "this is a commit message"
71 71  }{{/code}}
72 72  )))
73 -|(% style="width:166px" %)(((
100 +|(% style="width:202px" %)(((
74 74  /rest/git/switchComit/{id}
75 75  
76 76  [GET]
77 -)))|(% style="width:238px" %)(((
104 +)))|(% style="width:126px" %)(((
78 78  switch to a certain version and return the history of all commits.
79 79  
80 80  **__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
81 81  
82 82  .../archive/git-{timestamp}
83 -)))|(% style="width:599px" %)(((
84 -the {id} in the URL should be replaced by the id of the wanted commit.
110 +)))|(% style="width:250px" %)(((
111 +
85 85  
86 -eg :
87 -
88 -rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
89 -
90 90  
91 91  )))|(% style="width:449px" %)(((
92 92  {{code language="JSON"}}
... ... @@ -112,9 +112,9 @@
112 112  }
113 113  {{/code}}
114 114  )))
115 -|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
138 +|(% style="width:202px" %)/rest/git/update [GET]|(% style="width:126px" %)(((
116 116  Integrates and pulls changes from a remote repository into the current branch.
117 -)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
140 +)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
118 118  it returns a success message.
119 119  
120 120  eg :
... ... @@ -127,13 +127,13 @@
127 127  }
128 128  {{/code}}
129 129  )))
130 -|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
153 +|(% style="width:202px" %)/rest/environment/init [POST]|(% style="width:126px" %)(((
131 131  Clone a git repository into the directory of the current environment,
132 132  
133 133  if it doesn't exist it creates a new directory and initialize the repo,
134 134  
135 135  if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
136 -)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
159 +)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
137 137  it returns a "success" message :
138 138  
139 139  eg :
... ... @@ -146,7 +146,7 @@
146 146  }
147 147  {{/code}}
148 148  )))
149 -|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
172 +|(% style="width:202px" %)/rest/git/checkout/{branch} [POST]|(% style="width:126px" %)switch to a certain branch|(% style="width:250px" %)(((
150 150  the {branch} must be replaced by the name of the branch destination.
151 151  
152 152  eg : /rest/git/checkout/master
... ... @@ -165,11 +165,11 @@
165 165  }
166 166  {{/code}}
167 167  )))
168 -|(% style="width:166px" %)(((
191 +|(% style="width:202px" %)(((
169 169  /rest/git/newbranch/{branch}
170 170  
171 171  [POST]
172 -)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
195 +)))|(% style="width:126px" %)create and switch to a new branch |(% style="width:250px" %)(((
173 173  the {branch} must be replaced by the name of the branch destination.
174 174  
175 175  eg :
... ... @@ -188,13 +188,7 @@
188 188  }
189 189  {{/code}}
190 190  )))
191 -|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:238px" %)switch the modified file to the initial head version. |(% style="width:599px" %){{code language="JSON"}}{
192 -"files":
193 -[
194 -{"fileName" : "newFile.xml"},
195 -{"fileName" : "/dir/modifiedFile.pdf"}
196 -]
197 -}{{/code}}|(% style="width:449px" %)(((
214 +|(% style="width:202px" %)/rest/git/revert [POST]|(% style="width:126px" %)switch the modified file to the initial head version. |(% style="width:250px" %) |(% style="width:449px" %)(((
198 198  it returns a "success" message.
199 199  
200 200  eg :
TrackingTypes.json
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.aelkari
Size
... ... @@ -1,0 +1,1 @@
1 +4.8 KB
Content
... ... @@ -1,0 +1,151 @@
1 +{
2 + "timestamp": 1637833049208,
3 + "status": "200",
4 + "data": [
5 + {
6 + "trkTypeID": null,
7 + "alias": "orderLine",
8 + "env": "iXPath",
9 + "label": {
10 + "fr": "Commande",
11 + "en": "Order"
12 + },
13 + "dataTypes": [
14 + {
15 + "alias": "orderLineNumber",
16 + "label": {
17 + "fr": "Numéro de commande",
18 + "en": "Order Number"
19 + },
20 + "type": "NUMBER",
21 + "trackingType": null,
22 + "size": 10,
23 + "format": null,
24 + "defaultValue": null,
25 + "mandatory": true,
26 + "list": false
27 + },
28 + {
29 + "alias": "Column1",
30 + "label": {
31 + "fr": "Column 1",
32 + "en": "C1"
33 + },
34 + "type": "TRACKING",
35 + "trackingType": "comment",
36 + "size": null,
37 + "format": null,
38 + "defaultValue": null,
39 + "mandatory": false,
40 + "list": false
41 + }
42 + ]
43 + },
44 + {
45 + "trkTypeID": null,
46 + "alias": "order",
47 + "env": "iXPath",
48 + "label": {
49 + "fr": "Commande",
50 + "en": "Order"
51 + },
52 + "dataTypes": [
53 + {
54 + "alias": "orderNumber",
55 + "label": {
56 + "fr": "Numéro de commande",
57 + "en": "Order Number"
58 + },
59 + "type": "NUMBER",
60 + "trackingType": null,
61 + "size": 10,
62 + "format": null,
63 + "defaultValue": null,
64 + "mandatory": true,
65 + "list": false
66 + },
67 + {
68 + "alias": "creationDate",
69 + "label": {
70 + "fr": "Date de création",
71 + "en": "Creation Date"
72 + },
73 + "type": "DATE",
74 + "trackingType": null,
75 + "size": null,
76 + "format": "YYYY/MM/DD",
77 + "defaultValue": null,
78 + "mandatory": false,
79 + "list": false
80 + },
81 + {
82 + "alias": "buyerCode",
83 + "label": {
84 + "fr": "Code fournisseur",
85 + "en": "Code fournisseur"
86 + },
87 + "type": "STRING",
88 + "trackingType": null,
89 + "size": null,
90 + "format": null,
91 + "defaultValue": "01",
92 + "mandatory": false,
93 + "list": false
94 + },
95 + {
96 + "alias": "orderLine",
97 + "label": {
98 + "fr": "Ligne de commande",
99 + "en": "Order Lines"
100 + },
101 + "type": "TRACKING",
102 + "trackingType": "orderLine",
103 + "size": null,
104 + "format": null,
105 + "defaultValue": null,
106 + "mandatory": true,
107 + "list": false
108 + }
109 + ]
110 + },
111 + {
112 + "trkTypeID": null,
113 + "alias": "comment",
114 + "env": "iXPath",
115 + "label": {
116 + "fr": "Commande",
117 + "en": "Order"
118 + },
119 + "dataTypes": [
120 + {
121 + "alias": "description1",
122 + "label": {
123 + "fr": "Comment 1",
124 + "en": "Order Number"
125 + },
126 + "type": "STRING",
127 + "trackingType": null,
128 + "size": 10,
129 + "format": null,
130 + "defaultValue": null,
131 + "mandatory": false,
132 + "list": false
133 + },
134 + {
135 + "alias": "description2",
136 + "label": {
137 + "fr": "Column 1",
138 + "en": "C1"
139 + },
140 + "type": "STRING",
141 + "trackingType": null,
142 + "size": null,
143 + "format": null,
144 + "defaultValue": null,
145 + "mandatory": false,
146 + "list": false
147 + }
148 + ]
149 + }
150 + ]
151 +}
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian