Changes for page Tracking Type

Last modified by Achraf El Kari on 2022/06/13 13:17
<
From version < 9.2 >
edited by Achraf El Kari
on 2021/11/25 11:26
To version < 9.1 >
edited by Achraf El Kari
on 2021/11/25 10:38
>
Change comment: Uploaded new attachment "TrackingTypes.json", version {1}

Summary

Details

Page properties
Content
... ... @@ -8,48 +8,35 @@
8 8  
9 9  = Endpoints =
10 10  
11 -**PS:** __//For all those endpoints, the env params are mandatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
11 +**PS :** __//For all those endpoints, the env params is andatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
12 12  
13 13  
14 -|(% style="width:202px" %)**URL [method]**|(% style="width:126px" %)**Description**|(% style="width:250px" %)**Input example**|(% style="width:449px" %)**Output example**
15 -|(% style="width:202px" %)(((
14 +|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
15 +|(% style="width:166px" %)(((
16 16  /rest/trackingType [GET]
17 17  
18 18  
19 19  hedear : Authorization + env => Mandatory
20 20  
21 -)))|(% style="width:126px" %)(((
22 -get **all **tracking Types of the giving environment ==>
21 +)))|(% style="width:238px" %)(((
22 +get **all **tracking Type of the giving environment ==>
23 23  
24 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" %)Insert or update new TrackingType|(% style="width:250px" %){{code language="json"}}{
27 -  "alias": "order",
28 -  "env": "iXPath",
29 -  "label": {
30 -    "fr": "Commande de Merde",
31 -    "en": "Order"
32 -  },
33 -  "dataTypes": [
34 -    {
35 -      "alias": "orderNumber",
36 -      "label": {
37 -        "fr": "Numéro de commande",
38 -        "en": "Order Number"
39 -      },
40 -    {
41 -      "alias": "orderLine",
42 -      "label": {
43 -        "fr": "Ligne de commande",
44 -        "en": "Order Lines"
45 -      },
46 -      "type": "TRACKING",
47 -      "trackingType": "orderLine",
48 -      "mandatory": true,
49 -      "isList": false
50 -    }
51 -  ]
52 -}{{/code}}|(% style="width:449px" %){{code language="JSON"}}{
25 +)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
26 + "timestamp": 1620216790744,
27 + "status": "200",
28 + "data": [
29 + {
30 + "fileName": "FileToF.txt",
31 + "status": "Untracked"
32 + },
33 + {
34 + "fileName": "newfile.txt",
35 + "status": "Modified"
36 + }
37 + ]
38 +}{{/code}}
39 +|(% 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"}}{
53 53   "timestamp": 1620217014704,
54 54   "status": "200",
55 55   "data": [
... ... @@ -69,7 +69,7 @@
69 69   }
70 70   ]
71 71  }{{/code}}
72 -|(% style="width:202px" %)/rest/git/commit [POST]|(% style="width:126px" %)commit changes in files with a message|(% style="width:250px" %){{code language="JSON"}}{
59 +|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
73 73  "files":
74 74  [
75 75  {"fileName" : "newFile.xml"},
... ... @@ -87,19 +87,23 @@
87 87   "data": "this is a commit message"
88 88  }{{/code}}
89 89  )))
90 -|(% style="width:202px" %)(((
77 +|(% style="width:166px" %)(((
91 91  /rest/git/switchComit/{id}
92 92  
93 93  [GET]
94 -)))|(% style="width:126px" %)(((
81 +)))|(% style="width:238px" %)(((
95 95  switch to a certain version and return the history of all commits.
96 96  
97 97  **__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
98 98  
99 99  .../archive/git-{timestamp}
100 -)))|(% style="width:250px" %)(((
101 -
87 +)))|(% style="width:599px" %)(((
88 +the {id} in the URL should be replaced by the id of the wanted commit.
102 102  
90 +eg :
91 +
92 +rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
93 +
103 103  
104 104  )))|(% style="width:449px" %)(((
105 105  {{code language="JSON"}}
... ... @@ -125,9 +125,9 @@
125 125  }
126 126  {{/code}}
127 127  )))
128 -|(% style="width:202px" %)/rest/git/update [GET]|(% style="width:126px" %)(((
119 +|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
129 129  Integrates and pulls changes from a remote repository into the current branch.
130 -)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
121 +)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
131 131  it returns a success message.
132 132  
133 133  eg :
... ... @@ -140,13 +140,13 @@
140 140  }
141 141  {{/code}}
142 142  )))
143 -|(% style="width:202px" %)/rest/environment/init [POST]|(% style="width:126px" %)(((
134 +|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
144 144  Clone a git repository into the directory of the current environment,
145 145  
146 146  if it doesn't exist it creates a new directory and initialize the repo,
147 147  
148 148  if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
149 -)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
140 +)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
150 150  it returns a "success" message :
151 151  
152 152  eg :
... ... @@ -159,7 +159,7 @@
159 159  }
160 160  {{/code}}
161 161  )))
162 -|(% style="width:202px" %)/rest/git/checkout/{branch} [POST]|(% style="width:126px" %)switch to a certain branch|(% style="width:250px" %)(((
153 +|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
163 163  the {branch} must be replaced by the name of the branch destination.
164 164  
165 165  eg : /rest/git/checkout/master
... ... @@ -178,11 +178,11 @@
178 178  }
179 179  {{/code}}
180 180  )))
181 -|(% style="width:202px" %)(((
172 +|(% style="width:166px" %)(((
182 182  /rest/git/newbranch/{branch}
183 183  
184 184  [POST]
185 -)))|(% style="width:126px" %)create and switch to a new branch |(% style="width:250px" %)(((
176 +)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
186 186  the {branch} must be replaced by the name of the branch destination.
187 187  
188 188  eg :
... ... @@ -201,7 +201,13 @@
201 201  }
202 202  {{/code}}
203 203  )))
204 -|(% 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" %)(((
195 +|(% 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"}}{
196 +"files":
197 +[
198 +{"fileName" : "newFile.xml"},
199 +{"fileName" : "/dir/modifiedFile.pdf"}
200 +]
201 +}{{/code}}|(% style="width:449px" %)(((
205 205  it returns a "success" message.
206 206  
207 207  eg :
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian