GET /ws/rest/service/v1/schedule/{project_number}
Purpose:
Get the list of schedule sheet attributes defined in the shell/project.
Input:
Path Parameter
project_number(Required): Specify the project/shell number.
Url Parameter
filter (Optional): Filter condition to be used when retrieving the schedule sheet. It is a JSON object with the below information:
"status": Status of the schedule sheet that needs to be retrieved. Possible values are "active" and "inactive".
"main_sheet": Specify "true" to get the main schedule sheet or "false" to get other non-main schedule sheets.
"sheet_lock": Specify "true" to get the schedule sheets that are locked, "false" to get non locked schedule sheet.
"name": Specify the name of the schedule sheet that needs to be returned in the response.
Note: All fields values of filter condition are case insensitive except the value of "name" field
Sample input parameter
{
"filter":
{
"name":"Gas pipeline schedule",
"status": "open"
}
}
Output:
JSON object containing 'status', 'data', 'message'
A message will be present if the status is not 200 otherwise it will be "success".
Sample Response
{
"data": [],
"message": [
"Invalid Filter Condition : status"
],
"status": 811
}