Summary

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

Details

Page properties

Content

...	...	@@ -8,58 +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		-)))|(% 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"}}{
	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"}}{
63	63	"timestamp": 1620217014704,
64	64	"status": "200",
65	65	"data": [
...	...	@@ -79,7 +79,7 @@
79	79	}
80	80	]
81	81	}{{/code}}
82		-|(% 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"}}{
83	83	"files":
84	84	[
85	85	{"fileName" : "newFile.xml"},
...	...	@@ -97,19 +97,23 @@
97	97	"data": "this is a commit message"
98	98	}{{/code}}
99	99	)))
100		-|(% style="width:202px" %)(((
	77	+|(% style="width:166px" %)(((
101	101	/rest/git/switchComit/{id}
102	102
103	103	[GET]
104		-)))|(% style="width:126px" %)(((
	81	+)))|(% style="width:238px" %)(((
105	105	switch to a certain version and return the history of all commits.
106	106
107	107	**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
108	108
109	109	.../archive/git-{timestamp}
110		-)))|(% style="width:250px" %)(((
111		-
	87	+)))|(% style="width:599px" %)(((
	88	+the {id} in the URL should be replaced by the id of the wanted commit.
112	112
	90	+eg :
	91	+
	92	+rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
	93	+
113	113
114	114	)))|(% style="width:449px" %)(((
115	115	{{code language="JSON"}}
...	...	@@ -135,9 +135,9 @@
135	135	}
136	136	{{/code}}
137	137	)))
138		-|(% style="width:202px" %)/rest/git/update [GET]|(% style="width:126px" %)(((
	119	+|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
139	139	Integrates and pulls changes from a remote repository into the current branch.
140		-)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
	121	+)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
141	141	it returns a success message.
142	142
143	143	eg :
...	...	@@ -150,13 +150,13 @@
150	150	}
151	151	{{/code}}
152	152	)))
153		-|(% style="width:202px" %)/rest/environment/init [POST]|(% style="width:126px" %)(((
	134	+|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
154	154	Clone a git repository into the directory of the current environment,
155	155
156	156	if it doesn't exist it creates a new directory and initialize the repo,
157	157
158	158	if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
159		-)))|(% style="width:250px" %)(no input required)|(% style="width:449px" %)(((
	140	+)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
160	160	it returns a "success" message :
161	161
162	162	eg :
...	...	@@ -169,7 +169,7 @@
169	169	}
170	170	{{/code}}
171	171	)))
172		-|(% 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" %)(((
173	173	the {branch} must be replaced by the name of the branch destination.
174	174
175	175	eg : /rest/git/checkout/master
...	...	@@ -188,11 +188,11 @@
188	188	}
189	189	{{/code}}
190	190	)))
191		-|(% style="width:202px" %)(((
	172	+|(% style="width:166px" %)(((
192	192	/rest/git/newbranch/{branch}
193	193
194	194	[POST]
195		-)))|(% 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" %)(((
196	196	the {branch} must be replaced by the name of the branch destination.
197	197
198	198	eg :
...	...	@@ -211,7 +211,13 @@
211	211	}
212	212	{{/code}}
213	213	)))
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" %)(((
	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" %)(((
215	215	it returns a "success" message.
216	216
217	217	eg :