Update dates

Update the key dates of a phase

Update dates

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaphases.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=update
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesJob ID or UUID"phaseJobAndPhase": "1/00000210.001"
Update dataYesData to update"phaseDatein": "2020-08-12"

Note: Changing phase dates may be restricted, or if allowed may affect other dates. This behaviour depends on the company settings in 'Company date controls'

  • No dependencies
    • Phase dates are amendable
  • Job driven
    • Phase dates are NOT amendable
  • Phase driven
    • Phase dates are amendable
    • Changing a phase will also change related Job/phase/stage/estimate dates in accordance with the current business logic
  • Stage driven
    • Phase dates are amendable IF the phase has no stages in the schedule
    • Changing a phase date will also change related Job/phase/stage/estimate dates in accordance with the current business logic

Example request - updating the start and end dates (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/phases.json?&action=update&company=1&version=6&input={
  "data": [
    {
      "phaseJobAndPhase": "1/00000210.001",
      "phaseDatein": "2020-08-12",
      "phaseDateDue": "2020-08-12"
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/phases.json?&action=update&company=1&version=6&input={
  "data": [
    {
      "phaseJobAndPhase": "1/00000210.001",
      "phaseDatein": "2020-08-12",
      "phaseDateDue": "2020-08-12"
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "synversion": "12.960.0060",
  "synapiversion": 3.95,
  "data": [
    {
      "phaseTimeZoneIn": "UTCA",
      "phaseTimeZoneDue": "UTCA",
      "phaseJobAndPhase": "1/00000210.001",
      "phaseuuid": "7BBD6173F013EA4087AE1302B58C43E0",
      "phaseTimeStampModified": 1697031082,
      "phaseRecordVersionNumber": 337
    }
  ]
}