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

toc

Easy Heading Free

titleExpandClickable	true
navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

: 200

Section

List

Get all workflows

Lists all the workflows configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflowworkflows

Pagination query string parameters

Sorting query string parameters

Query String Parameters

descriptionstring

Name	Type	Required	Description
sparse	boolean	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

Section

Get all workflows, filtered

Lists workflows configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/getAll

Pagination query string parameters

Sorting query string parameters

Common filter

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

Success

The given workflow id was not found

: 200, 404

Section

Get a single workflow

Get information about a single workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflowworkflows/:id

Path Parameters

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

Response

Query String Parameters

Name	Type	Required	Description
transform	boolean	Optional	Whether to transform the output. Default "false"
section	string	Optional	The section required for the output. The value can be "templates", "rules", "events"

Response

Code Block

language	js

Code Block

language	js

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

Status

Response code Description

200 Success

404

: 200, 406

Section

Add

a

single workflow

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflowworkflows

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:

scanonScan
addUpdateonAddUpdate
deleteonDelete
publishonPublish
erroronError

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

Examples

Add a single workflowExample

Code Block

language	js

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

Response

Code Block

language	js

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

Status

Response code Description

201 Created

406 Not acceptable - there was an issue validating the input

Section

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

Section

Delete workflow(s)

Delete one or more workflow from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE PUT /aspire/_api/workflows/:id

DELETE /aspire/_api/workflows

Path and Request Body Parameters

updateAll

Common filter

Update body parameter

Response

Code Block

language	js

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

Status: 200, 406

Examples

Delete a single workflow

Section

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.

Panel

borderColor	black
bgColor	#fafafb

POST /

Name Type Required Description

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

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

deleteAll

Common filter

Response

Code Block

language	js

{
	  "message": "optionaldelete result response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input Section

: 200, 404, 406

Section

Delete workflow(s)

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

Get a workflow event

Get a event from a workflow in Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET DELETE /aspire/_api/workflowworkflows/:id/:eventId

DELETE /aspire/_api/workflows

POST /aspire/_api/workflows/delete

Path Parameters and Query parameters

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

Body Parameter

Name	Type	Required	Description
idseventId	string	Required	The identifier(s) of the event to getworkflow(s) to delete

ExamplesResponse

Code Block

language	js

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

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

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

Response

Code Block

language	js

{

    "descriptionmessage": "Publish to Elasticsearch"
    "event": {
      "id": "addUpdate"
    }
  }
  "message": "optional delete result 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

: 200, 404, 406

Section

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 event(s)

Create one or more workflow events in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT GET /aspire/_api/workflowworkflows/:idPUT /aspire/_api/workflow/:id/:eventId

Path Parameters

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

Examples

get

ResponseCreate a single event

Code Block

language	js

{
  "idworkflow": {
    "scan"
}

Create multiple events

Code Block

language	js

[{
id": "AAABcIueWUc=",
    "iddescription": "scanPublish to Elasticsearch"
},
{
    "idevent": "addUpdate"
}]

Create multiple events (alternative version)

Code Block

language	js

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

Response

Code Block

language	js

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

}
}

Status: 200, 404, 406

Create a workflow event item

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

Section

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 event

Delete a workflow event from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE GET /aspire/_api/workflowworkflows/: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 deletereturn

Response

Code Block

