Endpoint returns statistics about rounds. Including the total number of round and the number of rounds that were completed. Also includes the total number of task rounds. Including the total number of task rounds that were completed.

URL: http://demo.goplant.mobi/api/svc/Historian/RoundStatusBetweenDateTimesV2
Method: Post
Authorization: Basic

• Username: [Contact The GoPlant Administrator]
• Password: [Contact The GoPlant Administrator]

Headers:

• Content-Type: application/json

Body:

• Note: StartDatetime and EndDateTime are always UTC.
• StartDatetimeUTC *: For all task counts, will return records where the end date is after this parameter. For all round counts, will return records where the round end date is after this parameter. * Note: If no StartDatetime is passed, it will return records for the last 8 hours.
• EndDatetimeUTC *: For all task counts, will return records where the end date is before this parameter. For all round counts, will return records where the end date is before this parameter.
• StorageGroupID: Will filter on a specific storage group. Pass NULL to return ALL non deleted storage groups.
• Note as of 9/20/2019 *: Round counts only filter on the completed round date. Even if the round is in a task. Task counts only filter on the start date / end date. Before this date, round counts and task counts filtered on completed round date OR start date / end date. This lead to mis-matched counts when comparing to the dashboard or round / task reports.
  In the Data Object section below, the Round counts and Task counts are divided into two sections to indicate which filter is being used.
• Note: For endpoints that allow a date parameter, you can now use "StartDatetimeSG" or "EndDatetimeSG" to pass storage group timestamps. See the home page for more details.

Accept Body Example:

{
	"ReturnType": "json",
	"StartDatetimeUTC":"5/1/2017 15:00",
	"EndDatetimeUTC": "6/1/2018 15:00",
	"StorageGroupID": null
} 
OR
{
	"ReturnType": "json",
	"StartDatetimeUTC":"5/1/2017 13:00",
	"EndDatetimeUTC": "6/1/2018 13:00",
	"StorageGroupID": 80
} 
OR
{
	"ReturnType": "json",
	"StartDatetimeSG":"5/1/2017 15:00",
	"EndDatetimeSG": "6/1/2018 15:00",
	"StorageGroupID": null
} 
OR
{
	"ReturnType": "json",
	"StartDatetimeSG":"5/1/2017 15:00",
	"EndDatetimeSG": "6/1/2018 15:00",
	"StorageGroupID": 80
}

Status: 200
Type: JSON
Body:

• Status Object: Holds status information about your request.
  • HTTPStatusCode: HTTP Status ID of the request.
  • HTTPStatus: HTTP Status string representation. EX. 'OK'
  • RowStart: The zero based first row that was returned.
  • RowsReturned: The actual number of rows returned in the Data object.
  • LastIdReturned: The Last Response ID Returned by this request. This is useful for the next call when you want new records.
  • RequestBegin: The UTC timestamp API received the request.
  • StopWatch: The elapsed time the API call.
  • APIversion: GoPlant internal API version.
  • EndpointVersionReturned: The endpoint version that was returned based on the request. ex. If no endpoint version was requested, this will show the latest 1.x version.
  • ExternalRequest: The request object that was passed. Includes the endpoint version that was requested and the actual endpoint version that was returned.
    • "EndpointVersion": null
    • "EndpointVersionReturned": 1.1
