EPCIS Connection

EPCIS connection collection manages external system connections, authentication credentials, and endpoint configurations for seamless data integration with partner EPCIS systems and external platforms.

The epcis_connection Object

EPCIS connection collection stores configuration details for external EPCIS system connections, including URLs, authentication methods, and connection metadata to facilitate secure data exchange.

Field Name	Type	Description
id	uuid	Primary key. Unique identifier for the EPCIS connection (UUID format).
user_created	string	User who created the connection. Foreign key reference to users table.
date_created	datetime	Timestamp when the connection was created.
user_updated	string	User who last updated the connection. Foreign key reference to users table.
date_updated	datetime	Timestamp when the connection was last updated.
url	string	Endpoint URL for the external EPCIS system.
connection_name	string	Human-readable name for the connection (e.g., "Siemens EPCIS System").
authentication_type	string	Authentication method used for the connection. Default: "api_key".
api_key	string	API key or authentication token for accessing the external system.

---

List EPCIS Connections

List existing EPCIS connections.

REST

GET /items/epcis_connection

GraphQL

query {
  epcis_connection {
    id
    user_created
    date_created
    user_updated
    date_updated
    url
    connection_name
    authentication_type
    api_key
  }
}

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit EPCIS connection objects. If no items are available, data will be an empty array.

---

Retrieve an EPCIS Connection

Retrieve a specific EPCIS connection by ID.

REST

GET /items/epcis_connection/:id

GraphQL

query {
  epcis_connection_by_id(id: "connection_id") {
    id
    user_created
    date_created
    user_updated
    date_updated
    url
    connection_name
    authentication_type
    api_key
  }
}

Returns

Returns an EPCIS connection object if a valid primary key was provided.

---

Create an EPCIS Connection

Create a new EPCIS connection.

REST

POST /items/epcis_connection

{
  "url": "https://partner-system.com/epcis/capture",
  "connection_name": "Partner EPCIS System",
  "authentication_type": "api_key",
  "api_key": "your-api-key-here"
}

GraphQL

mutation {
  create_epcis_connection_item(data: {
    url: "https://partner-system.com/epcis/capture"
    connection_name: "Partner EPCIS System"
    authentication_type: "api_key"
    api_key: "your-api-key-here"
  }) {
    id
    url
    connection_name
    authentication_type
    date_created
  }
}

Query Parameters

Supports all global query parameters.

Request Body

A partial EPCIS connection object.

Returns

Returns the EPCIS connection object for the created EPCIS connection.

---

Update an EPCIS Connection

Update an existing EPCIS connection.

REST

PATCH /items/epcis_connection/:id

{
  "url": "https://updated-partner-system.com/epcis/capture",
  "connection_name": "Updated Partner EPCIS System",
  "api_key": "new-api-key-here"
}

GraphQL

mutation {
  update_epcis_connection_item(id: "connection_id", data: {
    url: "https://updated-partner-system.com/epcis/capture"
    connection_name: "Updated Partner EPCIS System"
    api_key: "new-api-key-here"
  }) {
    id
    url
    connection_name
    date_updated
  }
}

Query Parameters

Supports all global query parameters.

Request Body

A partial EPCIS connection object.

Returns

Returns the EPCIS connection object for the updated EPCIS connection.

---

Delete an EPCIS Connection

Delete an existing EPCIS connection.

REST

DELETE /items/epcis_connection/:id

GraphQL

mutation {
  delete_epcis_connection_item(id: "connection_id") {
    id
  }
}

Returns

Empty body.

---

Sample Data

Example EPCIS Connection Record

{
  "id": "61d53401-2888-4994-80f9-555e8ef6f567",
  "user_created": "91456280-d821-4ae6-a29d-54affcf89791",
  "date_created": "2025-01-07T13:15:59.000Z",
  "user_updated": "91456280-d821-4ae6-a29d-54affcf89791",
  "date_updated": "2025-01-10T10:20:59.000Z",
  "url": "https://epcis.acme.com/capture",
  "connection_name": "Acme Corp EPCIS System",
  "authentication_type": "api_key",
  "api_key": "abc"
}