Request body JSON for Round Plan Creation Payload Formation
Header Information Payload
- The Header Details contain the name of the Round Plan, and the Plant ID.
- Enter the LocationID & AssetID for respective locations and assets.
- Provide the name of the Page & Sections inside the page and create tasks.
{
"name": "Daily Round Plan",
"plantId": "1000",
"locationId": "123-XL-BA39",
"pages": [
{
"name": "page1",
"sections": [
{
"name": "section1",
"tasks ": [
}
}
}Response Type Configuration Payload
Read Only
- The "name" field must contain the name of the task.
- The response type must be given as “LF”.
- The “value” field must contain the default value the user wants to see in the application.
{
"name": "Read Only Field",
"responseType": "LF",
"value": "Default Value"
}Instruction Response Type
- The "name" field must contain the name of the task.
- The response type must be given as “INST”.
- The “value” field must contain the default value of the instructions the user wants to see in the application.
{
"name": "Instructions",
"responseType": "INST",
"value": {}}
}Short Text Answer
- The "name" field must contain the name of the task.
- The response type must be given as “TF”.
- If a Short Text Answer is required, then the “required” field should be either True or False.
- For True the name should be “Short Text Answer Required”.
{
"name": "Short Text Answer",
"responseType": "TF",
"value": "",
"required": false
},
{
"name": "Short Text Answer Required",
"responseType": "TF",
"value": "",
"required": true
},
}Long Text Answer
- The "name" field must contain the name of the task.
- The response type must be given as “LTV”.
- If a Long Text Answer is required, then the “required” field should be either True or False.
- For True the name should be “Long Text Answer Required”.
{
"name": "Long Text Answer",
"responseType": "LTV",
"value": "",
"required": false
},
{
"name": "Long Text Answer Required",
"responseType": "LTV",
"value": "",
"required": true
},Number Response Type
- The "name" field must contain the name of the task.
- The Number Response Type has the following Configuration Options:
- Number without UOM & range
- Number without range
- Number Testing with None
- The response type field for all the configurations is the same and must be "NF".
- To enable tracking of History, the enableHistory field inside value must be true.
- To add Unit Of Measurement, the UnitOfMeasurement field must be followed by the UOM ID inside the value.
- To set up range, define the min and max values along with messages that must
be displayed for values that are beyond the range. These Messages are
categorized as Warning, Alert, Note & None.
- You can enter the respective value inside the value field, for
example
"rangeMetadata": {"min": 0, "max": 10, "minMsg": "Test message", "maxMsg": "", "minAction": "Warning", "maxAction": "None"
- You can enter the respective value inside the value field, for
example
"name": "Number without UOM & range",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false}
},
{
"name": "Number without range",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false, "unitOfMeasurementId": "f0deec55-2401-41ab-b88d-37f8ced36e09"}
},
{
"name": "Number Testing with None",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false, "unitOfMeasurementId": "f0deec55-2401-41ab-b88d-37f8ced36e09", "rangeMetadata": {"min": 0, "max": 10, "minMsg": "", "maxMsg": "", "minAction": "None", "maxAction": "None"}}
},
{
"name": "Number Testing with None",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false, "unitOfMeasurementId": "f0deec55-2401-41ab-b88d-37f8ced36e09", "rangeMetadata": {"min": 0, "max": 10, "minMsg": "Test message", "maxMsg": "", "minAction": "Warning", "maxAction": "None"}}
},Global Picklist Single Selection
- The "name" field must contain the name of the task.
- The Response type must be given as DD.
- The "value" must contain Response Set ID.
- This fetches the necessary Picklist from the master data.
{
"name": "Picklist Testing",
"responseType": "DD",
"required": true,
"value": {"responseSetId" : "31c52245-c756-4bc8-ad02-0ee3c952fecc" }
},Global Picklist Multiple Selection
- The "name" field must contain the name of the task.
- The Response type must be given as DDM.
- The "value" must contain Response Set ID.
- This will fetch the necessary Multiple Select Choice from the master data.
{
"name": "Multiple Select Choice answers Testing",
"responseType": "DDM",
"required": true,
"value": {"responseSetId" : "31c52245-c756-4bc8-ad02-0ee3c952fecc" }
},Scanner
- The "name" field must contain the name of the task.
- The Response type must be given as SF.
{
"name": "Scan Testing",
"responseType": "SF",
"required": true,
"value": ""
},Date & Time
- The "name" field must contain the name of the task.
- The Response type must be given as DT.
- The user can choose the combination of True and False in "value" to show either date or time or both.
{
"name": "Date & Time Testing",
"responseType": "DT",
"required": true,
"value": {"date": false, "time": true}
}Hyperlink
- The "name" field must contain the name of the task.
- The Response type must be given as HL.
- Enter the link under the "value" field.
{
"name": "Hyperlink Testing",
"responseType": "HL",
"value": {"link": "https://google.com"}
},Check box
- The "name" field must contain the name of the task.
- The Response type must be given as CB.
{
"name": "Checkbox Testing",
"responseType": "CB",
"required": false,
"value": ""
},Signature
- The "name" field must contain the name of the task.
- The Response type must be given as SGF.
{
"name": "Signature Testing",
"responseType": "SGF",
"required": false,
"value": ""
}Photo Response
- The "name" field must contain the name of the task.
- The Response type must be given as ATT.
{
"name": "Photo Testing",
"responseType": "ATT",
"required": false,
"value": ""
},Geo Location Response
- The "name" field must contain the name of the task.
- The Response type must be given as GAL.
{
"name": "Geo Location Testing",
"responseType": "GAL",
"required": false,
"value": ""
},Date Range
- The "name" field must contain the name of the task.
- The Response type must be given as DRF.
{
"name": "Date range Testing",
"responseType": "DFR",
"required": false,
"value": ""
}Multiple Choice
- The "name" field must contain the name of the task.
- The Response type must be given as VI.
{
"name": "Multiple Choice Answers Testing",
"responseType": "VI",
"required": false,
"value": "yes,no"
},Slider
- The "name" field must contain the name of the task.
- The Response type must be given as RT.
- The value field must contain the Minimum & the Maximum Value along with the Increment.
{
"name": "Slider Testing",
"responseType": "RT",
"required": false,
"value": {"min": 10, "max": 100, "enableHistory": true, "value": 20, "increment":
}Below is an example of a complete round plan with Round Name, Plant, Location, Pages
Sections & Tasks.
{
"name": "Daily Round Plan",
"description": "All Response Types",
"plantId": "1000",
"locationId": "123-XL-BA39",
"pages": [
{
"name": "page1",
"sections": [
{
"name": "section1",
"tasks": [
{
"name": "Read Only Field",
"responseType": "LF",
"value": "Read Only Field Testing"
},
{
"name": "Instructions",
"responseType": "INST",
"value": {}
},
{
"name": "Instructions with tag",
"responseType": "INST",
"value": { "tag": "Caution"}
},
{
"name": "Short Text Answer",
"responseType": "TF",
"value": "",
"required": false
},
{
"name": "Short Text Answer Required",
"responseType": "TF",
"value": "",
"required": true
},
{
"name": "Long Text Answer",
"responseType": "LTV",
"value": "",
"required": false
},
{
"name": "Long Text Answer Required",
"responseType": "LTV",
"value": "",
"required": true
},
{
"name": "Number without UOM & range",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false}
},
{
"name": "Number without range",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false, "unitOfMeasurementId": "db5aaa7d-d13f-4e83-a3f1-e108c3f16e3f"}
},
{
"name": "Number Testing with None",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false, "unitOfMeasurementId": "db5aaa7d-d13f-4e83-a3f1-e108c3f16e3f", "rangeMetadata": {"min": 0, "max": 10, "minMsg": "", "maxMsg": "", "minAction": "None", "maxAction": "None"}}
},
{
"name": "Number Testing with None",
"responseType": "NF",
"required": true,
"value": { "enableHistory": false, "unitOfMeasurementId": "db5aaa7d-d13f-4e83-a3f1-e108c3f16e3f", "rangeMetadata": {"min": 0, "max": 10, "minMsg": "Test message", "maxMsg": "", "minAction": "Warning", "maxAction": "None"}}
},
{
"name": "Picklist Testing",
"responseType": "DD",
"required": true,
"value": {"responseSetId" : "f87a12bc-aab2-4199-9bc4-4c09cec549e9" }
},
{
"name": "Multiple Select Choice answers Testing",
"responseType": "DDM",
"required": true,
"value": {"responseSetId" : "f87a12bc-aab2-4199-9bc4-4c09cec549e9" }
},
{
"name": "Scan Testing",
"responseType": "SF",
"required": true,
"value": ""
},
{
"name": "Date & Time Testing",
"responseType": "DT",
"required": true,
"value": {"date": false, "time": true}
}
]
},
{
"name": "section2",
"tasks": [
{
"name": "Date & Time Testing",
"responseType": "DT",
"required": true,
"value": {"date": false, "time": false}
},
{
"name": "Hyperlink Testing",
"responseType": "HL",
"value": {"link": "https://google.com"}
},
{
"name": "Checkbox Testing",
"responseType": "CB",
"required": false,
"value": ""
},
{
"name": "Signature Testing",
"responseType": "SGF",
"required": false,
"value": ""
},
{
"name": "Photo Testing",
"responseType": "ATT",
"required": false,
"value": ""
},
{
"name": "Geo Location Testing",
"responseType": "GAL",
"required": false,
"value": ""
},
{
"name": "Date range Testing",
"responseType": "DFR",
"required": false,
"value": ""
}
]
}
]
},
{
"name": "page2",
"sections": [
{
"name": "section1",
"tasks": [
{
"name": "Multiple Choice Answers Testing",
"responseType": "VI",
"required": false,
"value": "yes,no"
},
{
"name": "Slider Testing",
"responseType": "RT",
"required": false,
"value": {"min": 10, "max": 100, "enableHistory": true , "value": 20, "increment": 10}
}
]
},
{
"name": "section2",
"tasks": [
{
"name": "Multiple Choice Answers Testing",
"responseType": "VI",
"required": false,
"value": "yes,no"
},
{
"name": "Multiple Choice Answers Testing",
"responseType": "VI",
"required": false,
"value": "yes,no,test"
}
]
}
]
}
]
}