Knowledge Base
About DataloyRelease NotesAPI DocumentationJava VMS Documentation
Release 8.6
Release 8.6
  • Knowledge Base
  • Voyage Management System
    • VMS: Step-By-Step Guides
      • Vessels
        • Create Vessels
        • Copy Vessel
        • Find Vessels
        • Voyages & Port Calls
        • Main Vessel Description
        • Speed & Consumption
        • Load & Discharge Rates
          • Manage Load And Discharge Rates
        • Internal Data
        • AIS & Weather Reports
        • AIS-subscription
        • View Vessel Route from Previous Port to Next Port
      • Voyages
        • Canal Allowances
        • Create New Voyages
          • Create Voyage Charterer
          • Create Time Charter Out
          • Create Voyage From Template
          • Create Voyage Without Cargo
        • Find Voyages
        • Maintain Voyages
          • Overview
            • Vessel
            • Cargo
            • TC
            • Schedule
            • Profit/Loss Summary
              • Analysis
            • Speed & Consumption
          • Cargo
          • Bunkers
          • Various Cost/Revenue
            • Create, Edit & Delete Various Cost/Revenue
            • Search and Filter Variouses
            • Various Rule: "Fixed Quantity"
          • Organisational Data
          • Invoices
          • Downtimes
          • Related
          • Voyage Functionalities
            • Converting Voyage to Template
            • Change Voyage Status
            • Swap Vessel
            • Configure Voyage as a “Last TC Voyage”
            • Change Voyage Reference Number/Voyage Number and Voyage Starting Year
            • Voyage Comparison
        • TC Voyages
        • Create Laytime Calculations
        • Delete Voyages
        • Voyage Map
        • Voyage Schedule
        • Voyage Edit Schedule
        • Voyage Alternative Routes
        • Voyage Functions
          • Sensitivity Analysis
          • Intake Calculation
        • Long Time Charter (TC) Voyage
        • Voyage Bunkers
        • Voyage full-screen
          • Data grid
            • Port Calls Grid
            • Cargoes Grid
            • Cargo Ports Grid
            • Various Grid
      • Cargoes
        • Create New Cargoes
          • Create Cargo
          • Create Cargo From CoA Template
          • Create Cargo on TC Voyages
          • Create Cargo by Importing from Excel
          • Create Cargo From Existing Cargo
        • Find Cargoes
        • Maintain Cargoes
          • Cargo Drawer
            • Main Details
            • Sub-cargoes
            • Various Cost/Revenue
            • Commissions
            • Freight Rate Tiers
            • Payment Terms
            • Comments
          • Cargo Drawer Actions
            • Allocate Cargo
            • Change Cargo Status
            • Delete Cargo
            • Relet Cargo
            • Convert Cargo to Relet/Non-Relet
            • Transship and Preship Cargo
            • Transfer Cargo
            • Connect Cargo to CoA
            • Remove CoA from Cargo
        • Template Cargoes
        • Sub-cargoes
        • Capacity Plan
        • View Cargo History
      • Port Calls
        • Find Port Calls
        • Maintain Port Calls
          • Days Extra In Port
          • Speed Order
        • Port Call Drawer
          • Overview (And Bunkers)
            • Use Port Cost from Service Orders
              • Automating the Use (Port) Cost from Service order
            • Use Handling Cost from Service Orders
          • Service Orders
          • Bunker Orders
          • Vessel Reports
          • Port Log
            • Stoppages
        • Register Reports
          • Register Noon Reports
          • Register Arrivals
          • Register Berths
          • Register Unberths
          • Register In Port Reports
          • Register Departures
        • Custom Port Calls: 'At Sea'
      • Port Costs
        • Find Port Costs
        • Maintain Port Costs
        • View Service Orders of Port Costs
      • Contracts of Affreightment
        • Find a CoA
        • Create a CoA
        • Maintain a CoA
        • Contract of Affreightment Lines
          • Find CoA Lines
          • Create CoA Lines
          • Maintain CoA Lines
            • Template Cargoes
              • Find Template Cargoes
              • Create Template Cargoes
              • Maintain Template Cargoes
      • Time Charter Contracts
        • Create Time Charter Contracts
        • Maintain Time Charter Contracts
          • Duration and Rates
            • Create Duration and Rates
          • Notices
          • Comissions
          • Payment Terms
          • View Speed & Consumption
          • View Voyages
        • Print Statement of Account
      • Broker Commissions
        • Create Commissions
        • Find Broker Commission
        • Maintain Broker Commission
      • Bunker Orders
        • Create Bunker Orders
          • Create from a port call
          • Create bunker order from scratch
        • Maintain Bunker Orders
        • Stem Bunker Orders
        • Register Delivery Against a Bunker Order
        • Cancel Bunker Order
        • Delete Bunker Order
      • Service Orders
        • Create a Service Order
        • Maintain Service Orders
        • Handling Cost Allocation
        • Delete Service Order
      • Laytime Calculations
        • Create Laytime Calculation
        • Find Laytime Calculation
        • Delete Laytime Calculation
        • Maintain Laytime Calculation
          • Status
          • Drawer Fields
          • Manage Cargo Ports
            • Cargo Port Fields
            • Statement Of Facts
              • Event
            • Timesheet
      • Bills of Lading
        • Create Bills of Lading
        • Attachments
        • Edit Bills of Lading
        • Delete Bills of Lading
        • Print Bills of Lading
        • Print Sea Waybills
      • Downtime
        • Create Downtime
        • Find Downtime
        • Maintain Downtime
          • Status
          • Overview
          • Various Cost/Revenue
          • Delete Downtime
      • Vessel Reports
        • Find Vessel Reports
        • Create Vessel Reports
      • Voyage Analysis Dashboard
        • Log In
        • Viewing and Managing Deviated Voyages
          • Viewing and Managing Deviated Voyages
          • Viewing Post Voyage Analysis Detail
          • No Freight Received
      • Invoices
        • Invoices List
        • Pending Invoices
        • Assembling Invoices
        • Invoice Drawer
        • Printing Invoices
        • Reversing an Invoice
      • Bunker Transactions
      • Accruals
        • Accruals
          • Batch Post Accruals
          • Generate Accruals
          • Find Accruals
          • Maintain Accruals
        • Bunker Stock Adjustments List
          • Batch Post Bunker Stock Adjustments
          • Bunker Stock Adjustment Drawer
        • Actuals list
        • Time Correction list
      • Status Transitions
      • Webhook Subscriptions
        • Create Webhook Subscription
        • Find Webhook Subscription
        • Maintain Webhook Subscription
          • Overview
          • Notification
      • Setup
        • Users
          • Create Users
            • Create a Vessel Master user
          • Maintain Users
            • Change User Passwords
          • Find Users
          • Disable Users
          • Multi-Factor Authentication (MFA)
            • Guardian Multi-Factor Authentication (MFA)
        • Security Roles
          • Find Security Roles
          • Create Security Role
          • Maintain Security Roles
        • Security Groups
          • Security Group Aliases
          • Find Security Groups
          • Create Security Group
          • Maintain Security Groups
        • System Settings
          • General
          • Invoicing Preferences
        • Data Control
        • Widgets
        • API Requests
      • Master Data
        • Accounts
          • Account Mapping
        • Banks
        • Bunker Categories
        • Bunker Types
        • Business Partners
          • Manage Business Partners
        • Commodities
        • Companies
          • Manage Companies
        • Events
        • Ice Class
        • Individuals
        • Port
        • Restricted Areas
          • New Restricted Area: Mediterranean Sea (MEDECA)
          • Additional Fields: Start and End Dates
        • Routes
          • Manage Routes
        • Taxes
        • Various Costs and Revenues
        • Vessel Types
      • EU ETS Compliance
      • Fuel EU
      • Attachments
      • Audit Log
      • Bulk Update
      • Comments
      • Notifications
      • Field Validations
      • Sorting and Filtering Lists
      • Customising List Columns
      • Export to Excel Sheet
      • Widgets
    • Oracle Database Compatibility
  • Fleet Allocation & Scheduling
    • FAS: Step-By-Step Guides
      • Capacity Plan
      • Fleet Plans
        • Open Positions Board
        • Scheduler Board
        • Cargo Management Board
          • Cargo Actions
        • FAS Voyages List
        • FAS Cargoes List
        • Voyage Actions
      • Scenarios
        • Find Scenario
        • Create Scenario
        • Maintain Scenario
        • Copy Scenario
      • Budgets
        • Create Budget Scenario
        • Template Voyages
          • Create Template Voyages
          • Find Template Voyages
          • Maintain Template Voyages
        • Budgeted Voyages
          • Find Budgeted Voyages
          • Bulk Updating Budgeted Voyages
    • Create Voyages (JVMS)
      • Create Commitment
      • Create Commitment from CoA
      • Create Commitment from Voyage Estimate
  • Dataloy Distance Table (DDT)
    • About Dataloy Distances
    • Routing and routing options
    • Custom Point using Latitude and Longitude
    • High-Risk Area (HRA) / Piracy Routing
    • Distances API
    • Distances Change Log
  • Dataloy Systems AS
    • Privacy Policy
    • GDPR Statement
    • Release Notes
Powered by GitBook
On this page
  • API Requests
  • List View
  • Request Details
  • Audit Log
  • Notifications

Was this helpful?

Export as PDF
  1. Voyage Management System
  2. VMS: Step-By-Step Guides
  3. Setup

API Requests

PreviousWidgetsNextMaster Data

Last updated 3 months ago

Was this helpful?

API Requests

API Requests provides an overview of all API calls made in the system. The page is accessible for administrators from the Setup menu.

List View

The main view displays a list of all API calls with relevant request information. The list can be filtered using the search field and quick filters at the top and sorted by clicking the column headers.

Request Details

Clicking a row in the list opens a drawer with details about the API call. The Overview tab shows detailed information about the request and its contents.

Audit Log

The Audit Log tab provides a chronological overview of all changes made by the API call, showing the history of modifications made through this request.

Notifications

The Notifications tab shows webhook notifications that have been triggered by the API request. It displays information about each webhook notification.