Get Entity Detail API

This API retrieves the full details of a specific rule or workflow. It’s typically used when you need to inspect input parameters, version, status, or workflow graph before invoking or updating the entity in your applications.

Authentication

All requests require your Nected API key:

Nected-API-Key: <YOUR_API_KEY>

Endpoint

GET https://api.nected.ai/dev/{entityType}/{entityId}

Path Parameters

Name	Type	Required	Description
entityType	string	Yes	rule or workflow
entityId	string	Yes	The entity’s unique identifier (UUID)

Headers

Header	Value	Required
Nected-API-Key	Your API key string	Yes

Example (cURL)

curl --location "https://api.nected.ai/dev/rule/11111111-aaaa-bbbb-cccc-222222222222" \
  --header "Nected-API-Key: <YOUR_API_KEY>"

Example (JavaScript / fetch)

const url = "https://api.nected.ai/dev/workflow/33333333-aaaa-bbbb-cccc-444444444444";
const res = await fetch(url, { headers: { "Nected-API-Key": "<YOUR_API_KEY>" }});
const data = await res.json();

Sample Response (Rule)

{
  "data": {
    "entityId": "11111111-aaaa-bbbb-cccc-222222222222",
    "name": "OrderValidationRules",
    "description": "Rules for validating customer orders",
    "type": "decisionTable",
    "params": [
      {
        "name": "customer_id",
        "dataType": "numeric",
        "type": "dataSet",
        "isOptional": false,
        "isNullable": false,
        "isCaseSensitive": false
      },
      {
        "name": "item_details",
        "dataType": "json",
        "type": "primitive",
        "isOptional": false,
        "isNullable": false,
        "isCaseSensitive": false
      }
    ],
    "status": "draft",
    "version": "v1",
    "endpoints": "https://nected.ai/nected/rule/11111111-aaaa-bbbb-cccc-222222222222"
  },
  "code": "success",
  "message": "Success."
}

Sample Response (Workflow)

{
  "data": {
    "entityId": "33333333-aaaa-bbbb-cccc-444444444444",
    "name": "DiscountWorkflow",
    "description": "Workflow for applying seasonal discounts",
    "type": "workflow",
    "data": {
      "nodes": [
        {
          "id": "1",
          "type": "trigger",
          "name": "API Trigger",
          "settings": {
            "authType": "private",
            "isEnabled": true
          }
        },
        {
          "id": "2",
          "type": "sleepNode",
          "name": "Wait Node",
          "settings": {
            "durationValue": 5,
            "durationUnit": "m"
          }
        }
      ],
      "edges": [
        { "id": "edge_1", "source": "1", "target": "2", "type": "smoothEdge" }
      ]
    },
    "status": "published",
    "version": "v2",
    "endpoints": "https://nected.ai/nected/workflow/33333333-aaaa-bbbb-cccc-444444444444"
  },
  "code": "success",
  "message": "Success."
}

Field Reference

• entityId (string): Unique ID of the entity.

• name (string): Display name.

• description (string): Summary of purpose.

• type (string): decisionTable, workflow, etc.

• params (array, rules): Input schema for rule evaluation.

  • name (string), dataType (string), type (string), isOptional (bool), isNullable (bool), isCaseSensitive (bool).

• data (object, workflows): Graph structure with nodes[] and edges[].

• status (string): draft | published.

• version (string): Version label.

• endpoints (string): Console URL for quick access.

Errors

HTTP	Code	Meaning	Action
401	UNAUTHORIZED	Missing/invalid API key	Check Nected-API-Key.
404	NOT_FOUND	Entity not found	Verify entityType and entityId.
429	TOO_MANY_REQUESTS	Rate limit exceeded	Backoff + retry with jitter.
500	INTERNAL_SERVER_ERROR	Unexpected error	Retry; contact support if persistent.