Embedded Files
Interface
Interface
It allows you:
to get the Project Phases of a specified Project
to update the Project Phases of a specified Project
to create a Project Phase and its coresponding lines
to delete a Project Phase
Columns that can be used as filters:
Project (project name is mandatory)
Actions that can be done:
list
create
create_full
update
delete
Red columns can be set or updated but they may get overwritten by the project context
API Methods:
API Methods:
List:
List:
URL: https://api.socratecloud.com/webapi/rest/project/phase/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}&Project={project_name}&ProjectValue={project_value}&Project_ID={c_project_id}&PhaseName={project_phase_name}&Phase_ID={project_phase_id}&PhaseLineNo={project_phase_seq_no}
Method: GET
Return: JSON object with next format:
{
"data": [
{
"Organization": "Demo SRL",
"OrganizationValue": "Demo",
"Created": "2014-01-04 15:29:50+0300",
"CreatedBy": "SuperUser",
"Updated": "2014-01-04 15:29:50+0300",
"UpdatedBy": "SuperUser",
"Active": true,
"Phase_ID": 123456,
"Name": "Phase 1",
"Sequence": 10,
"StartDate": "2014-01-01 00:00:00+0200",
"EndDate": "2014-01-31 00:00:00+0200",
"PlannedQty": null,
"PlannedAmt": null,
"CommittedQty": 50,
"CommittedAmt": 200,
"IsComplete": false
}
],
"totalRows": 1
}
List full:
URL: https://api.socratecloud.com/webapi/rest/project/phase/list_full/{version}?startRow={0}&endRow={100}&accessToken={access_token}&Project={project_name}&ProjectValue={project_value}&Project_ID={c_project_id}&PhaseName={project_phase_name}&Phase_ID={project_phase_id}&PhaseLineNo={project_phase_seq_no}
Method: GET
Return: JSON object with next format:
{
"data": [
{
"Organization": "RAMPAD CONSTRUCT SRL",
"OrganizationValue": "RAMPAD CONSTRUCT SRL",
"Created": "2016-01-26 14:15:05+0200",
"CreatedBy": "AdminTitular",
"Updated": "2017-10-19 12:34:37+0300",
"UpdatedBy": "AdminTitular",
"Active": true,
"Phase_ID": 123456,
"Name": "Terasamente",
"Sequence": 10,
"StartDate": "2016-01-27 00:00:00+0200",
"EndDate": "2016-01-27 00:00:00+0200",
"PlannedQty": 0,
"PlannedAmt": 129,
"CommittedQty": 4,
"CommittedAmt": 230,
"IsComplete": false,
"ProjInvoiceRule": "Product Quantity",
"subPhases": [
{
"Organization": "RAMPAD CONSTRUCT SRL",
"OrganizationValue": "RAMPAD CONSTRUCT SRL",
"Created": "2016-01-26 14:16:31+0200",
"CreatedBy": "AdminTitular",
"Updated": "2016-04-11 09:20:07+0300",
"UpdatedBy": "Robert Hindli",
"Active": true,
"Name": "Indepartare strat vegetal",
"Sequence": 10,
"PlannedQty": 0,
"PlannedAmt": 29,
"CommittedQty": 3,
"CommittedAmt": 30,
"Description": null,
"StartDate": null,
"EndDate": null,
"projectLines": [
{
"Organization": "RAMPAD CONSTRUCT SRL",
"OrganizationValue": "RAMPAD CONSTRUCT SRL",
"Created": "2016-01-26 14:19:22+0200",
"CreatedBy": "AdminTitular",
"Updated": "2016-01-26 14:19:22+0200",
"UpdatedBy": "AdminTitular",
"Line": 20,
"Active": true,
"DateTrx": null,
"ProductCategory": "Materiale auxiliare Rampad",
"Product": null,
"ProductName": null,
"ListPrice": null,
"Discount": 0,
"PlannedPrice": 5,
"Description": null,
"PlannedDate": null,
"PlannedQty": 1,
"PlannedAmt": 5,
"Activity": null
}
],
"activities":[
{
"Activity_ID": 1000122,
"Name": Dulgherie
}
]
}
],
"projectLines": [],
"activities":[
{
"Activity_ID": 1000122,
"Name": Dulgherie
}
]
}
],
"totalRows": 1
}
Create:
URL: https://api.socratecloud.com/webapi/rest/project/phase/create/{version}?startRow={0}&endRow={100}&accessToken={access_token}&ProjectValue={project_value}&Project_ID={c_project_id}
Method: POST
Return: project phase name and ID
Data format:
{
"Name": "project_phase",
"StartDate" : "2019-11-02 00:00:00+0300",
"EndDate" : "2019-11-03 00:00:00+0300",
"IsComplete" : false,
"Active" : true,
"PlannedQty" : 10,
"CommittedQty" : 10,
"CommittedAmt" : 10,
"PlannedAmt" : 10,
"ProjInvoiceRule" : "None"
}
Create Full:
URL: https://api.socratecloud.com/webapi/rest/project/phase/create_full/{version}?startRow={0}&endRow={100}&accessToken={access_token}&ProjectValue={project_value}&Project_ID={c_project_id}
Method: POST
Return: project phase name and ID
Data format:
{
"Active": true,
"Name": "Api_create",
"Sequence": 10,
"StartDate": "2014-09-15",
"EndDate": "2015-09-15",
"PlannedQty": 0,
"PlannedAmt": 0,
"CommittedQty": 1,
"CommittedAmt": 10,
"IsComplete": false,
"ProjInvoiceRule": "None",
"subPhases": [
{
"Organization": "UT",
"Created": "2014-09-15",
"Updated": "2014-09-15",
"Active": true,
"Name": "Sub phase",
"Sequence": 10,
"PlannedQty": 0,
"PlannedAmt": 10,
"CommittedQty": 1,
"CommittedAmt": 10,
"Description": "description",
"StartDate": "2014-09-15",
"EndDate": "2014-09-16"
}
]
}
Update:
URL: https://api.socratecloud.com/webapi/rest/project/phase/update/{version}?startRow={0}&endRow={100}&accessToken={access_token}&ProjectValue={project_value}&Project_ID={c_project_id}&Phase_ID={project_phase_id}&LineNo={project_phase_line_no}
Method: POST
Return: project phase name and ID
Data format:
{
"Name": "project_phase",
"StartDate" : "2019-11-02 00:00:00+0300",
"EndDate" : "2019-11-03 00:00:00+0300",
"IsComplete" : false,
"Active" : true,
"PlannedQty" : 10,
"CommittedQty" : 10,
"CommittedAmt" : 10,
"PlannedAmt" : 10,
"ProjInvoiceRule" : "None"
}
Delete:
URL: https://api.socratecloud.com/webapi/rest/project/phase/delete/{version}?startRow={0}&endRow={100}&accessToken={access_token}&ProjectValue={project_value}&Project_ID={c_project_id}&Phase_ID={project_phase_id}&LineNo={project_phase_line_no}
Method: POST
Return: "Deleted" or error
Page updated
Report abuse