Skip to main content

Platform and security


Policy​

A policy gives or denies people access to data and features. Service: Policy (policy/v1).

FieldTypeRequiredWhat it is
_idStringYesThe policy id. It cannot end with -built-in or match a built-in policy
_typeStringYesPolicy, FeaturePolicy or RedactionPolicy
serviceStringYes for PolicyThe service it covers, or * for all
sourceStringNoThe source it covers, defaults to private
conditionStringNoA filter on the items it covers. Saved with the filter turned into a query in query
actionsString[]Nocreate, read, update, delete, run, editPublicTypeProperties, editPrivateTypeProperties
membersString[]NoUser emails and security group ids, or * for everyone
featuresString[]Yes for FeaturePolicyThe features the policy gives
denyBooleanNoTrue for a deny policy
enabledBooleanNoFalse to switch it off, defaults to true
category, descriptionStringNoDescriptive fields
tagsString[]NoTags
{
"_id": "nge-gas-desk-write",
"_type": "Policy",
"category": "Desks",
"description": "The gas desk can change gas master data",
"service": "object",
"source": "private",
"condition": "commodity='Natural Gas'",
"actions": ["read", "create", "update"],
"members": ["priya.shah@northgate-energy.com", "tom.clarke@northgate-energy.com"],
"deny": false,
"enabled": true
}

Group​

A group is a list of items from another service, kept by name. Service: Group (group/v1), versioned.

FieldTypeRequiredWhat it is
_idStringNoMade for you when you create a group
_typeStringPlatformVarGroup
nameStringYesThe name
typeStringYesThe kind of group, for example favourite, build, quality, approval or export
categoryStringYesA category
serviceStringYesThe service the items come from, for example object or data
descriptionStringNoA description
sharedBooleanNoTrue to share it with everyone in your company, defaults to false
itemsString[]NoThe item ids, for a static group
dynamicBooleanNoTrue to find the items with a filter instead of listing them
dynamicOptionsObjectNoFor a dynamic group: filter (or objectFilter to filter on master data), service, source and field (the id field, defaults to _id)
{
"name": "NGE gas forwards",
"type": "favourite",
"category": "object",
"service": "object",
"shared": true,
"dynamic": true,
"dynamicOptions": {"filter": "source='ICE' and commodity='Natural Gas'"}
}

List​

A list of master data objects that someone makes in the portal. Service: List (list/v1).

FieldTypeRequiredWhat it is
_idStringNoAn object id, made for you if not given
nameStringYesThe name
objectsString[]YesThe object ids
visibilityStringNoprivate (the default) or shared
ownerStringPlatformWho made it
{
"name": "Gas desk watch list",
"objects": ["NGE.GAS.TTF", "NGE.GAS.NBP", "NGE.GAS.ZTP"],
"visibility": "shared"
}

Secret​

Service: Secret (secret/v1).

FieldTypeRequiredWhat it is
_idStringYesThe secret name
_typeStringNoVarSecret
valueStringYesThe secret
enabledBooleanNoDefaults to true
notBefore, expiresDateNoWhen the secret is valid from and to
vaultStringPlatformclient when the value is kept in your own Azure Key Vault
{"_id": "ice-sftp-password", "_type": "VarSecret", "value": "s3cr3t", "enabled": true, "expires": "2027-06-30"}

Setting​

A personal setting, such as the last filter used on a screen. Service: Setting (setting/v1).

FieldTypeRequiredWhat it is
nameStringYesThe setting name. Names starting with # are kept centrally
(any name)AnyNoThe values to keep
_id, _userStringPlatformThe id and your user id
{"name": "smart-data.list.filters", "category": "Spread", "commodity": "Power"}

Documentation​

A document about something on the platform. Service: Documentation (documentation/v1/{source}), versioned.

FieldTypeRequiredWhat it is
_typeStringPlatformVarDocumentation
documentationTypeStringNoDefault (markdown in content, the default), Link (a page at url) or JSON (data in json)
scope, entity, nameStringNoWhat the document is about, for example object, NGE.GAS.TTF and overview. None of them may contain a colon
languageStringNoThe language code, defaults to the request's language or en
contentStringFor DefaultThe markdown. Front matter (scope, entity, name, language, source, tags) is read into the other fields
url, selectorStringFor LinkThe page, and an optional CSS selector for the part to show
json, templateFor JSONThe data, and an optional template
tagsString[]PlatformFrom the front matter
sourceStringNoprivate, unless you are an OpenDataDSL administrator

Read a document with documentation/v1/private/scope:entity:name.

{
"documentationType": "Default",
"scope": "object",
"entity": "NGE.GAS.TTF",
"name": "overview",
"content": "# TTF\n\nThe Dutch Title Transfer Facility gas price used by the Northgate gas desk."
}

