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",
    ...
  }],
  "message": "optional response message"
}

Status

Response code Description

Success

: 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

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

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

: 200, 406

Section

Add single

Section

Add a

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.

ExamplesExample

Add a single workflow

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"
  }],
  "message": "optional response message"....
  }
}

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 /aspire/_api/workflows/deleteAll

Common filter

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

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

Path Parameters

DELETE /aspire/_api/workflows

POST /aspire/_api/workflows/delete

Path Parameters and Query parameters

Name	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

DELETE /aspire/_api/workflows/AAABcID5GBc

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

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

Response

Code Block

language	js

{{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "addUpdate"
    }
  }
  "message": "optionaldelete 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/workflow/:idPUT /aspire_api/workflowworkflows/: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 addget

ExamplesResponse

Create a single event

Code Block

language	js

{
  "idworkflow": "scan"
}

Create multiple events

Code Block

language	js

[{
    "id": "scanAAABcIueWUc="
},
{
    "iddescription": "addUpdate"
}]

Create multiple events (alternative version)

Code Block

language	js

{
  Publish to Elasticsearch"
    "event": {
      "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

Request Body Parameters

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

Response

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

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

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

Item Type Parameter Name Parameter Type Required Description

Rule <TODO> Application Rule Condition Exit

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      {
        "id": "72022651-c2f4-45a9-9e18-2b0ace529cda",
        "type": "connector",
        "description": "Test Workflow",
        "checksum": "2b8dc08a2da838304528b4695109e2379da9a670c5a195dcd27355e8daa20a8b",
        "events": {
            "event": [
                {
                    "id": "onScan"
                },
                {
                    "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=" },
        ...
        {
           }
     }
  }
  "messageid": "onDelete"optional
 response message"
}

Status

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

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow(s) to useeventIdstringRequired

The identifier of the event to use

itemIdstringRequiredThe 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": "onPublish",
                    "item": {
                        "id": "404fefb7-b7f4-48cf-a7b1-81872587a85b",
                        "type": "reference",
                        "ruleId": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067",
                        "enabled": true
                    }
                },
                {
                    "id": "AAABcQwxWUc=onError",
          ...
      },
    }
  }
  "message": "optional response message"
}

Status

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

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

Delete a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE PUT /aspire/_api/workflowworkflows/:id

PUT /:eventIdaspire/_api/workflows/:id/:itemIdeventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to add a event to use
eventId	string	Required	The identifier of the event to useadd
itemId	string	Required	The identifier of the node item to delete

Response

Examples

Create multiple events (body parameter)

Code Block

language	js

[{
  "messageid": "optional response messagescan"
},
{
  "id": "addUpdate"
}]

StatusResponse

Response

Code Block

Description

language

200 Success

404 Not found - a given workflow identifier was not found

406 Not acceptable - there was an issue validating the input

js

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

Status: 200, 404, 406

Body Parameters

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

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

Name	Type	Required	Description

src

id

string

Required

The identifier of the

event item to movedest

workflow(s) to use
eventId	string	Required	The identifier of the

new parent for the moved item

event to delete

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

Get a workflow rule

Get one or more workflow rule from Aspire.

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

Get workflow templates - Review pending

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/workflows/:id/:eventId/template:type

Path and Query String 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 the templates for
descriptiontype	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

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

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 node in to get the templates forwhich the item should be inserted. The valid parents for condition items are references which ruleId is for a rule of type "choice".
value	object	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

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)

Get workflow rules

Get all the rules for a given workflow.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflows/:id/rules

Path Parameters

The identifier of the workflow to return rules for

Name	Type	Required	Description
id	string	Required

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "addUpdateonAddUpdate",
      "rule": [{
        "id": "ddSWeq123",
        "description": "Some ruleAAABcQwxWUc=",
        "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

Panel

borderColor	black
bgColor	#fafafb

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

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow to return rules forruleIdstringRequiredThe 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

}
}

Status: 200, 404, 406

Request Body Parameters

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

Response

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

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

Rule Type Parameter Name Parameter Type Required Description

groovy <TODO> application

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "ddSWeq123",
        "description": "Some rule"AAABcQwxWUc=",
        "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

Delete single workflow event item

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

Update a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT DELETE /aspire/_api/workflowworkflows/:id/:eventId/rule:parentId/:ruleIditemId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to update a rule foruse
eventIdruleId	string	Required	The identifier of the rule event to updateuse

Request Body Parameters

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

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

{
  "workflowmessage": {
"delete result response  "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

message"
}

Status: 200, 404, 406

Examples

Delete a single rule

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

Delete workflow rule(s)

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflow/:id/rule

DELETE /aspire_api/workflow/: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

Code Block

language	js

{
  "idmessage": "AAABcIueWUcmove 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

Delete multiple rules

Code Block

language	js

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

Delete multiple rules (alternative version)

Code Block

language	js

{
AAABcQwrWUc",
      ...
    },
	  "id": ["AAABcIueWUcAAABcQwrWUd", "AAABcIueWac"
      ...
    }]
}

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

Status: 200, 404, 406

Response

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

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

Code Block

language	js

{
  "workflow": {
      "id": "AAABcIueWUc=AAABcQwrWUc",
    "description": "Publish to Elasticsearch" ...
    "event": {
      "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

}]
}

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

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

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to usereturn rules for
ruleIdeventId	string	Required	The identifier of the event rule to share
destination	string	Required	The identifier of the library to share to

Response

get

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "eventrule": {
      "id": "onAddUpdateddSWeq123",
     }
 "description": "Some rule",
    }
  "messagetype": "optional response message"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

: 200, 404, 406

Get a workflow library

?? Needed ??

Get a single workflow library.

Section

Get workflow rules

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

Get workflow libraries

?? Needed ??

Get all of the workflow libraries

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/workflow:id/libraryrules

Query String Path Parameters

Name	Type	Required	Description
descriptionid	string	OptionalRequired	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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/library/:id

Path and Request Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the library to return

Response

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

Section

Update single workflow rule

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

Panel

borderColor	black
bgColor	#fafafb

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

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)
ruleId	string	Required	The identifier of the rule to delete

Response

Code Block

language	js

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

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.

Panel

borderColor	black
bgColor	#fafafb

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

Path Parameters

Name	Type	Required	Description
id	string	Required	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

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

Status: 200, 404, 406

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"]
}

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkflow",          
          "templates": {
            "template": [
              ...
            ]
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        }
      ]
    }
  }
}

Status: 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.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkflow",          
          "templates": {
            "template": [
              ...
            ]
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        }
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

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" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
    "deleteIncrementalPolicy": "deletePolicyId",
	"credentials" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"routingPolicies" : ["RP1", "RP2", "RP3", ...]
  }
}

Code Block

language	js

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

Status

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

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

Update a workflow event item

Create workflow event(s)

Delete a workflow event item

Delete a workflow event

Move a workflow event item

Create a workflow event item

Get workflow templates - Review pending

Get a workflow template - Review pending

Get workflow rules

Get a workflow rule

Update a workflow event item

Create a workflow rule

Delete single workflow event item

Update a workflow rule

Move a workflow event item

Delete workflow rule(s)

Get workflow templates

Get single workflow template

Copy (duplicate) a workflow rule

Get single workflow rule

Share a workflow rule

Get workflow rules

Get workflow libraries

Get a workflow library

Create a workflow rule

Update single workflow rule

Delete single workflow rule

Delete workflow rules

Export workflow(s)

Export multiple connections, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Reload workflow libraries

Filters
Anchor
FiltersAnchor
FiltersAnchor