• Data Object: Holds the actual data that you are requesting.
  • storageGroupId: GoPlant internal ID.
  • storageGroupName: The name of the storage group id.
  • StorageGroupPath: Storage Group path including any children.

  • Below are counts where the round end date is within the given date range.

  • inProgressRoundVariants: Total number of round variants that are in progress or drafted. This number includes round variants that are both in a task and not in a task.
  • inProgressRoundVariantsNoTask: Total number of round variants that are NOT in a task and are in progress or drafted.
  • completedRoundVariants: Total number of round variants that have been committed. This number includes round variants that are both in a task and not in a task.
  • commitSkippedRoundVariants: Total number of round variants that have been commit skipped. This number includes round variants that are both in a task and not in a task. A round/variant is considered 'Commit Skipped' if NONE of the elements with it are committed.
  • completedRoundVariantsNoTask: Total number of round variants that are NOT in a task and are committed.
  • commitSkippedRoundVariantsNoTask: Total number of round variants that are NOT in a task and are commit skipped. A round/variant is considered 'Commit Skipped' if NONE of the elements with it are committed.

  • Below are counts where the task start date / end date is filtered as outlined in the above 'StartDatetimeUTC' and 'EndDatetimeUTC' parameters.

  • availableTaskRoundVariants: Total number of task round variants that are assigned, completed, expired or completed late.
  • inProgressTaskRoundVariants: Total number of task round variants that are in progress or drafted.
  • completedTaskRoundVariants: Total number of task round variants that have been committed.
  • commitSkippedTaskRoundVariants: Total number of task round/variants that have been commit skipped. A task round/variant is considered 'Commit Skipped' if NONE of the elements with it are committed.
  • Note:: A 'Task Event' is an instance of the task schedule. For tasks that do not repeat, there will be only one 'Task Event'. For tasks that repeat, there will be one 'Task Event' for each repeating instance of the tasks schedule.
  • totalTaskEvents: Includes task events that are not started, late, on time, completed late, completed on time, expired, voided or revoked.
  • notStartedTaskEvents: Task events that have not been started. Not started means that none of the task variants have been committed.
  • lateTaskEvents: Task events that have not been started and the end date has past.
  • onTimeTaskEvents: Task events that have at least one variant committed before the end date.
  • completedOnTimeOrLateTaskEvents: Task events that where completed on time or late.
  • completedOnTimeTaskEvents: Task events that were completed before the end date.
  • completedLateTaskEvents: Task events that were completed after the end date.
  • expiredTaskEvents: Task events that were never started and the expiration date has passed.
  • voidedTaskEvents: Task events that were voided. When a task is published, all previous task events where the start date has not passed are voided. Task events where the start date has passed are left in place. New task events are created for the newly published task.
  • revokedTaskEvents: Task events that were revoked. Once the start date has passed, the task event can be revoked from the dashboard.

Response Example:

{
    "status": {
        "HTTPStatusCode": 200,
        "HTTPStatus": "OK",
        "RowStart": 0,
        "RowsReturned": 1,
        "LastIdReturned": -1,
        "RequestBegin": "2019-06-18T14:10:02.2021902Z",
        "StopWatch": {
            "IsRunning": true,
            "Elapsed": "00:00:00.0038959",
            "ElapsedMilliseconds": 4,
            "ElapsedTicks": 14865
        },
        "APIversion": "5.21.2.0",
        "EndpointVersionReturned": 1,
        "ExternalRequest": {
            "StartDatetimeUTC": "2017-05-01T15:00:00",
            "StartDatetimeSG": null,
            "EndDatetimeUTC": "2019-06-01T15:00:00",
            "EndDatetimeSG": null,
            "StorageGroupID": 80,
            "RowStart": 0,
            "RowCount": 0,
            "ResponseID": null,
            "TagSourceCodeName": "",
            "ReturnType": 1,
            "EndpointVersion": null,
            "EndpointVersionReturned": 1
        }
    },
    "data": [
        {
            "storageGroupId": 80,
            "storageGroupName": "Todd's Company",
            "storageGroupPath": "DEVL / FAS Verification / Todd's Company",
            "availableTaskRoundVariants": 0,
            "inProgressTaskRoundVariants": 0,
            "completedTaskRoundVariants": 0,
            "inProgressRoundVariants": 12,
            "completedRoundVariants": 117,
            "inProgressRoundVariantsNoTask": 12,
            "completedRoundVariantsNoTask": 117,
            "totalTaskEvents": 0,
            "notStartedTaskEvents": 0,
            "lateTaskEvents": 0,
            "onTimeTaskEvents": 0,
            "completedOnTimeOrLateTaskEvents": 0,
            "completedOnTimeTaskEvents": 0,
            "completedLateTaskEvents": 0,
            "expiredTaskEvents": 0,
            "voidedTaskEvents": 0,
            "revokedTaskEvents": 0
        }
    ]
}

