Learn

Ecosystems

Retrieve all ecosystems

Retrieves a list of ecosystems.

Analytic events

  • ECOSYSTEM_RETRIEVE_LIST_START
  • ECOSYSTEM_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of the list, default 100

Example: limit=2
cursor
string

Starting point for the list

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Ecosystems retrieved

400

Bad Request. The request was malformed or missing required parameters.

get/v1/ecosystems
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
Create ecosystem
Creates an ecosystem.


Analytic events


    

  • ECOSYSTEM_CREATE_START
    • 

  • ECOSYSTEM_CREATE_SUCCESS
    • 

  • ECOSYSTEM_CREATE_FAIL
    • 



SecuritybearerAuth 
Request 
Request Body schema: application/json
required
name
string  [ 1 .. 50 ] characters 
The name of the ecosystem.


 
Responses 
201
Ecosystem created


400
Bad Request. The request was malformed or missing required parameters.


500
Internal Server Error. An unexpected error occurred.


post/v1/ecosystems
Request samples 
application/json
{
  • "name": "My Ecosystem"
}
Response samples 
application/json
{
  • "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "name": "My Ecosystem"
}
Retrieve ecosystem
Retrieves an ecosystem by its ID.


Analytic events


    

  • ECOSYSTEM_RETRIEVE_START
    • 

  • ECOSYSTEM_RETRIEVE_SUCCESS
    • 

  • ECOSYSTEM_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses 
200
Ecosystem retrieved


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


get/v1/ecosystems/{ecosystemId}
Request samples 
Response samples 
application/json
{
  • "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "name": "My Ecosystem"
}
Update ecosystem
Updates an ecosystem by its ID.


Analytic events


    

  • ECOSYSTEM_UPDATE_START
    • 

  • ECOSYSTEM_UPDATE_SUCCESS
    • 

  • ECOSYSTEM_UPDATE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses 
200
Ecosystem updated


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


put/v1/ecosystems/{ecosystemId}
Request samples 
Response samples 
application/json
{
  • "id": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "name": "My Ecosystem"
}
Delete ecosystem
Deletes an ecosystem by its ID.


Analytic events


    

  • ECOSYSTEM_DELETE_START
    • 

  • ECOSYSTEM_DELETE_SUCCESS
    • 

  • ECOSYSTEM_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses 
204
Ecosystem deleted


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


500
Internal Server Error. An unexpected error occurred.


delete/v1/ecosystems/{ecosystemId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Participants