language	js

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow/:id/:eventId/:type

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow(s) to returneventIdstringRequiredThe identifier of the event to gettypestringRequiredThe 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 TypeParameter NameParameter TypeRequiredDescriptionReferenceparentIdstringOptionalThe identifier of the node in to which the item should be inserted. Defaults to the root nodeorderIdintegerRequiredThe position (which in the children of the parent node) where this reference should be insertedruleIdStringRequiredThe rule to be referencedenabledbooleanOptionalWhether or not the item is enabled (default true)ConditionparentIdstringOptionalThe identifier of the node in to which the item should be inserted. Defaults to the root nodevalueobjectRequiredThe value to be compared againstenabledbooleanOptionalWhether or not the item is enabled (default true)ExitparentIdstringOptionalThe identifier of the node in to which the item should be inserted. Defaults to the root nodeorderIdintegerRequiredThe position (which in the children of the parent node) where this reference should be insertedenabledbooleanOptionalWhether 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=",
        ...
      }
    }
  }
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input

     "id": "72022651-c2f4-45a9-9e18-2b0ace529cda",
        "type": "connector",
        "description": "Test Workflow",
        "checksum": "2b8dc08a2da838304528b4695109e2379da9a670c5a195dcd27355e8daa20a8b",
        "events": {
            "event": [
                {
                    "id": "onScan"
                },
                {
                    "id": "onAddUpdate"
                },
                {
                    "id": "onDelete"
                },
                {
                    "id": "onPublish",
                    "item": {
                        "id": "404fefb7-b7f4-48cf-a7b1-81872587a85b",
                        "type": "reference",
                        "ruleId": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067",
                        "enabled": true
                    }
                },
                {
                    "id": "onError"
                },
                {
                    "id": "onIdentity"
                },
                {
                    "id": "onIdentityError"
                }
            ]
        }
    }
}

Status: 200, 404, 406

Section

Create workflow event(s)

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflows/:id

PUT /aspire/_api/workflows/: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 multiple events (body parameter)

Code Block

language	js

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

Response

Code Block

language	js

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

Status: 200, 404, 406

Section

Delete a workflow event

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflows/: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": "delete result response message"
}

Status: 200, 404, 406

Section

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.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/: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. The valid parents for reference items are the root node, items of the type condition or references which ruleId is for a rule of type "folder"
	orderId	integer	Required	The position (which in the children of the parent node) where this reference should be inserted. For example 0 means at the beginning, in the case of using a number greater than the current number of children within the parent node the item will be inserted at the end
	ruleId	String	Required	The rule to be referenced, it must exist
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
condition	parentId	string	Required	The identifier of the node in to which the item should be inserted. The valid parents for condition items are references which ruleId is for a rule of type "choice".
	value	object	Required	The value to be compared against
	conditionType	String	Required	The value type, possible types are "string", "boolean", "integer", "long", "double", "float"
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
	template	String	Required	The condition template id.
exit	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node. The valid parents for exit items are the root node, items of the type condition or references which ruleId is for a rule of type "folder"
	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: 200, 404, 406

Section

Update a workflow event item

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflows/:id/:eventId/:itemId

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	Required	The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent.
	ruleId	String	Optional	The rule to be referenced, it must exist
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
condition	parentId	string	Required	The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent.
	value	object	Optional	The value to be compared against
	type	String	Optional	The value type, possible types are "string", "boolean", "integer", "long", "double", "float"
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
	template	String	Optional	The condition template id.
exit	parentId	string	Required	The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent.
	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: 200, 404, 406

Section

Delete single workflow event item

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflows/:id/:eventId/:parentId/: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
parentId	string	Required	The identifier of the node with the item to be deleted
itemId	integer	Required	The identifier of the item to delete

Response

Code Block

language	js

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

Status: 200, 404, 406

Section

Move a workflow event item

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflows/: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
orderId	integer	Optional	The position (which in the children of the parent node) where this item should be inserted. For example 0 means at the beginning, in the case of using a number greater than the current number of children within the parent node the item will be inserted at the end. If no provided the item will be moved at the end of the children list of the new parent.

Response

Code Block

language	js

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

Status: 200, 404, 406

Section

Get workflow templates

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

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

Response

Code Block

language	js

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

Status: 200, 404, 406

Section

Get single workflow template

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/: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",
      ...
    }]
}

Status: 200, 404, 406

Section

Get single workflow rule

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/: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: 200, 404, 406

Section

Get workflow rules

