UpdateTaskInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telstra/main/json-schema/telstra-update-task-input-schema.json",
  "title": "UpdateTaskInput",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telstra-field-workforce-partners-api-openapi.yml#/components/schemas/UpdateTaskInput",
  "required": [
    "data"
  ],
  "type": "object",
  "properties": {
    "correlationId": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "An optional identifier for this transaction generated by the consumer (such as a random UUIDv4 string). If not supplied the WFM Partner Gateway will generate its own value."
    },
    "data": {
      "required": [
        "taskID",
        "eventType"
      ],
      "type": "object",
      "properties": {
        "taskID": {
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "description": "The task ID under the given partner which is to be updated."
        },
        "eventType": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string",
          "description": "Indicates the type of event to record against this task.",
          "enum": [
            "ACCEPT",
            "REJECTION",
            "TRAVEL COMMENCED",
            "ON-SITE NOTIFICATION",
            "COMPLETION"
          ]
        },
        "technicianDetails": {
          "$ref": "#/$defs/technicianDetailsInput"
        },
        "acceptedDate": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "description": "The acceptance date/time in UTC for when the partner reviewed and accepted the task. Mandatory when eventType=ACCEPT. Format yyyy-MM-DDThh:mi:ss.mls"
        },
        "rejectionDate": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "description": "The rejection date/time in UTC for when the partner reviewed and decided to reject this task allocation.Mandatory when eventType=REJECTION. Format yyyy-MM-DDThh:mi:ss.mls"
        },
        "rejectionReason": {
          "maxLength": 255,
          "type": "string",
          "minLength": 1,
          "description": "The rejection reason code assigned by the partner for this rejection of task. The value must be from one of the current rejection reasons configured in the system. Mandatory when eventType=REJECTION."
        },
        "rejectionComment": {
          "maxLength": 250,
          "type": "string",
          "minLength": 1,
          "description": "A human readable note where the partner can give more details around why the task is being rejected. Mandatory when eventType=REJECTION"
        },
        "travelDate": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "description": "The date time value when the partner technician commenced travel to attend the task in UTC. Mandatory when eventType=TRAVEL COMMENCED OR Mandatory when eventType in- ON-SITE NOTIFICATION, COMPLETION - if travelDate was not previously supplied by the partner. Format YYYY-MM-DDThh:mi:ss.mls"
        },
        "onsiteDate": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "description": "The date time value when the partner technician arrived at the site to commence the work in UTC. Mandatory when eventType=ON-SITE NOTIFICATION OR Mandatory when eventType=COMPLETION - if onsiteDate was not previously supplied by the partner. Format YYYY-MM-DDThh:mi:ss.mls"
        },
        "closureCategory": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The scenario of the closure, indicating whether the technician attended site to begin the work or if the blocked before attendance. Mandatory when eventType=COMPLETION.",
          "enum": [
            "SITE ATTENDED",
            "NOT ATTENDED"
          ]
        },
        "closureReason": {
          "type": "string",
          "maxLength": 255,
          "minLength": 1,
          "description": "The closure reason code assigned by the partner for this completion of task. The value must be from one of the current closure reasons configured in the system for the selected category above. Mandatory when eventType=COMPLETION."
        },
        "closureComment": {
          "type": "string",
          "maxLength": 250,
          "minLength": 1,
          "description": "A human readable note where the partner can give more details around the closure of the task and any blockers or followup actions needed by Telstra WFM. Mandatory when eventType=COMPLETION"
        },
        "closureDate": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "description": "The date time value when the partner marked the task as closed in UTC. Mandatory when eventType=COMPLETION. Format YYYY-MM-DDThh:mi:ss.mls"
        },
        "missedReason": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "If the task completion is given after the due date/time of the task, the partner must supply a valid missed reason. Mandatory when eventType=COMPLETION and the task due date/time is in the past."
        },
        "faultClearanceDetails": {
          "type": "array",
          "minItems": 0,
          "items": {
            "$ref": "#/$defs/faultClearanceDetailsInput"
          }
        },
        "scheduleOfRatesDetails": {
          "$ref": "#/$defs/scheduleOfRatesDetailsTaskUpdateInput"
        }
      }
    }
  },
  "$defs": {
    "additionalSORsInput": {
      "required": [
        "code",
        "group",
        "quantity",
        "comment"
      ],
      "properties": {
        "code": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The additional group SOR code being claimed"
        },
        "group": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The additional SOR group for the code. The group of the additionalSORs must match with the value obtained from the Task Retrieve API"
        },
        "quantity": {
          "type": "integer",
          "minimum": 0,
          "description": "The quantity of this SOR code claimed."
        },
        "comment": {
          "type": "string",
          "description": "A comment providing more details to justify/explain the claim.",
          "maxLength": 250,
          "minLength": 1
        }
      }
    },
    "faultClearanceDetailsInput": {
      "description": "An array of fault clearance values related to the closure. Mandatory when eventType=COMPLETION and the task category value is \"ASSURANCE - COMMITMENT\" or \"ASSURANCE - APPOINTMENT\" and closureCategory=SITE ATTENDED. At least item must be present in the array.",
      "required": [
        "clearanceActionCode",
        "locationCode",
        "partOfPlantCode",
        "componentCode"
      ],
      "properties": {
        "clearanceActionCode": {
          "type": "string",
          "maxLength": 255,
          "minLength": 1,
          "description": "A code which indicates the action taken to clear the fault condition. Valid values depend on the location and part of plant codes selected."
        },
        "locationCode": {
          "type": "string",
          "maxLength": 255,
          "minLength": 1,
          "description": "A code which indicates the location of the fault condition."
        },
        "partOfPlantCode": {
          "type": "string",
          "maxLength": 255,
          "minLength": 1,
          "description": "A code which indicates the part of plant which had the fault condition. Valid values depend on the location code selected."
        },
        "componentCode": {
          "type": "string",
          "maxLength": 255,
          "minLength": 1,
          "description": "A code which indicates the component related to the fault condition. Valid values depend on the location and part of plant codes selected."
        },
        "causeCode": {
          "type": "string",
          "maxLength": 255,
          "minLength": 1,
          "description": "A code which indicates the root cause of the fault condition. Valid values depend on the location, part of plant and action codes selected."
        }
      }
    },
    "jobDetailsInput": {
      "required": [
        "jobID",
        "jobState"
      ],
      "properties": {
        "jobID": {
          "type": "string",
          "description": "The job ID as per the value obtained from the Task Retrieve API",
          "maxLength": 255,
          "minLength": 1
        },
        "jobState": {
          "type": "string",
          "description": "The state of the job at closure. If the work requested for the job has been completed the partner should set to DONE. If the work of the job was not started/fully completed then the partner should set to TO DO.",
          "enum": [
            "DONE",
            "TO DO"
          ],
          "maxLength": 50,
          "minLength": 1
        }
      }
    },
    "primarySORInput": {
      "type": "object",
      "description": "The primary SOR details claimed for the task.",
      "required": [
        "code",
        "group",
        "quantity",
        "comment"
      ],
      "properties": {
        "code": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The SOR code claimed for the primarySOR."
        },
        "group": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The SOR group for the code. The group of the primarySOR must match with the value obtained from the Task Retrieve API"
        },
        "quantity": {
          "type": "integer",
          "minimum": 0,
          "description": "The quantity of this SOR code claimed."
        },
        "comment": {
          "type": "string",
          "minLength": 1,
          "description": "A comment providing more details to justify/explain the claim.",
          "maxLength": 250
        }
      }
    },
    "scheduleOfRatesDetailsTaskUpdateInput": {
      "type": "object",
      "description": "A grouping object holding the schedule of rates (SOR) details claimed by the partner for completing the work. Mandatory when eventType=COMPLETION and closureCategory=SITE ATTENDED.",
      "required": [
        "primarySOR"
      ],
      "properties": {
        "primarySOR": {
          "$ref": "#/$defs/primarySORInput"
        },
        "additionalSORs": {
          "type": "array",
          "minItems": 0,
          "description": "An array of additional SOR details claimed for the task (if applicable)",
          "items": {
            "$ref": "#/$defs/additionalSORsInput"
          }
        },
        "jobDetails": {
          "type": "array",
          "minItems": 1,
          "description": "An array of jobs under the task. Will be used to inform that status of individual jobs, allowing indication of a full vs partial completed case when required. Mandatory when eventType=COMPLETION",
          "items": {
            "$ref": "#/$defs/jobDetailsInput"
          }
        }
      }
    },
    "technicianDetailsInput": {
      "type": "object",
      "description": "An object which holds the details of the partner technician related to the eventType. Mandatory when eventType is ACCEPT, TRAVEL COMMENCED, ON-SITE NOTIFICATION, COMPLETION.",
      "required": [
        "technicianID"
      ],
      "properties": {
        "technicianID": {
          "type": "string",
          "description": "An identifier of the technician within the partner system (eg user ID, employee number).",
          "maxLength": 50,
          "minLength": 1
        },
        "fullName": {
          "type": "string",
          "description": "The full name of the partner technician (if available).",
          "maxLength": 100,
          "minLength": 1
        },
        "phoneNumber": {
          "type": "string",
          "description": "The contact phone number of the partner technician (if available). The value should be all integer digits in Australian domestic number format -10 digits starting 02/03/04/07/08/1300/1800 -6 digits starting 13",
          "maxLength": 20,
          "minLength": 1
        }
      }
    }
  }
}