Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The workflow API provides functionality that allows a administrator to perform actions such as adding and configuring workflow

Table of Contents

Section

List workflows

Lists all the workflows configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow

Query String Parameters

Name	Type	Required	Description
description	string	Optional	Filter workflows to only those whose description matches the given expression
sparse	boolean	Optional	Only return minimal data such as identifier, description, name etc

Response

Code Block

language	js

{
  "workflow": [{
    "id": "AAABcID5GBc=",
    "description": "Publish to Elasticsearch",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "description": "Normalise data",
    ...
  }],
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Section

Get a single workflow

Get information about a single workflow in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the workflow to return

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcID5GBc=",
    "description": "Publish to Elasticsearch",
    ...
  },
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given workflow id was not found

Section

Add a workflow

Adds a workflow to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/workflow

Request Body Parameters

Name	Type	Required	Description
description	string	Required	A description of the workflow

Query String Parameters

Name

Type

Required

Description

type

string

Required

Accepted values are: "connector" and "service"

If connector is set the workflow created with the following events will be created:

scan
addUpdate
delete
publish
error

If service is set the workflow will be created without events.

Examples

Add a single workflow

Code Block

language	js

{
  "description": "Publish to Elastic"
}

Response

Code Block

language	js

{
  "workflow": [{
    "id": "AAABcID5GBc=",
    "description": "Publish to Elastic",
    "type": "service"
  }],
  "message": "optional response message"
}

Status

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Section

Delete workflow(s)

Delete one or more workflow from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflows/:id

DELETE /aspire_api/workflows

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the workflow(s) to delete

Examples

Delete a single workflow

Code Block

language	js

DELETE /aspire_api/workflows/AAABcID5GBc=

Delete multiple workflows

Code Block

language	js

DELETE /aspire_api/workflows?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D

Response

Code Block

language	js

{
	"message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get a workflow event

Get a event from a workflow in Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/:eventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to return
eventId	string	Required	The identifier of the event to get

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Create workflow event(s)

Create one or more workflow events in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/workflow/:id

PUT /aspire_api/workflow/:id/:eventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to add a event to
eventId	string	Required	The identifier of the event to add

Examples

Create a single event

Code Block

language	js

{
  "id": "scan"
}

Create multiple events

Code Block

language	js

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

Create multiple events (alternative version)

Code Block

language	js

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

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete a workflow event

Delete a workflow event from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflow/:id/:eventId

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to use
eventId	string	Required	The identifier of the event to delete

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Create a workflow event item

Create a workflow event item - a rule, condition and the like.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/workflow/:id/:eventId/:type

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to return
eventId	string	Required	The identifier of the event to get
type	string	Required	The type of the item to create

Request Body Parameters

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

Item Type	Parameter Name	Parameter Type	Required	Description
Rule	<TODO>
Application Rule
Condition
Exit

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Update a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/workflow/:id/:eventId/:itemId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to use
eventId	string	Required	The identifier of the event to use
itemId	string	Required	The identifier of the item to update

Request Body Parameters

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

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflow/:id/:eventId/:itemId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
eventId	string	Required	The identifier of the event to use
itemId	string	Required	The identifier of the node item to delete

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Move a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT/aspire_api/workflow/:id/move/:eventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
eventId	string	Required	The identifier of the event to use

Body Parameters

Name	Type	Required	Description
src	string	Required	The identifier of the event item to move
dest	string	Required	The identifier of the new parent for the moved item

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get workflow templates - Review pending

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflows/:id/template

Path and Query String Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to get the templates for
description	string	Optional	Filter workflows to only those whose description matches the given expression

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    }]
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get a workflow template - Review pending

Retrieve a workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/template/:templateId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to get the templates for
templateId	string	Required	The identifier of the template to get

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    }]
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get workflow rules

