Changes for page Tracking Type

Last modified by Achraf El Kari on 2022/06/13 13:17

From version < 7.4 >

edited by Achraf El Kari
on 2021/11/23 11:45

To version 1.1 >

edited by Achraf El Kari
on 2021/05/05 13:39

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Tracking Type
++GIT endpoints

Content

@@ -2,230 +2,31 @@
  {{toc/}}
  {{/box}}
--= Introduction =
++= Paragraph 1 =
--We will go through all endpoints needed to manage the Tracking type entity.
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
--= Endpoints =
++== Sub-paragraph ==
--**PS :** __//For all those endpoints, the env params is andatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
++== Sub-paragraph ==
--|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
--|(% style="width:166px" %)(((
--/rest/trackingType [GET]
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
++=== Sub-sub paragraph ===
--hedear : Authorization + env => Mandatory
--
--)))|(% style="width:238px" %)(((
--get **all **tracking Type of the giving environment ==>
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
--order, orderLine...
--)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
--    "timestamp": 1620216790744,
--    "status": "200",
--    "data": [
--        {
--            "fileName": "FileToF.txt",
--            "status": "Untracked"
--        },
--        {
--            "fileName": "newfile.txt",
--            "status": "Modified"
--        }
--    ]
--}{{/code}}
--|(% 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"}}{
--    "timestamp": 1620217014704,
--    "status": "200",
--    "data": [
--        {
--            "date": "Tue May 04 16:37:49 GMT+01:00 2021",
--            "current": "true",
--            "author": "person1232",
--            "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
--            "message": "version 2"
--        },
--        {
--            "date": "Tue May 04 13:28:12 GMT+01:00 2021",
--            "current": "false",
--            "author": "person1",
--            "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
--            "message": "version 1"
--        }
--    ]
--}{{/code}}
--|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
--"files":
--[
--{"fileName" : "newFile.xml"},
--{"fileName" : "/dir/modifiedFile.pdf"}
--],
--"message": "this is a commit message"
--}{{/code}}|(% style="width:449px" %)(((
--it returns a String with the commit message meaning that the commit has passed successfully.
--eg :
++= Paragraph 2 =
--{{code language="JSON"}}{
--    "timestamp": 1620217700570,
--    "status": "200",
--    "data": "this is a commit message"
--}{{/code}}
--)))
--|(% style="width:166px" %)(((
--/rest/git/switchComit/{id}
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
--[GET]
--)))|(% style="width:238px" %)(((
--switch to a certain version and return the history of all commits.
++== Sub-paragraph ==
--**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
--.../archive/git-{timestamp}
--)))|(% style="width:599px" %)(((
--the {id} in the URL should be replaced by the id of the wanted commit.
++== Sub-paragraph ==
--eg :
--
--rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
--
--
--)))|(% style="width:449px" %)(((
--{{code language="JSON"}}
--{
--    "timestamp": 1620217014704,
--    "status": "200",
--    "data": [
--        {
--            "date": "Tue May 04 16:37:49 GMT+01:00 2021",
--            "current": "false",
--            "author": "person1232",
--            "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
--            "message": "version 2"
--        },
--        {
--            "date": "Tue May 04 13:28:12 GMT+01:00 2021",
--            "current": "true",
--            "author": "person1",
--            "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
--            "message": "version 1"
--        }
--    ]
--}
--{{/code}}
--)))
--|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
--Integrates and pulls changes from a remote repository into the current branch.
--)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
--it returns a success message.
--
--eg :
--
--{{code language="JSON"}}
--{
--    "timestamp": 1620219625637,
--    "status": "200",
--    "data": "branch is now updated"
--}
--{{/code}}
--)))
--|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
--Clone a git repository into the directory of the current environment,
--
--if it doesn't exist it creates a new directory and initialize the repo,
--
--if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
--)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
--it returns a "success" message :
--
--eg :
--
--{{code language="JSON"}}
--{
--    "timestamp": 1620229625932,
--    "status": "200",
--    "data": "Repository initialized successfully !"
--}
--{{/code}}
--)))
--|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
--the {branch} must be replaced by the name of the branch destination.
--
--eg : /rest/git/checkout/master
--
--    /rest/git/checkout/develop
--)))|(% style="width:449px" %)(((
--it returns a "success" message of checkout branch.
--
--eg :
--
--{{code language="JSON"}}
--{
--    "timestamp": 1620229625932,
--    "status": "200",
--    "data": "switched to branch : master"
--}
--{{/code}}
--)))
--|(% style="width:166px" %)(((
--/rest/git/newbranch/{branch}
--
--[POST]
--)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
--the {branch} must be replaced by the name of the branch destination.
--
--eg :
--
--    /rest/git/checkout/newBranch
--)))|(% style="width:449px" %)(((
--it returns a "success" message of the branch creation.
--
--eg :
--
--{{code language="JSON"}}
--{
--    "timestamp": 1620229625932,
--    "status": "200",
--    "data": "new branch has been created : newBranch"
--}
--{{/code}}
--)))
--|(% 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"}}{
--"files":
--[
--{"fileName" : "newFile.xml"},
--{"fileName" : "/dir/modifiedFile.pdf"}
--]
--}{{/code}}|(% style="width:449px" %)(((
--it returns a "success" message.
--
--eg :
--
--{{code language="JSON"}}
--{
--    "timestamp": 1620229625932,
--    "status": "200",
--    "data": "the selected files has been synchronized to HEAD successfully !"
--}
--{{/code}}
--)))
--
--= Errors =
--
--below, you can find an example of technical and functional errors :
--
--{{code language="JSON"}}
--{
--    "timestamp": 1620221672951,
--    "status": "500",
--    "error": "JSON file is not valid",
--    "thechnicalError": "JSONObject[\"fileName\"] not found."
--}
--{{/code}}
--
--the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
--
--
--==  ==
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Changes for page Tracking Type

Summary

Details

Navigation

Applications