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

Get all workflows

Lists all the workflows configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflow

Pagination query string parameters

Query String Parameters

fromsparse	integerboolean	Optional	Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort
expand	string	Optional	List of fields to expand, * will expand everything
sparse	boolean	Optional	Only return minimal data such as identifier, description, name etc

Response

Only return minimal data such as identifier, description, name etc

Response

Code Block

language	js

{
  "workflow":

Code Block

language	js

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

Status

Response code	Description
200	Success

Section

Get all workflows, filtered

Lists workflows configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/getAll

Pagination query string parameters

Common filter

Query String Parameters

Name	Type	Required	Description
fromsparse	integerboolean	Optional	Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort
expand	string	Optional	List of fields to expand, * will expand everything
sparse	boolean	Optional	Only return minimal data such as identifier, description, name etc

Body Parameters

Only return minimal data such as identifier, description, name etc

Response

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":

Name Type Required Description

filter JSON Required Filters retrieved connectors. Check the filter definition here

Code Block

language	js

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

Status

Response codeDescription200Success Section

Status

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

Query String Parameters

Example

Section

Add single workflow

Adds a single workflow to

Get a single workflow

Get information about a single workflow in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/workflow/:id

Path Body Parameters

idThe id to return

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

Response

Code Block

language	js

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

Status

Response code Description

200 Success

404 The given workflow id was not found

Section

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:

onScan
onAddUpdate
onDelete
onPublish
onError

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

Example

Code Block

language	js

/aspire/_api/workflow?type=connector
{
  "description": "Publish to Elastic"
}

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcID5GBc="

Add single workflow

Adds a single workflow to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow

Body Parameters

Name Type Required Description

description string Required A description of the workflow

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:

onScan
onAddUpdate
onDelete
onPublish
onError

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

Code Block

language	js

/aspire/_api/workflow?type=connector
{
  "description": "Publish to Elastic"
}

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcID5GBc=",
    "description": "Publish to Elastic",
    "type": "connector"
    ....
  }
}

Status

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

Section

Delete multiple workflows, filtered

Delete multiple workflows from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/deleteAll

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters workflows to be deleted. Check the filter definition here

Response

Code Block

language	js

{
  "message": "optional response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

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

Section

Delete single workflow

Delete a single workflow from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflow/:id

Path Parameters

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

Example

Code Block

language	js

DELETE /aspire/_api/workflows/AAABcID5GBc=

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": "onUpdate"
       ....
    }
  }
}

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

Create multiple events (body parameter)

Code Block

language	js

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

Create multiple events (alternative version)

Response

Code Block

language	js

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

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 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

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
Reference	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
	orderId	integer	Required	The position (which in the children of the parent node) where this reference should be inserted
	ruleId	String	Required	The rule to be referenced
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
Condition	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
	value	object	Required	The value to be compared against
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
Exit	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
	orderId	integer	Required	The position (which in the children of the parent node) where this reference should be inserted
	enabled	boolean	Optional	Whether or not the item is enabled (default true)

Response

Code Block

language	js

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

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/:orderId

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
orderId	integer	Required	The order identifier of the item to update

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=",
        ...
      }
    }
  }
}

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 single workflow event item

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflow/:id/:eventId/:parentId/:orderId

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
parentId	string	Required	The identifier of the node with the item to be deleted
orderId	integer	Required	The order identifier of the 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

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/:id/templates

Path Parameters

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

Query String Parameters

Name	Type	Required	Description
from	integer	Optional	Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    },
	  "id": "AAABcQwrWUd",
      ...
    }]
  "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 single workflow template

Retrieve a single 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 single workflow rule

Get a single 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"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }
}

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

Create a single workflow rule in Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow/:id/rules

Path Parameters

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

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

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

Parameter Name	Parameter Type	Required	Description
parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
orderId	integer	Optional	The position (which in the children of the parent node) where this reference should be inserted

Response when parentId used

Code Block

language	js

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

Response without parentId

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }
}

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 single workflow rule

Updatee a single workflow rule in 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

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"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }
}

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 single workflow rule

Deletes a single workflow rule from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflows/:id/rule/:ruleId

Path 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

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 item types (TODO: to be moved)

Lists all available workflow item types

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/itemType

Response

Code Block

language	js

{
  type: [ "application", "publisher", "function"]
}

Status

Response code	Description
200	Success

Section

Get specific workflow items by type (TODO: to be moved)

Returns a workflow item by its type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/itemType/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow item type

Example

Code Block

language	js

/aspire/_aspire/workflows/types/applications

Response

Code Block

language	js

{
    items: [{
			  "id": "AAABcID5GBc="
			  "type": "application",
        	  "description": "Application_1",
          	  "coordinates": "com.accenture.aspire:aspire-example-app"
            },
            {
			  "id":	"AAABcID5GBd="
	 		  "type": "application",
              "display": "Application_2",
              "coordinates": "com.accenture.aspire:aspire-example-app"
            }]
}

Status

Response code Description

200 Success

Section

Get workflow item type dxf (to be moved)

Returns the dxf for a specific workflow item type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/itemType/:itemTypeId/dxf

Response

Code Block

language	js

{
  "dxf": {...}
  "message": "optional response message"}]
}

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

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

Credentials filter:

Section

Get workflow item type dxf (TODO: to be moved)

Returns the dxf for a specific workflow item type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/itemType/:itemTypeId/dxf

Response

Section

Filters

Anchor

FiltersAnchor FiltersAnchor

When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.

Code Block

language	js

  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",dxf": {...}
    "descriptionmessage" : "DESCRIPTIONoptional response message"
  }

Note

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Page tree

Versions Compared

Old Version 47

New Version 48

Key

Get all workflows

Get all workflows, filtered

Get a single workflow

Add single workflow

Get a single workflow

Add single workflow

Delete multiple workflows, filtered

Delete single workflow

Get a workflow event

Create workflow event(s)

Delete a workflow event

Create a workflow event item

Update a workflow event item

Delete single workflow event item

Move a workflow event item

Get workflow templates

Get single workflow template

Get single workflow rule

Create a workflow rule

Update single workflow rule

Delete single workflow rule

Get workflow item types (TODO: to be moved)

Get specific workflow items by type (TODO: to be moved)

Get workflow item type dxf (to be moved)

Get workflow item type dxf (TODO: to be moved)

Page tree

Page History

Versions Compared

Old Version 47

New Version 48

Key

Get all workflows

Get all workflows, filtered

Get a single workflow

Add single workflow

Get a single workflow

Add single workflow

Delete multiple workflows, filtered

Delete single workflow

Get a workflow event

Create workflow event(s)

Delete a workflow event

Create a workflow event item

Update a workflow event item

Delete single workflow event item

Move a workflow event item

Get workflow templates

Get single workflow template

Get single workflow rule

Create a workflow rule

Update single workflow rule

Delete single workflow rule

Get workflow item types (TODO: to be moved)

Get specific workflow items by type (TODO: to be moved)

Get workflow item type dxf (to be moved)

Get workflow item type dxf (TODO: to be moved)