Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -8,63 +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" %)(((
27		-Insert or update new TrackingType
28		-
29		-
30		-If the trackingType already exists, then it will be updated.
31		-
32		-
33		-**PS1 :** iXPath will take in consideration the environment given at the header while inserting and updating.
34		-
35		-
36		-**PS2 :** iXPath v3 is case sensitive.
37		-)))|(% style="width:250px" %){{code language="json"}}{
38		- "alias":"order",
39		- "label":{
40		- "fr":"Commande",
41		- "en":"Order"
42		- },
43		- "dataTypes":[
44		- {
45		- "alias":"orderNumber",
46		- "label":{
47		- "fr":"Numéro de commande",
48		- "en":"Order Number"
49		- },
50		- "type":"NUMBER",
51		- "size":10,
52		- "mandatory":true,
53		- "isList":false
54		- },
55		- {
56		- "alias":"orderLine",
57		- "label":{
58		- "fr":"Ligne de commande",
59		- "en":"Order Lines"
60		- },
61		- "type":"TRACKING",
62		- "trackingType":"orderLine",
63		- "mandatory":true,
64		- "isList":false
65		- }
66		- ]
67		-}{{/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"}}{
68	68	"timestamp": 1620217014704,
69	69	"status": "200",
70	70	"data": [
...	...	@@ -84,7 +84,7 @@
84	84	}
85	85	]
86	86	}{{/code}}
87		-|(% 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"}}{
88	88	"files":
89	89	[
90	90	{"fileName" : "newFile.xml"},
...	...	@@ -102,19 +102,23 @@
102	102	"data": "this is a commit message"
103	103	}{{/code}}
104	104	)))
105		-|(% style="width:202px" %)(((
	77	+|(% style="width:166px" %)(((
106	106	/rest/git/switchComit/{id}
107	107
108	108	[GET]
109		-)))|(% style="width:126px" %)(((
	81	+)))|(% style="width:238px" %)(((
110	110	switch to a certain version and return the history of all commits.
111	111
112	112	**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
113	113
114	114	.../archive/git-{timestamp}
115		-)))|(% style="width:250px" %)(((
116		-
	87	+)))|(% style="width:599px" %)(((
	88	+the {id} in the URL should be replaced by the id of the wanted commit.
117	117
	90	+eg :
	91	+
	92	+rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
	93	+
118	118
119	119	)))|(% style="width:449px" %)(((
120	120	{{code language="JSON"}}
...	...	@@ -140,9 +140,9 @@
140	140	}
141	141	{{/code}}
142	142	)))
143		-|(% style="width:202px" %)/rest/git/update [GET]|(% style="width:126px" %)(((
	119	+|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
144	144	Integrates and pulls changes from a remote repository into the current branch.
145		-)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
	121	+)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
146	146	it returns a success message.
147	147
148	148	eg :
...	...	@@ -155,13 +155,13 @@
155	155	}
156	156	{{/code}}
157	157	)))
158		-|(% style="width:202px" %)/rest/environment/init [POST]|(% style="width:126px" %)(((
	134	+|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
159	159	Clone a git repository into the directory of the current environment,
160	160
161	161	if it doesn't exist it creates a new directory and initialize the repo,
162	162
163	163	if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
164		-)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
	140	+)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
165	165	it returns a "success" message :
166	166
167	167	eg :
...	...	@@ -174,7 +174,7 @@
174	174	}
175	175	{{/code}}
176	176	)))
177		-|(% 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" %)(((
178	178	the {branch} must be replaced by the name of the branch destination.
179	179
180	180	eg : /rest/git/checkout/master
...	...	@@ -193,11 +193,11 @@
193	193	}
194	194	{{/code}}
195	195	)))
196		-|(% style="width:202px" %)(((
	172	+|(% style="width:166px" %)(((
197	197	/rest/git/newbranch/{branch}
198	198
199	199	[POST]
200		-)))|(% 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" %)(((
201	201	the {branch} must be replaced by the name of the branch destination.
202	202
203	203	eg :
...	...	@@ -216,7 +216,13 @@
216	216	}
217	217	{{/code}}
218	218	)))
219		-|(% 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" %)(((
220	220	it returns a "success" message.
221	221
222	222	eg :