Get all the rules for a given workflow.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflows/:id/rules

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to return rules for

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "addUpdate",
      "rule": [{
        "id": "ddSWeq123",
        "description": "Some rule",
        "type": "application",
        ...
      },
      {
        "id": "ddSWeq124",
        "description": "Some rule",
        "type": "groovy",
        ...
      }]
    }
  }
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get a workflow rule

Get one or more workflow rule from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/rule/:ruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to return rules for
ruleId	string	Required	The identifier of the rule to get

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Create a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/workflow/:id/rule

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to create a rule for

Request Body Parameters

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

Rule Type	Parameter Name	Parameter Type	Required	Description
groovy	<TODO>
application

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Update a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/workflow/:id/rule/:ruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to update a rule for
ruleId	string	Required	The identifier of the rule to update

Request Body Parameters

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

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

{ "id": "AAABcIueWUc" }

Delete multiple rulesworkflows

Section

Delete workflow rule(s)

Delete one or more services workflows from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflowworkflows/:id/rule

DELETE /aspire_api/workflowworkflows/:id/rule/:ruleId

Path and Request Body Parameters

Name

Type

Required

Description

id

string

Required

The identifier of the workflow from which to delete rule(s)

or the identifier of the rule to delete when used in the body

ruleId

string

Required

The identifier of the rule to delete

Examples

Delete a single rule

Code Block

language	js

Code Block

language	js

[{
  "id": "AAABcIueWUc"
},
{
  "id": "AAABcIueWac"
}]

Delete multiple rules (alternative version)

Code Block

language	js

{
  "id": ["AAABcIueWUc", "AAABcIueWac"]
}DELETE /aspire_api/workflows/AAABcID5GBc%3D/rule?ruleId=AAABcID5GBc%3D&ruleId=AAABcIueWUc%3D

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Copy (duplicate) a workflow rule

?? Needed ??

Duplicates a workflow rule.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/workflow/:id/rule/:ruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
ruleId	string	Required	The identifier of the rule to copy

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Share a workflow rule

?? Needed ??

Move a workflow rule to a shared library.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/workflow/:id/rule/:ruleId/:destination

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
eventId	string	Required	The identifier of the event to share
destination	string	Required	The identifier of the library to share to

Response

Code Block

language	js

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

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get workflow libraries

?? Needed ??

Get all of the workflow libraries

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/library

Query String Parameters

Name	Type	Required	Description
description	string	Optional	Filter the libraries returned to those matching the given description

Response

Code Block

language	js

{
  <TODO>
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get a workflow library

?? Needed ??

Get a single workflow library.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/library/:id

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the library to return

Response

Code Block

language	js

{
  <TODO>
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Reload workflow libraries

?? Needed ??

Reload all workflow libraries.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/library/reload

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 10

New Version 11

Key

List workflows

Get a single workflow

Add a workflow

Delete workflow(s)

Get a workflow event

Create workflow event(s)

Delete a workflow event

Create a workflow event item

Update a workflow event item

Delete a workflow event item

Move a workflow event item

Get workflow templates - Review pending

Get a workflow template - Review pending

Get workflow rules

Get a workflow rule

Create a workflow rule

Update a workflow rule

Delete workflow rule(s)

Copy (duplicate) a workflow rule

Share a workflow rule

Get workflow libraries

Get a workflow library

Reload workflow libraries

Page tree

Page History

Versions Compared

Old Version 10

New Version 11

Key

List workflows

Get a single workflow

Add a workflow

Delete workflow(s)

Get a workflow event

Create workflow event(s)

Delete a workflow event

Create a workflow event item

Update a workflow event item

Delete a workflow event item

Move a workflow event item

Get workflow templates - Review pending

Get a workflow template - Review pending

Get workflow rules

Get a workflow rule

Create a workflow rule

Update a workflow rule

Delete workflow rule(s)

Copy (duplicate) a workflow rule

Share a workflow rule

Get workflow libraries

Get a workflow library

Reload workflow libraries