Nected Dev API
The Dev API from Nected — 7 operation(s) for dev.
OpenAPI Specification
openapi: 3.0.3
info:
title: Nected Dev API
description: Nected is a low-code workflow automation and decision engine platform. The API enables triggering of rules and workflows, listing and inspecting entities, managing global variables, retrieving audit logs, and checking usage.
version: '1.0'
contact:
name: Nected
url: https://www.nected.ai
servers:
- url: https://api.nected.ai
description: Nected production API (management endpoints)
- url: https://nected-59.nected.io
description: Nected rule/workflow execution endpoint (replace with your tenant)
security:
- NectedApiKey: []
tags:
- name: Dev
paths:
/dev/usage:
get:
summary: Check usage
description: Returns the count of total invocations recorded for the workspace.
operationId: checkUsage
responses:
'200':
description: Usage data
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
invocations:
type: integer
code:
type: string
message:
type: string
tags:
- Dev
/dev/audit/audit/search:
get:
summary: Search audit logs
description: Retrieve audit log entries with filtering and pagination.
operationId: searchAuditLogs
parameters:
- name: pageNo
in: query
schema:
type: integer
default: 1
- name: pageSize
in: query
schema:
type: integer
default: 10
maximum: 10
- name: search
in: query
schema:
type: string
- name: type
in: query
schema:
type: string
enum:
- ruleSet
- simpleRule
- dataSet
- connector
- name: event
in: query
schema:
type: string
enum:
- test
- api
- roleRevoke
- webhook
- name: status
in: query
schema:
type: string
enum:
- success
- error
- name: startDate
in: query
schema:
type: string
format: date-time
- name: endDate
in: query
schema:
type: string
format: date-time
responses:
'200':
description: Audit log results
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
pageNo:
type: integer
pageSize:
type: integer
data:
type: array
items:
type: object
code:
type: string
message:
type: string
'401':
description: Unauthorized
'404':
description: Not found
tags:
- Dev
/dev/audit/audit/{logId}:
get:
summary: Get audit log detail
operationId: getAuditLog
parameters:
- name: logId
in: path
required: true
schema:
type: string
responses:
'200':
description: Audit log entry
'401':
description: Unauthorized
'404':
description: Not found
tags:
- Dev
/dev/{entityType}:
get:
summary: List rules or workflows
operationId: listEntities
parameters:
- name: entityType
in: path
required: true
schema:
type: string
enum:
- rule
- workflow
- name: page
in: query
schema:
type: integer
default: 1
- name: perPage
in: query
schema:
type: integer
default: 10
- name: sortBy
in: query
schema:
type: string
enum:
- name
- status
- updatedAt
- createdAt
- version
- name: sortDir
in: query
schema:
type: string
enum:
- asc
- desc
- name: status
in: query
schema:
type: string
- name: name
in: query
schema:
type: string
- name: type
in: query
schema:
type: string
enum:
- decisionTable
- ruleset
- workflow
- name: q
in: query
schema:
type: string
- name: tags
in: query
schema:
type: string
- name: createdAtFrom
in: query
schema:
type: string
format: date-time
- name: createdAtTo
in: query
schema:
type: string
format: date-time
- name: updatedAtFrom
in: query
schema:
type: string
format: date-time
- name: updatedAtTo
in: query
schema:
type: string
format: date-time
- name: createdBy
in: query
schema:
type: string
- name: updatedBy
in: query
schema:
type: string
responses:
'200':
description: Paginated entity list
'401':
description: Unauthorized
'429':
description: Rate limited
tags:
- Dev
/dev/{entityType}/{entityId}:
get:
summary: Get rule or workflow detail
operationId: getEntity
parameters:
- name: entityType
in: path
required: true
schema:
type: string
enum:
- rule
- workflow
- name: entityId
in: path
required: true
schema:
type: string
- name: view
in: query
schema:
type: string
enum:
- summary
- full
- name: include
in: query
schema:
type: string
- name: version
in: query
schema:
type: string
- name: expand
in: query
schema:
type: string
responses:
'200':
description: Entity detail
'401':
description: Unauthorized
'404':
description: Not found
tags:
- Dev
/dev/variable:
get:
summary: List global variables
operationId: listGlobalVariables
responses:
'200':
description: Paginated list of variables
tags:
- Dev
post:
summary: Create a global variable
operationId: createGlobalVariable
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- dataType
- value
properties:
name:
type: string
dataType:
type: string
value: {}
responses:
'201':
description: Created
tags:
- Dev
/dev/variable/{name}:
get:
summary: Get a global variable
operationId: getGlobalVariable
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: Variable detail
tags:
- Dev
patch:
summary: Update a global variable
operationId: updateGlobalVariable
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: checksum
in: header
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- value
properties:
value: {}
responses:
'200':
description: Updated
tags:
- Dev
delete:
summary: Delete a global variable
operationId: deleteGlobalVariable
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: checksum
in: header
required: true
schema:
type: string
responses:
'200':
description: Deleted
tags:
- Dev
components:
securitySchemes:
NectedApiKey:
type: apiKey
in: header
name: nected-api-key