Get several components

GET 
/components

Get a list of model components (diagram and evaluatable) the user has permission to access.

Results include all types of components, marked with a componentType field:

• diagram: See Retrieve a Diagram
• evaluatable: See Retrieve an evaluatable

NOTE: This proposed endpoint is an aggregate collection, returning a list of instances from multiple resource types.
We're not yet sure if this is a good idea! If you have thoughts or feedback about common functionality that would justify this sort of aggregate collection, talk to us about it!

TODO:

• Allow filter parameters.
• Add query/response parameters for pagination.

Request

Responses

200

OK

application/json

Schema

Schema

• Array [

componentType required

Possible values: [evaluatable, diagram]

uuid uuidrequired

Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

• ]

Example (from schema)

[
  {
    "uuid": "d74bacf2-3867-42c0-8937-db434be33c68",
    "componentType": "evaluatable"
  },
  {
    "uuid": "81ca85d3-1621-498f-a74a-0957531e7330",
    "componentType": "evaluatable"
  },
  {
    "uuid": "a4c785cb-bb11-4c0e-9f05-38aef4288229",
    "componentType": "diagram"
  },
  {
    "uuid": "8d8e3795-d969-4f8e-ad42-8de12909acce",
    "componentType": "evaluatable"
  }
]

Loading...