Add single

workflow

Adds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Request Body Parameters

Query String Parameters

Examples

Add a single workflow

Example

POST /aspire/_api/workflows?type=connector
{
  "description": "Publish to Elastic"
  ...
}

Response

{
  "serviceworkflow": {
    "id": "AAABcID5GBc=",
    "description": "Publish to Elastic",
    "type": "connector"
    ....
  },
  "message": "optional response message"
}

Status

: 200, 406

Update workflows, filtered

Update connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed

Delete workflow(s)

Delete one or more workflow from Aspire.

Path and Request Body Parameters

Common filter

Update body parameter

Response

{
  "message": "update result response message"
}

Status: 200, 406

Delete multiple workflows, filtered

Delete multiple workflows from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Common filter

Response

Delete workflow(s)

Delete one or more workflows from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters and Query parameters

Get a workflow plan

Get a plan from a workflow in Aspire.

Path Parameters

Body Parameter

ExamplesResponse

{
  "workflow": DELETE /aspire/_api/workflows/AAABcID5GBc

DELETE /aspire/_api/workflows?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/workflows/delete
{
    "idids": ["AAABcIueWUc=AAABcID5GBc","AAABcID5GBd"]
}

Response

{
    "descriptionmessage": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate"
    }
  }
  "message": "optional delete result response message"
}

Status

: 200, 404, 406

Get a workflow event

Get a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed

Create workflow plan(s)

Create one or more workflow plans in Aspire.

Path Parameters

ExamplesResponse

Create a single plan

{
  "idworkflow": "onScan"
}

Create multiple plans

[{
 {
    "id": "onScanAAABcIueWUc="
},
{
    "iddescription": "onAddUpdate"
}]

Create multiple plans (alternative version)

{
  "id": ["onScan", "onAddUpdate"]
}

Response

{
  "workflowPublish to Elasticsearch"
    "event": {
      "id": "AAABcIueWUc=onUpdate",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": ["onScan", "onAddUpdate"] ....
    }
  }
  "message": "optional response message"
}

Status

: 200, 404, 406

Get workflow events

Get a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed

Delete a workflow plan

Delete a workflow plan from Aspire.

Path and Request Body Parameters

Response

{
    "messageworkflow": {
 "optional response message"
}

Status

Create workflow event(s)

Create one or more workflow events in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters

Examples

Create multiple events (body parameter)

[{
  "id": "scan"
},
{
  "id": "addUpdate"
}]

Response

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": ["scan", "addUpdate"]
    }
  }
}

Status: 200, 404, 406

Delete a workflow event

Delete a workflow event from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path  Parameters

Response

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Create a workflow event item

Create a workflow event item - a rule, condition and the like, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters

Body Parameters

The request body parameters will differ depending on the type of item created. Some examples are shown below

Response

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=",
        ...
      }
    }
  }
}

Status: 200, 404, 406

Update a workflow event item

Update a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters

Body Parameters

The request body parameters will differ depending on the type of item created. Some examples are shown below

Response

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=",
        ...
      }
    }
  }
}

Status: 200, 404, 406

Delete single workflow event item

Delete a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters

Response

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Move a workflow event item

Move a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters

Body Parameters

Response

{
  "message": "move result response message"
}

Status: 200, 404, 406

Get workflow templates

Retrieve all workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed.

Path Parameters

Response

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    },
	  "id": "AAABcQwrWUd",
      ...
    }]
}

Status: 200, 404, 406

Get single workflow template

Retrieve a single workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed.

Path Parameters

Response

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    }]
}

Status: 200, 404, 406

Get single workflow rule

Get a single workflow rule from Aspire, this endpoint need the at least the OPERATOR role to be executed

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Response

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "planrule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "idtype": "onAddUpdateapplication",
    }
  }...
  "message": "optional response message"  }
  }
}

Status

Create a workflow rule

Create a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Path Parameters

Body Parameters

The request body parameters will differ depending on the type of rule created.

Optionally you may opt to add the created rule to a workflow event by adding the following query parameters

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Update single workflow rule

Updatee a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Body Parameters

The request body parameters will differ depending on the type of rule created. See Create a workflow rule above

Response

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "planrule": {
      "id": "ddSWeq123",
      "description": "Some "onAddUpdate"rule",
      "type": "application",
    }
  }...
  "message": "optional response message"
}

Status

  }
  }
}

Status: 200, 404, 406

Delete single workflow rule

Deletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Response

Response

{
  "message": "delete result 

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate"
    }
  }
  "message": "optional response message"
}

Status

: 200, 404, 406

Delete workflow rules

Deletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Query Parameters

Response

{
  "workflow": {
    "idmessage": "AAABcIueWUc=",
delete result response  "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate"
    }
  }
  "message": "optional response message"
}

Status

message"
}

Status: 200, 404, 406

Export workflow(s)

Export one or more workflows from Aspire, this endpoint needs at least the OPERATOR role to be executed.

Path Parameters and Query parameters

Body Parameter

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Examples

GET /aspire/_api/workflows/export/AAABcID5GBc

DELETE /aspire/_api/workflows/export?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/workflows/export
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

{
  "workflowexport": {
    "idworkflows": "AAABcIueWUc=",{
      "descriptionworkflow": "Publish[
  to Elasticsearch"
    "plan": {
          "id": "onAddUpdate<workflow_id>",
    }
  }
  "message": "optional response message"
}

Status

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters

Export multiple connections, filtered

Export multiple connections from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.

Filters: The connection filter definition here

Import

The import usage can be found here

Filters

Anchor
FiltersAnchor FiltersAnchor

 Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Seed filter:

{ 
  "filter" 

Get a workflow plan

Delete one or more services from Aspire.

Path and Request Body Parameters