Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Where paging parameters are applied, Aspire will add a "count" to the returned object to inform the total number of objects that exists (the fields being from, size, totalItems) TODO: not implemented

Anchor
SortingQueryStringParameters
SortingQueryStringParameters
Sorting query string parameters TODO: not implemented

...

Anchor
ResponseBody
ResponseBody
Response Body

This is an example of the response to this GETrequest - - /aspire/_api/workflows?sparse=true&from=0&size=2

Code Block
languagejs
{
    "count": {
        "from": 0,
        "size": 2,
        "totalItems": 3
    },
    "workflow": [
        {
            "id": "f5daef4d-fd4b-4e01-bd7b-b00334601b73",
            "type": "connector",
            "description": "Publish to Elastic-1",
            "checksum": "b0bb8b191d7bba8a0c32b8db091937a617e14ad0e768da2c0a75e360aff45430"
        },
        {
            "id": "e33a890a-cea9-48c0-8db9-07533444820f",
            "type": "connector",
            "description": "Publish to Elastic-1",
            "checksum": "1d3e041ca4de48edcee85d46217d928846077277f39d07eac6e4206a2ce8966d"
        }
    ]
}


Where an API call causes a single item to be successful created or updated, the body of the response will contain the item itself. The response shown below is an example of the body returned if a single connector was created or updated (response status 200 or 201)

...