Extension​

An extension adds screens and resources to the portal. Service: Extension (extension/v1/{source}).

FieldTypeWhat it is
_idStringpublisher.code
_typeStringVarExtension
publisher, codeStringThe parts of the id
name, description, iconStringShown in the extension catalog
documentationStringA link to the documentation
tagsString[]Catalog tags
currency, priceStringThe price, 0 for free
previewBooleanOnly installable in the preview environment
plugin, standaloneBooleanSet for plug-ins and stand-alone extensions
dependenciesArrayThe extensions it needs
viewsArrayThe screens: id, name, description, section, tabname, appname, excel, insights, home, icon, feature, order and script (the mustache template)
resourcesObjectWhat is installed with it, by service name: a list of ids, or an object of names to ids. script can name install, upgrade and uninstall scripts
configurationObjectSettings for the extension
{
"_id": "nge.positions",
"_type": "VarExtension",
"publisher": "nge",
"code": "positions",
"name": "Northgate positions",
"description": "Net positions by desk and month",
"icon": "bar-chart-line",
"tags": ["trading"],
"price": "0",
"views": [
{"id": "main", "name": "Positions", "section": "Trading", "tabname": "Main", "icon": "bar-chart-line", "script": "nge.positions.main"}
],
"resources": {
"script": {"main": "nge.positions.main", "install": "nge.positions.install"},
"policy": ["extension.nge.positions"]
}
}

Index​

An index on the data in one of your services, to make queries faster. Service: Index (index/v1/{service}).

FieldTypeRequiredWhat it is
nameStringYesThe index name
keyObjectYesThe fields, each with 1 (ascending) or -1 (descending)
unique, sparse, hiddenBooleanNoIndex options
expireAfterSecondsIntegerNoRemove documents after this many seconds
partialFilterExpressionObjectNoOnly index documents that match
collationObjectNoLanguage rules for comparing strings
{"name": "commodity_location", "key": {"commodity": 1, "location": 1}}

Environment​

A data environment. Service: Environment (environment/v1).

FieldTypeWhat it is
_idStringThe environment id
nameStringThe name
descriptionStringA description
_createdBy, _timestampPlatform: who created it and when
_sizeIntegerPlatform: the size of its data

Tenant​

Your company. Service: Tenant (tenant/v1).

FieldTypeWhat it is
_idStringYour tenant id
nameStringYour company name
propertiesObjectYour company details: name, address1, address2, city, postcode, email, phone, accountContact. Sent properties replace the saved ones
accountContactsObjectYour account contacts
preferencesObjectCompany preferences
mongodb, connectionsStringYour own MongoDB connection strings, which must start with mongodb
settingsObjectPlatform settings. Only OpenDataDSL can change them
pricing, quotaObjectYour plan and quotas. Only OpenDataDSL can change them
{
"properties": {
"name": "Northgate Energy",
"address1": "1 Harbour Street",
"city": "Aberdeen",
"postcode": "AB11 5AA",
"email": "accounts@northgate-energy.com"
}
}

User​

Your user record. Service: User (user/v1).

FieldTypeWhat it is
_idStringThe record id
idStringYour user id
emailStringYour email
tid, tenantStringYour tenant id and name
propertiesObjectYour details, for example firstname, lastname, nickname
connectionsObjectYour connections to other systems
keysArrayYour API keys, without the key itself: name, start, expires, timestamp

To make an API key, POST {"api-key": "create", "name": "etrm-feed", "expires": "2027-10-31"}; to delete one, send "api-key": "delete" with its name.


Logs and usage records​

These records are written by the platform and are read-only.

EntityServiceFields
Audit entryAudit_id, timestamp, user, service, id, ref, version, action (create, update, delete and so on), description, reason, status (the HTTP status), change (what changed)
MetricMetric_id, timestamp, type (api, message, process or storage), service, action, method, application, environment, user, value, duration (ms), responseSize, httpstatus, detail, invocationId
InvoiceBillingref, date, year, month, tenant, tid, name, address, pricingPlan, charges, vat, total, detail (the invoice lines)
User eventUser Eventemail, action (add, delete or invite), users (the number of users after it), timestamp
UnitUnitcode, name, dimension, factor (to the base unit of the dimension), metric, prefix, conversions (each dimension, unit and requiredParameter)
FunctionFunctionname, category, class, description, constructor, params (each name, description, type), returns, tags, link
{
"_id": "673b9f2e8c1d4a5e6f708192",
"timestamp": "2026-11-18T18:12:03.601",
"user": "priya.shah@northgate-energy.com",
"service": "object",
"id": "NGE.POWER.DE",
"version": 3,
"action": "update",
"reason": "Added German peak hours",
"status": 200
}