Get feed definition by ID

GET

/v3/feeds/definitions/{id}

curl --request GET \
  --url https://us-gov.legion.picogrid.com/v3/feeds/definitions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

• US Government Production API
• Staging API
• Demo API

Retrieves a specific feed definition by its ID

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Successful response

Media typeapplication/json

object

category

required

string

Allowed values: MESSAGE FILE

created_at

required

string

data_type

required

string

description

string

entity_id

string format: uuid

feed_name

required

string

id

required

string format: uuid

integration_id

string format: uuid

is_active

required

boolean

is_template

required

boolean

metadata

object

organization_id

required

string format: uuid

schema_definition

object

template_id

string format: uuid

updated_at

required

string

Example

{
  "category": "MESSAGE",
  "created_at": "2023-12-15T14:30:00Z",
  "data_type": "application/json",
  "description": "Real-time sensor telemetry data from field devices",
  "entity_id": "e5f6a1b2-c3d4-7890-1234-567890abcdef",
  "feed_name": "sensor_telemetry",
  "id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "integration_id": "d4e5f6a1-b2c3-7890-1234-567890abcdef",
  "is_active": "true",
  "is_template": "false",
  "metadata": {
    "processing_pipeline": "temperature_normalization",
    "retention_policy": "30d",
    "source": "IoT Gateway",
    "update_frequency": "5s"
  },
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "schema_definition": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "properties": {
      "humidity": {
        "description": "Humidity percentage",
        "maximum": 100,
        "minimum": 0,
        "type": "number"
      },
      "temperature": {
        "description": "Temperature in Celsius",
        "maximum": 100,
        "minimum": -50,
        "type": "number"
      },
      "timestamp": {
        "description": "Measurement timestamp",
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "temperature",
      "humidity",
      "timestamp"
    ],
    "type": "object"
  },
  "template_id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
  "updated_at": "2023-12-15T14:30:00Z"
}

400

Bad Request

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "400",
  "details": "sample_value",
  "message": "Request cannot be processed due to invalid input",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

401

Unauthorized

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "401",
  "details": "sample_value",
  "message": "Authentication credentials are missing or invalid",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

403

Forbidden

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "403",
  "details": "sample_value",
  "message": "Access denied: insufficient permissions for this resource",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

404

Not Found

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "404",
  "details": "sample_value",
  "message": "The requested resource could not be found",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

500

Internal Server Error

Media typeapplication/json

object

category

required

The category of the error

string

code

required

The HTTP status code

number

details

required

Additional details about the error

Array<object>

object

field

The field that caused the error

string

issue

The specific issue with the field

string

message

required

A human-readable error message

string

status

required

The status of the response, always ‘error’ for error responses

string

timestamp

required

The timestamp when the error occurred

string format: date-time

trace_id

required

A unique identifier for tracing the error

string format: uuid

Example

{
  "category": "server_error",
  "code": "500",
  "details": [
    {
      "field": "field_name",
      "issue": "Field validation issue"
    }
  ],
  "message": "Internal Server Error",
  "status": "error",
  "timestamp": "2024-03-15T10:30:00Z",
  "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}