Get workflow rules from Aspire, this endpoint need the at least the OPERATOR role to be executed.

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": "72022651-c2f4-45a9-9e18-2b0ace529cda",
        "type": "connector",
        "description": "Test Workflow",
        "checksum": "2b8dc08a2da838304528b4695109e2379da9a670c5a195dcd27355e8daa20a8b",
        "rules": {
            "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067": {
                "appName": "Publish_To_File",
                "config": "com.accenture.aspire:app-publish-to-file",
                "type": "application",
                "description": "Publish to File",
                "properties": {
                    "debug": "false",
                    "logFileType": "true",
                    "logFile": "${app.name}/publishToFile.jobs",
                    "numJobs": 5
                },
                "id": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067"
            }
        }
    }
}

Status: 200, 404, 406

Section

Create a workflow rule

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/: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.

Rule Type	Parameter Name	Parameter Type	Required	Description
application	type	string	Required	The rule type, in the case of application the value must be "application"
	description	string	Required	The rule description. Any spaces will be replaced with "_" after creation
	config	string	Required	The maven coordinates of the rule application
	properties	object	Optional	A nested JSON object that contains any additional property required by the application. The properties will vary depending of the application.
	enabled	boolean	Optional	Whether or not the rule is enabled (default true)
	*appType	string	Optional	This field is only required if Aspire will be used with the UI. This field is used to associate the rule to the proper dxf from the resource manager
	*_type	string	Optional	This field is only required if Aspire will be used with the UI.
template	type	string	Required	The rule type, in the case of rules based on templates, type must match the type of the template, for example if the template type is "choice" the rule type also must be "choice"
	template	string	Required	The id of the template to use for the rule
	properties	object	Optional	A nested JSON object that contains any additional property required by the template. The properties will vary depending of the template.
	enabled	boolean	Optional	Whether or not the rule is enabled (default true)
custom	type	string	Required	The rule type, in the case of custom rules the value must be "custom"
	description	string	Required	The rule description. Any spaces will be replaced with "_" after creation
	script	string	Required	The custom groovy script to execute.

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: 200, 404, 406

Update a workflow event item

Delete one or more services from Aspire.

Section

Update single workflow rule

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

Section

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflow/:id/:eventId/:orderId

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow(s) to useeventIdstringRequired

The identifier of the event to use

orderIdintegerRequiredThe order 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 codeDescription200Success404Not found - a given workflow identifier was not found406Not 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/:orderId

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow to useeventIdstringRequiredThe identifier of the event to useorderIdintegerRequiredThe order identifier of the item to delete

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not 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

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow to useeventIdstringRequiredThe identifier of the event to use

Body Parameters

NameTypeRequiredDescriptionsrcstringRequiredThe identifier of the event item to movedeststringRequiredThe identifier of the new parent for the moved item

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input Section

Get workflow templates

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET PUT /aspire/_api/workflows/:id/templatesrule/:ruleId

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

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

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUcddSWeq123",
      ..."description": "Some rule",
    }]
  "messagetype": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input

application",
      ...
    }
  }
}

Status: 200, 404, 406

Section

Delete single workflow rule

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

Section

Get a workflow template

Retrieve a workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET DELETE /aspire/_api/workflowworkflows/:id/templaterule/:templateIdruleId

Path Parameters

Name

Type

Required

Description

id

string

Required

The identifier of the workflow

to get the templates for

from which to delete rule(s)

ruleIdtemplateId

string

Required

The identifier of the template rule to getdelete

Response

Code Block

language	js

