🖍️
Dataloy VMS API Documentation
API Release 8.6
API Release 8.6
  • Dataloy VMS API
  • Dataloy Rest API
    • What is it?
    • Authentication / Authorization
    • Getting Started
    • Data Model
    • Filtering
    • Sorting
    • Pagination
    • Adjust Number of Fields to be Returned from a Request
    • Webhooks
      • Webhook example
      • Expressions Made Easy
      • Webhooks - New functionalities
    • Master data Objects
    • Attachments
    • Audit Log
  • User Guides
    • Accounting Integration API
      • Invoicing
      • Payments/Receipts
      • Voyages
      • Business Partners
      • Exchange Rates
      • Bunker Transactions
      • Actuals
      • Autopost Invoices
      • Accruals
    • Schedule API
    • Bunker Order Integration API
    • Service Order Integration API
    • Vessel Report
      • Overview
      • Legacy version (6.26 - 6.28)
      • Vessel report master data
    • Bunker Consumption API
    • Left join in API queries
    • Enterprise functionalities
      • Versioning
      • Endpoint access control
      • Data access control via target object
      • Data access control via target object and security role
      • Data access control at object level
      • Fields access control
      • Alert Scripts
      • Websockets
      • Bulk Deletion
      • Copy objects
      • OR and AND operators in API queries
      • Sub queries
      • XML Transformation
      • Expressions
      • Bulk Update
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Dataloy Rest API

Master data Objects

It is possible to activate and deactivate any Master Data object. A new property has been added for this purpose, isObjectActive.

To deactivate an object the following JSON has to be used in the PUT method:

To activate an object the following JSON has to be used in the PUT method:

Master Data objects has to be deactivated before they can be deleted.

Deactivated objects are not included in standard Master Data list query results. To work with these objects:

Retrieving Deactivated Objects

  • Via List Query: To retrieve deactivated objects in a list query, add the filter parameter isObjectActive(EQ)false to your request.

  • Via Direct Access: Individual deactivated objects remain accessible by their unique key, regardless of activation status.

Example using BusinessPartner master data object

// Standard query - returns only active business partners
GET /BusinessPartner

// Query deactivated business partners
GET /BusinessPartner?filter=isObjectActive(EQ)false

// Retrieving specific deactivated business partner by key
GET /BusinessPartner/{objectKey}
PreviousWebhooks - New functionalitiesNextAttachments

Last updated 1 month ago

Was this helpful?

{
	"isObjectActive": false
}
{
	"isObjectActive": true
}