|
|
Virima API Specification - ProjectService Services
The requests documented in this section are directed to
ProjectService resources, which represent .
addProject POST Interface
Method: POST Relative URL: project/add Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| project | Project | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ADDPROJECT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllProjectName GET Interface
Method: GET Relative URL: project/get Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| projectList | ValueList | |
Example Request: Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":1979453866,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
getAllProjectTemplates GET Interface
Method: GET Relative URL: project/get-proj-template Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| projectList | ValueList | |
Example Request: Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":277023993,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
addTaskToProject POST Interface
Method: POST Relative URL: project/add-project-task/project-id/task-id/action Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| projectTasks | ArrayOfProjectTasks | |
Response Structure: | Field Name | Type | Description |
|---|
| response | ArrayOfProjectTasks | |
Example Request: ADDTASKTOPROJECT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"responseList":[
{
"task":"?",
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"status":"?",
"taskType":"?",
"seqNumber":?,
"rollUp":?,
"percentageComplete":?,
"constraintType":"?",
"duration":?,
"position":?,
"archive":?,
"compliance":?,
"notes":?,
"validationError":?,
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"mandatory":?,
"gateType":"?",
"review":"?",
"totalTimeSpent":?,
"parentPhase":?,
"ipAddresses":?,
"command":?
} ],
"predecessorsTaskList":[
{
"taskId":?,
"predecessorId":?
} ],
"assigneeTaskList":[
{
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ],
"project": {
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
}
Example Response: {
"id":2147483647,
"responseList":[
{
"id":2147483647,
"task":"?",
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"status":"?",
"taskType":"?",
"seqNumber":?,
"rollUp":?,
"percentageComplete":?,
"constraintType":"?",
"duration":?,
"position":?,
"archive":?,
"compliance":?,
"notes":?,
"validationError":?,
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":207197356,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"mandatory":?,
"gateType":"?",
"review":"?",
"totalTimeSpent":?,
"parentPhase":?,
"ipAddresses":?,
"command":?
} ],
"predecessorsTaskList":[
{
"id":2147483647,
"taskId":?,
"predecessorId":?
} ],
"assigneeTaskList":[
{
"id":2147483647,
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ],
"project": {
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":42580775,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":1705282928,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
}
updateSingleProjectTask POST Interface
Method: POST Relative URL: project/update-single-project-task/project-id/task-id/action Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| projectTask | SingleTaskPojo | |
Response Structure: | Field Name | Type | Description |
|---|
| response | ArrayOfProjectTasks | |
Example Request: UPDATESINGLEPROJECTTASK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"task": {
"task":"?",
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"status":"?",
"taskType":"?",
"seqNumber":?,
"rollUp":?,
"percentageComplete":?,
"constraintType":"?",
"duration":?,
"position":?,
"archive":?,
"compliance":?,
"notes":?,
"validationError":?,
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"mandatory":?,
"gateType":"?",
"review":"?",
"totalTimeSpent":?,
"parentPhase":?,
"ipAddresses":?,
"command":?
},
"predecessorsTaskList":[
{
"taskId":?,
"predecessorId":?
} ],
"assigneeTaskList":[
{
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ]
}
Example Response: {
"id":2147483647,
"responseList":[
{
"id":18292640,
"task":"?",
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"status":"?",
"taskType":"?",
"seqNumber":?,
"rollUp":?,
"percentageComplete":?,
"constraintType":"?",
"duration":?,
"position":?,
"archive":?,
"compliance":?,
"notes":?,
"validationError":?,
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":456449888,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"mandatory":?,
"gateType":"?",
"review":"?",
"totalTimeSpent":?,
"parentPhase":?,
"ipAddresses":?,
"command":?
} ],
"predecessorsTaskList":[
{
"id":2147483647,
"taskId":?,
"predecessorId":?
} ],
"assigneeTaskList":[
{
"id":238567126,
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ],
"project": {
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
}
cloneProject POST Interface
Method: POST Relative URL: project/clone-project Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| cloneProjectData | CloneProject | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: CLONEPROJECT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"name":"?",
"duration":?,
"templateId":?,
"validationError":?
}
Example Response: {
"id":894857730,
"response":"?"
}
saveProjectAsTemplate POST Interface
Method: POST Relative URL: project/clone-project-template Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| cloneProjectData | TemplatePojo | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: SAVEPROJECTASTEMPLATE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"projectId":?,
"templateName":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllProject POST Interface
getAllRiskRecords(POST) is called when the application needs to get all the risk Records.
Method: POST Relative URL: project/get-all/page-number/number Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| filterInput | FilterInput | |
Response Structure: | Field Name | Type | Description |
|---|
| arrayOfProject | ArrayOfProject | |
Example Request: GETALLPROJECT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"module":"?",
"className":"?",
"dbClassName":"?",
"isDashboard":?,
"snKey":"?",
"snValue":"?",
"mainTabSubListSubTab":"?",
"importType":"?",
"sort": {
"id":2147483647,
"sortKey":"?",
"sortOrder":"?",
"propertyName":"?",
"mapProperty":?
},
"filters":[
{
"id":2147483647,
"display":"?",
"filterKey":"?",
"value1":"?",
"value2":"?",
"operator":"?",
"dbPropertyType":"?",
"mapProperty":?
} ]
}
Example Response: {
"id":2147483647,
"totalResults":?,
"filterRuleList":[
{
"id":2147483647,
"filterKey":"?",
"filterValue":"?",
"operatorDisplayName":"?"
} ],
"responseList":[
{
"id":1849758573,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":271115277,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
getProjectTasks GET Interface
Method: GET Relative URL: project/get-project-task/project-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | ArrayOfProjectTasks | |
Example Request: Example Response: {
"id":2147483647,
"responseList":[
{
"id":2147483647,
"task":"?",
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"status":"?",
"taskType":"?",
"seqNumber":?,
"rollUp":?,
"percentageComplete":?,
"constraintType":"?",
"duration":?,
"position":?,
"archive":?,
"compliance":?,
"notes":?,
"validationError":?,
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"mandatory":?,
"gateType":"?",
"review":"?",
"totalTimeSpent":?,
"parentPhase":?,
"ipAddresses":?,
"command":?
} ],
"predecessorsTaskList":[
{
"id":2147483647,
"taskId":?,
"predecessorId":?
} ],
"assigneeTaskList":[
{
"id":2147483647,
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ],
"project": {
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
}
getAllProjectNameBySearch POST Interface
Method: POST Relative URL: project/get-search-projects Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| stringinput | StringInput | |
Response Structure: | Field Name | Type | Description |
|---|
| projectList | ValueList | |
Example Request: GETALLPROJECTNAMEBYSEARCH
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"bluePrintId":?,
"searchkey":"?",
"searchField":"?",
"ignoreIds":"?",
"rootCauseCI":?,
"extraInfo":"?",
"myCis":?,
"ownerName":"?"
}
Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":105315417,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
getAllProjectTemplatesDetails POST Interface
getAllRiskRecords(POST) is called when the application needs to get all the risk Records.
Method: POST Relative URL: project/get-proj-template-details/page-number/number Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| filterInput | FilterInput | |
Response Structure: | Field Name | Type | Description |
|---|
| arrayOfProject | ArrayOfProject | |
Example Request: GETALLPROJECTTEMPLATESDETAILS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"module":"?",
"className":"?",
"dbClassName":"?",
"isDashboard":?,
"snKey":"?",
"snValue":"?",
"mainTabSubListSubTab":"?",
"importType":"?",
"sort": {
"id":2147483647,
"sortKey":"?",
"sortOrder":"?",
"propertyName":"?",
"mapProperty":?
},
"filters":[
{
"id":2147483647,
"display":"?",
"filterKey":"?",
"value1":"?",
"value2":"?",
"operator":"?",
"dbPropertyType":"?",
"mapProperty":?
} ]
}
Example Response: {
"id":2147483647,
"totalResults":?,
"filterRuleList":[
{
"id":2147483647,
"filterKey":"?",
"filterValue":"?",
"operatorDisplayName":"?"
} ],
"responseList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
validateProject GET Interface
Method: GET Relative URL: project/validate-project/project-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
addTemplate POST Interface
Method: POST Relative URL: project/add-template Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| template | Project | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: ADDTEMPLATE
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
Example Response: {
"id":2147483647,
"response":"?"
}
saveChangeProposal POST Interface
Method: POST Relative URL: project/proposal Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| detail | ChangeProposal | |
Response Structure: | Field Name | Type | Description |
|---|
| resp | Response | |
Example Request: SAVECHANGEPROPOSAL
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"title":"?",
"detail":"?",
"createdOn":?,
"lastModifiedOn":?,
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"category":"?",
"subCategory":"?",
"urgency":"?",
"state":"?",
"approvalState":"?",
"approvalNotes":"?",
"riskAssessment":"?",
"requirementDocument":"?",
"businessCase":"?",
"analysis":"?",
"design":"?",
"proposalStart":?,
"proposalEnd":?,
"archive":?,
"associatedCI": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"proposedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"assignee": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"changeModel": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"project": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"associatedCIs":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedProblems":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedKnownErrors":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedIncidents":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedRequests":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedReleases":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedKnowledges":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedChanges":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedDemands":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedAvailabilities":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedAlerts":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedEvents":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedServiceCatalogItems":[
{
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"totalTimeSpent":?
}
Example Response: {
"id":1716674347,
"response":"?"
}
getAssociatedItilRecords GET Interface
Get all itil records created for this task
Method: GET Relative URL: project/get-task-associated-itil-records/module/task-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
getAllAssignedDetailsForTask GET Interface
Method: GET Relative URL: project/get-users-for-tasks Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
saveResourcesToProject POST Interface
Method: POST Relative URL: project/save-resources Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| resources | ArrayOfAssignees | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: SAVERESOURCESTOPROJECT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"assigneeTaskList":[
{
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ]
}
Example Response: {
"id":2147483647,
"response":"?"
}
saveTimeTakenbyUserForEachTask POST Interface
Method: POST Relative URL: project/save-time-taken-by-user/project-id/task-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| input | ProjectTaskTimeTracking | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: SAVETIMETAKENBYUSERFOREACHTASK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"description":?,
"archive":?,
"timeSpent":?,
"timeSpentOn":?,
"timeSpentByUser":"?",
"itilRecordTrackingId":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
getTimeTakenbyUserForEachTask GET Interface
Method: GET Relative URL: project/get-time-taken-by-user/project-id/task-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
archiveTimeTakenbyUserForEachTask GET Interface
Method: GET Relative URL: project/archive-time-taken-by-user/record-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
updateProjectAndPhase GET Interface
Method: GET Relative URL: project/update-project-phase/project-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
exportProjectTasks GET Interface
Method: GET Relative URL: project/export-project-tasks/project-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: Example Response: {
"id":2147483647,
"response":"?"
}
getAllRunBookRecords GET Interface
Method: GET Relative URL: project/get-run-book-records/project-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: | Field Name | Type | Description |
|---|
| response | ArrayOfProjectTasks | |
Example Request: Example Response: {
"id":2147483647,
"responseList":[
{
"id":2147483647,
"task":"?",
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"status":"?",
"taskType":"?",
"seqNumber":?,
"rollUp":?,
"percentageComplete":?,
"constraintType":"?",
"duration":?,
"position":?,
"archive":?,
"compliance":?,
"notes":?,
"validationError":?,
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":1433522673,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"uniqueId":"?",
"mandatory":?,
"gateType":"?",
"review":"?",
"totalTimeSpent":?,
"parentPhase":?,
"ipAddresses":?,
"command":?
} ],
"predecessorsTaskList":[
{
"id":2147483647,
"taskId":?,
"predecessorId":?
} ],
"assigneeTaskList":[
{
"id":2051434944,
"taskId":?,
"userId":?,
"userNam":"?",
"assigneeStartDate":?,
"assigneeEndDate":?
} ],
"project": {
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":1551067833,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":389168471,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":653731799,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
}
}
executeRunBookCommands POST Interface
Method: POST Relative URL: project/execute-run-book-commands/project-id Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: | Field Name | Type | Description |
|---|
| input | IntegerList | |
Response Structure: | Field Name | Type | Description |
|---|
| response | Response | |
Example Request: EXECUTERUNBOOKCOMMANDS
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"actionType":"?",
}
Example Response: {
"id":1355527614,
"response":"?"
}
|
