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 < 5.5 >
edited by Outhman Moustaghfir
on 2021/05/05 16:45
>
Change comment: (Autosaved)

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Tracking Type
1 +GIT endpoints
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.aelkari
1 +XWiki.omoustaghfir
Content
... ... @@ -4,52 +4,26 @@
4 4  
5 5  = Introduction =
6 6  
7 -We will go through all endpoints needed to manage the Tracking type entity.
7 +Git endpoints take advantage of all git commands known and needed to create versions of files.
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).//__
12 -
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" %)(((
16 -/rest/trackingType [GET]
17 -
18 -
19 -hedear : Authorization + env => Mandatory
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" %)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"}}{
11 +|(% style="width:166px" %)**URL [method]**|(% style="width:189px" %)**Description**|(% style="width:383px" %)**Input example**|(% style="width:449px" %)**Output example**
12 +|(% style="width:166px" %)/rest/git/getstatus [GET]|(% style="width:189px" %)get all files that have been modified or untracked|(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
13 + "timestamp": 1620216790744,
14 + "status": "200",
15 + "data": [
16 + {
17 + "fileName": "FileToF.txt",
18 + "status": "Untracked"
19 + },
20 + {
21 + "fileName": "newfile.txt",
22 + "status": "Modified"
23 + }
24 + ]
25 +}{{/code}}
26 +|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:189px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:383px" %)(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"}}{
46 +|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{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" %)(((
64 +|(% style="width:166px" %)(((
91 91  /rest/git/switchComit/{id}
92 92  
93 93  [GET]
94 -)))|(% style="width:126px" %)(((
68 +)))|(% style="width:189px" %)(((
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 -
74 +)))|(% style="width:383px" %)(((
75 +the {id} in the URL should be replaced by the id of the wanted commit.
102 102  
77 +eg :
78 +
79 +rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
80 +
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" %)(((
106 +|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
129 129  Integrates and pulls changes from a remote repository into the current branch.
130 -)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
108 +)))|(% style="width:383px" %)(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" %)(((
121 +|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
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" %)(((
127 +)))|(% style="width:383px" %)(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" %)(((
140 +|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:189px" %)switch to a certain branch|(% style="width:383px" %)(((
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" %)(((
159 +|(% 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" %)(((
163 +)))|(% style="width:189px" %)create and switch to a new branch |(% style="width:383px" %)(((
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" %)(((
182 +|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:189px" %)switch the modified file to the initial head version. |(% style="width:383px" %){{code language="JSON"}}{
183 +"files":
184 +[
185 +{"fileName" : "newFile.xml"},
186 +{"fileName" : "/dir/modifiedFile.pdf"}
187 +]
188 +}{{/code}}|(% style="width:449px" %)(((
205 205  it returns a "success" message.
206 206  
207 207  eg :
TrackingTypes.json
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.aelkari
Size
... ... @@ -1,1 +1,0 @@
1 -4.8 KB
Content
... ... @@ -1,151 +1,0 @@
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