• If you do not provide a basic authorization header you will get an empty body with a status of 401 Unauthorized.
• If your basic authorization header Username or Password is incorrect, you will get this message with a status of 401 Unauthorized.

  {"message": "Unauthorized API access"}

• If you do not supply a json object in your body, you will get this message with a status of 500 Internal Server Error.

  {"message": "Missing body in post."}

• If you pass a RowStart less than zero, you will get this message with a status of 500 Internal Server Error.

  {"message": "RowStart cannot be less than 0."}

• If you pass a RowCount less than zero, you will get this message with a status of 500 Internal Server Error.

  {"message": "RowCount cannot be less than 0."}

• If TagSourceCodeName is required and you do not pass it, you will get this message with a status of 500 Internal Server Error.

  {"message": "You must pass a source code name."}

• If a Start, End or last update date / time is required but not passed, you will get this message with a status of 500 Internal Server Error.

  {"message": "StartDatetimeUTC cannot be null"}

  OR

  {"message": "EndDatetimeUTC cannot be null"}

  OR

  {"message": "LastUpdateUTC cannot be null"}

• If you pass an invalid version number, you will get this type of response.

  {"message": "ResponsesBetweenResponseDate Error: Invalid Version Requested [1.1].   at ...

• If you pass a malformed StartDateTime or EndDatetime, you will get a 500 Internal Server Error:

   "message": "Could not convert string to DateTime: 5/25/20189 15:00. Path 'StartDatetime', line 2, position 36."

                        
curl -X POST \
  http://localhost:9080/api/svc/Historian/RoundStatusBetweenDateTimesV2 \
  -H 'Accept: */*' \
  -H 'Authorization: Basic R29QbGFudEFQSUFjY2VzczpERVZMLlRFU1RERVZFTE9QTUVOVEtFWQ==' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
	"ReturnType": "json",
	"StartDatetimeUTC":"5/1/1010 15:00",
	"EndDatetimeUTC": "6/1/2018 15:00",
	"StorageGroupID": 80
}'
                    

                        
var client = new RestClient("http://localhost:9080/api/svc/Historian/RoundStatusBetweenDateTimesV2");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("Connection", "keep-alive");
request.AddHeader("content-length", "123");
request.AddHeader("accept-encoding", "gzip, deflate");
request.AddHeader("Host", "localhost:9080");
request.AddHeader("Cache-Control", "no-cache");
request.AddHeader("Accept", "*/*");
request.AddHeader("User-Agent", "PostmanRuntime/7.13.0");
request.AddHeader("Authorization", "Basic R29QbGFudEFQSUFjY2VzczpERVZMLlRFU1RERVZFTE9QTUVOVEtFWQ==");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("undefined", "{\n\t\"ReturnType\": \"json\",\n\t\"StartDatetimeUTC\":\"5/1/1010 15:00\",\n\t\"EndDatetimeUTC\": \"6/1/2018 15:00\",\n\t\"StorageGroupID\": 80\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
                    

                        
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://localhost:9080/api/svc/Historian/RoundStatusBetweenDateTimesV2",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic R29QbGFudEFQSUFjY2VzczpERVZMLlRFU1RERVZFTE9QTUVOVEtFWQ==",
    "User-Agent": "PostmanRuntime/7.13.0",
    "Accept": "*/*",
  },
  "processData": false,
  "data": "{\n\t\"ReturnType\": \"json\",\n\t\"StartDatetimeUTC\":\"5/1/1010 15:00\",\n\t\"EndDatetimeUTC\": \"6/1/2018 15:00\",\n\t\"StorageGroupID\": 80\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});