Retrieve all ecosystems
Retrieves a list of ecosystems.
Analytic events
- ECOSYSTEM_RETRIEVE_LIST_START
- ECOSYSTEM_RETRIEVE_LIST_SUCCESS
- ECOSYSTEM_RETRIEVE_LIST_FAIL
Ecosystems retrieved
Bad Request. The request was malformed or missing required parameters.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "data": [
- {
- "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Ecosystem",
- "integrations": [
- {
- "format": "MATTR",
- "enabled": true,
- "integrationResult": {
- "success": true,
- "lastSyncedAt": "2024-09-10T02:28:36.550Z",
- "lastModifiedAt": "2024-08-10T02:28:36.550Z",
- "failReasons": [
- {
- "type": null,
- "message": null
}
]
}
}
]
}
], - "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}Create ecosystem
Creates an ecosystem.
Analytic events
- ECOSYSTEM_CREATE_START
- ECOSYSTEM_CREATE_SUCCESS
- ECOSYSTEM_CREATE_FAIL
Request Body schema: application/jsonrequired
| name required | string [ 1 .. 50 ] characters The name of the ecosystem. |
Array of MATTR Integration (object) or VICAL Integration (object) Details external trust sources which are integrated into the ecosystem. These can be either a different ecosystem or a VICAL. |
Ecosystem created
Bad Request. The request was malformed or missing required parameters.
Internal Server Error. An unexpected error occurred.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "name": "My Ecosystem",
- "integrations": [
- {
- "format": "MATTR",
- "enabled": true
}
]
}- 201
- 400
{- "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Ecosystem",
- "integrations": [
- {
- "format": "MATTR",
- "enabled": true,
- "integrationResult": {
- "success": true,
- "lastSyncedAt": "2024-09-10T02:28:36.550Z",
- "lastModifiedAt": "2024-08-10T02:28:36.550Z",
- "failReasons": [
- {
- "type": "UnknownVerificationError",
- "message": "Unknown verification error occurred"
}
]
}
}
]
}Sync ecosystem
Synchronises all configured consumptions and integrations by retrieving the most recent trust information.
Analytic events
- ECOSYSTEM_TENANT_SYNC_ALL_START
- ECOSYSTEM_TENANT_SYNC_ALL_SUCCESS
- ECOSYSTEM_TENANT_SYNC_ALL_FAIL
Ecosystem sync request accepted.
Bad Request. The request was malformed or missing required parameters.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 202
- 400
{- "tenantConfiguration": {
- "ecosystems": [
]
}, - "integrations": [
- {
- "format": "MATTR",
- "enabled": true
}
]
}Retrieve ecosystem
Retrieves an ecosystem by its ID.
Analytic events
- ECOSYSTEM_RETRIEVE_START
- ECOSYSTEM_RETRIEVE_SUCCESS
- ECOSYSTEM_RETRIEVE_FAIL
Ecosystem retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Ecosystem",
- "integrations": [
- {
- "format": "MATTR",
- "enabled": true,
- "integrationResult": {
- "success": true,
- "lastSyncedAt": "2024-09-10T02:28:36.550Z",
- "lastModifiedAt": "2024-08-10T02:28:36.550Z",
- "failReasons": [
- {
- "type": "UnknownVerificationError",
- "message": "Unknown verification error occurred"
}
]
}
}
]
}Update ecosystem
Updates an ecosystem by its ID.
Analytic events
- ECOSYSTEM_UPDATE_START
- ECOSYSTEM_UPDATE_SUCCESS
- ECOSYSTEM_UPDATE_FAIL
Ecosystem updated
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
Internal Server Error. An unexpected error occurred.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "name": "My Ecosystem",
- "integrations": [
- {
- "format": "MATTR",
- "enabled": true
}
]
}- 200
- 400
{- "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
- "name": "My Ecosystem",
- "integrations": [
- {
- "format": "MATTR",
- "enabled": true,
- "integrationResult": {
- "success": true,
- "lastSyncedAt": "2024-09-10T02:28:36.550Z",
- "lastModifiedAt": "2024-08-10T02:28:36.550Z",
- "failReasons": [
- {
- "type": "UnknownVerificationError",
- "message": "Unknown verification error occurred"
}
]
}
}
]
}Delete ecosystem
Deletes an ecosystem by its ID.
Analytic events
- ECOSYSTEM_DELETE_START
- ECOSYSTEM_DELETE_SUCCESS
- ECOSYSTEM_DELETE_FAIL
Ecosystem deleted
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
Internal Server Error. An unexpected error occurred.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
{- "code": "string",
- "type": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}