1. Add Project
This Api is used to add a new project.
Mandatory Field: description, projectName, defaultProj.
|
Method Name |
URL |
Parameters |
|---|---|---|
|
addProject |
/api/addproject |
Request Body
{
"defaultProj": true,
"description": "string",
"projectName": "string",
"projectowner": "string"
}
Sample Request Body
{
"defaultProj": true,
"description": "work",
"projectName": "computer",
"projectowner": "admin"
}
Sample Response Body
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"InsertProject": {
"project": {
"projectId": 1027,
"projectName": "computer",
"description": "work",
"shareContent": 0,
"defaultProj": 1,
"createdBy": "admin",
"createdDate": "2022-04-12 13:17:53.0",
"lastModDate": "2022-04-12 13:17:53.0",
"updatedBy": "admin",
"startIndex": 0,
"endIndex": 0,
"totaltasks": 0,
"projectstatus": "To Do",
"lastactivity": "2022-04-12 13:17:53.0",
"completedon": "",
"donetasks": 0,
"progress": 0,
"projectowner": "admin"
},
"status": true
}
}
}
Sample Request Body
{
"defaultProj": false,
"description": "work",
"projectName": "computer1",
"projectowner": "admin"
}
Sample Response Body
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"InsertProject": {
"project": {
"projectId": 1028,
"projectName": "computer1",
"description": "work",
"shareContent": 0,
"defaultProj": 0,
"createdBy": "admin",
"createdDate": "2022-04-12 13:20:07.0",
"lastModDate": "2022-04-12 13:20:07.0",
"updatedBy": "admin",
"startIndex": 0,
"endIndex": 0,
"totaltasks": 0,
"projectstatus": "To Do",
"lastactivity": "2022-04-12 13:20:07.0",
"completedon": "",
"donetasks": 0,
"progress": 0,
"projectowner": "admin"
},
"status": true
}
}
}
2. Delete Project
This Api is used to delete the project by using the projectName.
Mandatory Field: projectName.
|
Method Name |
URL |
Parameters |
|
delete |
/api/delete |
projectName |
Sample Request
projectName: education
Sample Response Body
{
"status": true,
"statusCode": "",
"statusMsg": "Project deleted with [projectName] : education",
"response": {}
}
If project doesn’t exit:
Sample Request
projectName: education1
Sample Response Body
{
"status": false,
"statusCode": "",
"statusMsg": "Project not found with [projectName] : education1",
"response": {}
}
3. Get Associated Object By Project Name
This Api is used to get all the associated objects of a project by using projectName.
Mandatory Field: objectType, projectName
|
Method Name |
URL |
Parameters |
|
getAssociatedObjectByProjectName. |
/api/getAssociatedObjectByProjectName |
EndIndex, ObjectType, projectName, StartIndex. |
Allowed values for objectType:oecolumn, oetable, oefile, oeschema, oefilecolumn, oestory, chartchild.
If no startIndex and endIndex is provided, it returns all the associated objects.
Request Body
“endIndex”: 0,
“objectType”: “string”
“projectName”: “string”
“startIndex”: 0
Sample Request Body
“endIndex”: 0
“objectType”:”oefilecolumn”
“projectName”:”Education”
“startIndex”: 0
Sample Response Body
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"associatedObjects": [
{
"filename": "Hospital_Information.csv",
"columnname": "Address",
"filecolumnid": 1100,
"fileid": 1005,
"filetype": "CSV",
"location": "/",
"notes": "",
"filefolder": "/",
"connectioninfoid": 1001,
"wikitext": null,
"TAGNAME": "Education",
"connection": "NFS"
}
]
}
}
4. GetProjectByName
This Api is used to get the Project by using the project name.
Mandatory Field: projectName.
|
Method Name |
URL |
Parameters |
|
getProjectByName |
/api/getProjectByName |
projectName |
Sample Request Body
projectName:Education
Sample Response Body
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"projectName": {
"projectId": 1000,
"projectName": "Education",
"description": "Education Title",
"shareContent": 0,
"defaultProj": 0,
"createdBy": "nadiya",
"createdDate": "2022-02-09 12:08:38.0",
"lastModDate": "2022-02-18 05:46:42.0",
"updatedBy": "nadiya",
"startIndex": 0,
"endIndex": 0,
"totaltasks": 23,
"projectstatus": null,
"lastactivity": null,
"completedon": null,
"donetasks": 0,
"progress": 0,
"projectowner": "avinash"
}
}
}
5. Get Project List
This Api is used to get all the available projects list.
|
Method Name |
URL |
Parameters |
|
getProjectList |
/api/getProjectList |
Sample Response Body
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"projectList": [
{
"projectId": 1000,
"projectName": "Education",
"description": "Education Title",
"shareContent": 0,
"defaultProj": 0,
"createdBy": "nadiya",
"createdDate": "2022-02-09 12:08:38.0",
"lastModDate": "2022-02-18 05:46:42.0",
"updatedBy": "nadiya",
"startIndex": 0,
"endIndex": 0,
"totaltasks": 23,
"projectstatus": null,
"lastactivity": null,
"completedon": null,
"donetasks": 0,
"progress": 0,
"projectowner": "avinash"
},
{
"projectId": 1001,
"projectName": "Testing",
"description": "Manual",
"shareContent": 0,
"defaultProj": 0,
"createdBy": "fazlullah",
"createdDate": "2022-02-09 12:43:39.0",
"lastModDate": "2022-02-16 05:20:04.0",
"updatedBy": "fazlullah",
"startIndex": 0,
"endIndex": 0,
"totaltasks": 12,
"projectstatus": null,
"lastactivity": null,
"completedon": null,
"donetasks": 0,
"progress": 0,
"projectowner": "nadiya"
},
{
"projectId": 1002,
"projectName": "Development",
"description": "Enhancement",
"shareContent": 0,
"defaultProj": 0,
"createdBy": "fazlullah",
"createdDate": "2022-02-10 10:44:26.0",
"lastModDate": "2022-02-16 13:07:06.0",
"updatedBy": "fazlullah",
"startIndex": 0,
"endIndex": 0,
"totaltasks": 11,
"projectstatus": null,
"lastactivity": null,
"completedon": null,
"donetasks": 0,
"progress": 0,
"projectowner": "admin"
}
]
}