{
  "templatemessage": [{
      "id": "AAABcQwrWUc",
      ...
    }]
  "message": "optional "delete result 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

Status: 200, 404, 406

Section

Delete workflow rules

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

Get workflow rules

Get all the rules for a given workflow.

Panel

borderColor	black
bgColor	#fafafb

GET DELETE /aspire/_api/workflows/:id/rules

Path Parameters

Name	Type	Required	Description
id	string	RequiredThe identifier of the workflow to return rules for	The identifier of the workflow from which to delete rule(s)

Query Parameters

Name	Type	Required	Description
id	string	Required	One or more rule ids to be deleted

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

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

Status: 200, 404, 406

The identifier of the rule to get

Section

Export workflow(s)

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/export

GET /aspire/_api/workflows/export/:id

POST /aspire/_api/workflows/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parameters

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

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the workflow(s) to export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/workflows/export/AAABcID5GBc

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

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

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

Response

Code Block

language	js
theme	RDark

{
  "workflowexport": {
    "idworkflows": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
{
      "eventworkflow": {[
       "id": "onAddUpdate", {
      "rule": {
        "id": "ddSWeq123<workflow_id>",
          "descriptiontype": "Some ruleconnector",
          "typedescription": "applicationmyWorkflow",
        ...
  
    }
    }
  }
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not 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

NameTypeRequiredDescriptionidstringRequiredThe 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 TypeParameter NameParameter TypeRequiredDescriptiongroovy<TODO>application

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

Parameter NameParameter TypeRequiredDescriptionparentIdstringRequiredThe identifier of the node in to which the item should be inserted. Defaults to the root nodeorderIdintegerRequiredThe position (which in the children of the parent node) where this reference should be insertedenabledbooleanOptionalWhether or not the item is enabled (default true)

Response

Code Block

language	js

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

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input Section

: 200, 404, 406

Section

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

Update a workflow rule

Delete one or more services from Aspire

.

Panel

borderColor	black
bgColor	#fafafb

PUT

POST /aspire/_api/

workflow/:id/rule/:ruleId

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow to update a rule forruleIdstringRequiredThe 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

connections/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "workflows": {
      "workflow": [
        {

"id

 "id": "<workflow_id>",
          "type": "

AAABcIueWUc=

connector",
          "description": "

Publish

myWorkflow",

to

Elasticsearch"

"event":

{

"id":

"onAddUpdate",

rule

templates": {
            "

id

template":

"ddSWeq123",

"description": "Some rule",

...

"type": "application",

    ]
          },

...

     "events":

}

"message":

"optional

response

message" }

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input Section

Delete workflow rule(s)

Delete one or more workflows from Aspire.

Panel

borderColor	black
bgColor	#fafafb

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

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

Path and Request Body Parameters

NameTypeRequiredDescriptionidstringRequired

The identifier of the workflow from which to delete rule(s) or the identifier of the rule to delete when used in the body

ruleIdstringRequiredThe identifier of the rule to delete

"event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        }
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

Examples

Delete multiple workflows

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Seed filter:

Code Block

language	js
theme	RDark

{ 
  "filter"

Code Block

language	js

DELETE /aspire/_api/workflows/AAABcID5GBc%3D/rule?ruleId=AAABcID5GBc%3D&ruleId=AAABcIueWUc%3D

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input Section

Copy (duplicate) a workflow rule

Duplicates a workflow rule.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow/:id/rule/:ruleId

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow to useruleIdstringRequiredThe identifier of the rule to copy

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
    "ids" : ["idID1":, "onAddUpdateID2",
 "ID3", ...],
    "ruletype" : {
    "TYPE",
    "iddescription" : "ddSWeq123DESCRIPTION",
        "descriptiondeleteIncrementalPolicy": "Some ruledeletePolicyId",
	"credentials" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"routingPolicies" :  ["RP1", "typeRP2":, "applicationRP3",
        ...]
      }
    }
  }
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input

Page tree

Page History

Versions Compared

Old Version 22

New Version Current

Key

Get all workflows

Get all workflows, filtered

Get a single workflow

Add

single workflow

Update workflows, filtered

Delete workflow(s)

Delete multiple workflows, filtered

Delete workflow(s)

Get a workflow event

Get a workflow event

Create workflow event(s)

Get workflow events

Delete a workflow event

Create a workflow event item

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

Get workflow rules

Create a workflow rule

Update single workflow rule

Update a workflow event item

Delete a workflow event item

Move a workflow event item

Get workflow templates

Delete single workflow rule

Get a workflow template

Delete workflow rules

Get workflow rules

Export workflow(s)

Get a workflow rule

Create a workflow rule

Export multiple connections, filtered

Update a workflow rule

Delete workflow rule(s)

Import

Filters AnchorFiltersAnchorFiltersAnchor

Copy (duplicate) a workflow rule

Filters
Anchor
FiltersAnchor
FiltersAnchor