Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Chapter Contents:

  • Properties

POST /Scenario/copy/{key}

Copies the scenario specified by key.

  • MASTER scenario:

    • All future allocated voyages with their cargoes

    • All unallocated voyages

    • All non-template unallocated cargoes

    • All vessel open positions for schedulable vessels

  • Non-MASTER scenario:

    • All voyages with their cargoes

    • All non-template unallocated cargoes

    • All vessel open positions for schedulable vessels

  • Budget scenario:

    • All voyages with their cargoes

    • All budget voyage start

Possible to specify which voyages and cargoes to copy (available from version 6.17):

Copy with specified fields includes:

  • Vessels

    • MASTER: all future allocated voyages with their cargoes for specified vessels

    • Non-budget: all allocated voyages with their cargoes for specified vessels

    • Budget: all voyages with their cargoes for specified vessels

  • Voyages

    • Non-budget: all specified voyage commitments

    • Budget: N/A

  • Cargoes

    • Non-budget: all specified cargo commitments

    • Budget: N/A

Example:

Code Block
{
   "vessels":[
      {
         "key":1609791
      }
   ],
   "voyages":[
      {
         "key":13485729
      }
   ],
   "cargos":[
      {
         "key":18438432
      }
   ],
   "scenarioName":"Copy of Scenario"
}

Long Description

Properties

Property

Type

Length

Mandatory

Description

Comments

cargos

Array of /Cargo





fleetPlan

/FleetPlan2981527561

offhires

Array of /Offhire

scenarioCode

String

Yes

scenarioName

String

vessels

Array of /Vessel

voyages

Array of /Voyage

budgetVersion

/BudgetVersion

isBudget

Boolean

Yes

...