Skip to main content

validateICollectionMarker

Check whether a collection marker is free to use.

Description​

Resolves to an ICollectionIsValid object. valid is true when no collection uses this marker yet, so you can use it for a new collection, and false when a collection with this marker already exists.

.validateICollectionMarker(

);

Parameters schema​

Schema

marker(required): string
Marker of the collection.
example: "collection1"

Examples​

Minimal example​

const result = await IntegrationCollections.validateICollectionMarker('test_collection');

Example response​

{
  "valid": false
}

Response schema​

Schema: ICollectionIsValid

valid: boolean
true if no collection uses this marker (it is available); false if a collection with this marker already exists.
example: true