Ops API

Provides an operational interface related to workflow configuration, external references etc.
More information: https://www.digitalroute.com/contact-support
Contact Info: support@digitalroute.com
Version: v1beta8
All rights reserved.
https://www.digitalroute.com

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

ExternalReferenceProfiles

ExternalReferences

WorkflowGroups

WorkflowState

WorkflowTemplates

Workflows

ExternalReferenceProfiles

Up
get /profiles
Get all available external reference profiles of type Properties Database. (getAllProfiles)

Return type

array[String]

Example data

Content-Type: application/json
[ "SomeFolder.SomeProfileName", "SomeFolder.SomeProfileName" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of profiles.

500

Server error that prevented the request from being processed.

ExternalReferences

Up
patch /external/{profile}
Create/update key value(s) in the given profile. (createOrUpdateAll)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExternalReferenceIn (required)
Body Parameter — Keys and values.

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The up to date key value(s) in the profile. ExternalReferenceOut

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given key or profile is not found.

Up
patch /external/{packageName}/{packageVersion}/{profile}
Create/update key value(s) in the given profile. (createOrUpdateAllConfigPack)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExternalReferenceIn (required)
Body Parameter — Keys and values.

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The up to date key value(s) in the profile. ExternalReferenceOut

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given key or profile is not found.

Up
delete /external/{profile}/{keyName}
Delete the value of the given key in the given profile. (delete)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
keyName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Value deleted.

204

Key not found.

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given profile was not found.

Up
delete /external/{profile}
Delete all key values in the given profile. (deleteAllKeys)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

All deleted.

204

No keys found.

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given profile was not found.

Up
delete /external/{packageName}/{packageVersion}/{profile}
Delete all key values in the given profile. (deleteAllKeysConfigPack)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

All deleted.

204

No keys found.

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given profile was not found.

Up
put /external/{profile}
Recreate all key values in the given profile. (deleteAndCreateAll)
All existing key values in the profile will be deleted before creation of the new ones.

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExternalReferenceIn (required)
Body Parameter — Keys and values.

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The up to date key value(s) in the profile. ExternalReferenceOut

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given key or profile is not found.

Up
put /external/{packageName}/{packageVersion}/{profile}
Recreate all key values in the given profile. (deleteAndCreateAllConfigPack)
All existing key values in the profile will be deleted before creation of the new ones.

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExternalReferenceIn (required)
Body Parameter — Keys and values.

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The up to date key value(s) in the profile. ExternalReferenceOut

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given key or profile is not found.

Up
delete /external/{packageName}/{packageVersion}/{profile}/{keyName}
Delete the value of the given key in the given profile. (deleteConfigPack)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
keyName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Value deleted.

204

Key not found.

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given profile was not found.

Up
get /external
Get all key value(s) for all available profiles. (getAll)

Return type

array[ExternalReferenceOut]

Example data

Content-Type: application/json
[ {
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}, {
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The key value(s) in the respective profile.

204

No profiles defined.

500

Server error that prevented the request from being processed.

Up
get /external/{profile}
Get all key values(s) in the given profile. (getAllKeysToProfile)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The key value(s) in the profile. ExternalReferenceOut

204

No keys exist in the given profile.

500

Server error that prevented the request from being processed.

403

Forbidden from viewing the given profile.

404

The given profile is not found.

Up
get /external/{packageName}/{packageVersion}/{profile}
Get all key values(s) in the given profile. (getAllKeysToProfileConfigPack)

Path parameters

packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
profile (required)
Path Parameter — Profile identified by its folder and name.

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The key value(s) in the profile. ExternalReferenceOut

204

No keys exist in the given profile.

500

Server error that prevented the request from being processed.

403

Forbidden from viewing the given profile.

404

The given profile is not found.

Up
get /external/{profile}/{keyName}
Get the value of the given key in the given profile. (getKeyToAProfile)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
keyName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The value.

500

Server error that prevented the request from being processed.

403

Forbidden from viewing the given profile.

404

The given key or profile is not found.

Up
get /external/{packageName}/{packageVersion}/{profile}/{keyName}
Get the value of the given key in the given profile. (getKeyToAProfileConfigPack)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
keyName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The value.

500

Server error that prevented the request from being processed.

403

Forbidden from viewing the given profile.

404

The given key or profile is not found.

Up
put /external/{profile}/{keyName}
Create/update value of the given key in the given profile. (update)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
keyName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — New value for Key

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The up to date key value(s) in the profile. ExternalReferenceOut

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given key or profile is not found.

Up
put /external/{packageName}/{packageVersion}/{profile}/{keyName}
Create/update value of the given key in the given profile. (updateConfigPack)

Path parameters

profile (required)
Path Parameter — Profile identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
keyName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — New value for Key

Return type

ExternalReferenceOut

Example data

Content-Type: application/json
{
  "profile" : "SomeFolder.SomeName",
  "values" : {
    "Key1" : "Value1",
    "Key2" : "Value2"
  },
  "isEncrypted" : false,
  "last_modified_date" : "2000-01-23T04:56:07.000+00:00",
  "packageVersion" : "1.0",
  "packageName" : "MyConfigPack"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The up to date key value(s) in the profile. ExternalReferenceOut

500

Server error that prevented the request from being processed.

403

Forbidden from modifying the given profile.

404

The given key or profile is not found.

WorkflowGroups

Up
put /workflowgroup
Create a new workflow group (createWorkflowGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowGroupInput (required)
Body Parameter — The new workflow group

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

New workflow group was successfully created.

500

Server error that prevented the request from being processed ProblemResponse

Up
post /workflowgroups:batchDelete
Delete a list of workflow groups (deleteWorkflowGroups)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — The list of workflow groups to delete

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

The groups were successfully deleted.

403

Forbidden from deleting one or many specified groups ProblemResponse

500

Server error that prevented the request from being processed. ProblemResponse

Up
post /workflowgroup/{name}
Duplicate the specified workflow group (duplicateWorkflowGroup)

Path parameters

name (required)
Path Parameter — Configuration name

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The workflow group was successfully duplicated.

403

Forbidden from copying the specified workflow group. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

Up
post /workflowgroups
Duplicate a list of workflow groups (duplicateWorkflowGroups)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — The list of workflow groups to duplicate

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The groups were successfully duplicated.

403

Forbidden from copying one or many specified groups. ProblemResponse

500

Server error that prevented the request from being processed. ProblemResponse

Up
get /members
Get all workflows and workflow groups info (getAllAvailableMembers)
Get short info for all workflows and workflow groups allowed to be read by the user

Return type

array[String]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

403

Forbidden from viewing any of the applicable workflow and workflow groups. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

Up
get /workflowgroup/{name}
Get full spec of the specified workflow group (getGroupData)
Get full information of options set for the specified workflow group

Path parameters

name (required)
Path Parameter — Configuration name

Return type

WorkflowGroupOutput

Example data

Content-Type: application/json
{
  "owner" : "mzadmin",
  "auxiliaryData" : {
    "IsDynamic" : true
  },
  "folder" : "Default",
  "data" : {
    "schedule" : {
      "eventTriggers" : [ [ {
        "matchers" : {
          "agentName" : [ "disk_1" ]
        },
        "eventName" : "Agent Event",
        "className" : "com.digitalroute.wf.event.AgentEvent"
      }, {
        "matchers" : {
          "agentName" : [ "disk_1" ]
        },
        "eventName" : "Agent Event",
        "className" : "com.digitalroute.wf.event.AgentEvent"
      } ], [ {
        "matchers" : {
          "agentName" : [ "disk_1" ]
        },
        "eventName" : "Agent Event",
        "className" : "com.digitalroute.wf.event.AgentEvent"
      }, {
        "matchers" : {
          "agentName" : [ "disk_1" ]
        },
        "eventName" : "Agent Event",
        "className" : "com.digitalroute.wf.event.AgentEvent"
      } ] ],
      "allDPs" : [ {
        "shallExecute" : true,
        "stop" : "09:59:59",
        "start" : "00:00:00",
        "interval" : {
          "number" : 5,
          "type" : "MIN"
        },
        "type" : "DAILY",
        "day" : 1
      }, {
        "shallExecute" : true,
        "stop" : "09:59:59",
        "start" : "00:00:00",
        "interval" : {
          "number" : 5,
          "type" : "MIN"
        },
        "type" : "DAILY",
        "day" : 1
      } ]
    },
    "maxRunningWorkflows" : 10,
    "abortBehavior" : "Continue",
    "memberList" : [ {
      "folder" : "Default",
      "name" : "Default.workwflowgroup",
      "packageVersion" : "1.0.0",
      "workflowName" : "workwflow_1",
      "packageName" : "Package",
      "type" : "BATCHWFINSTANCE",
      "prereqs" : [ {
        "folder" : "Default",
        "name" : "Default.workwflowgroup",
        "packageVersion" : "1.0.0",
        "workflowName" : "workwflow_1",
        "packageName" : "Package"
      }, {
        "folder" : "Default",
        "name" : "Default.workwflowgroup",
        "packageVersion" : "1.0.0",
        "workflowName" : "workwflow_1",
        "packageName" : "Package"
      } ]
    }, {
      "folder" : "Default",
      "name" : "Default.workwflowgroup",
      "packageVersion" : "1.0.0",
      "workflowName" : "workwflow_1",
      "packageName" : "Package",
      "type" : "BATCHWFINSTANCE",
      "prereqs" : [ {
        "folder" : "Default",
        "name" : "Default.workwflowgroup",
        "packageVersion" : "1.0.0",
        "workflowName" : "workwflow_1",
        "packageName" : "Package"
      }, {
        "folder" : "Default",
        "name" : "Default.workwflowgroup",
        "packageVersion" : "1.0.0",
        "workflowName" : "workwflow_1",
        "packageName" : "Package"
      } ]
    } ],
    "delay" : 0,
    "continuousExecution" : false,
    "primaryType" : "BATCH",
    "executionSettings" : {
      "executionGroups" : [ "ecg1", "ecg2" ],
      "distributionType" : "ROUND_ROBIN",
      "enabled" : false
    }
  },
  "accessGroups" : [ "Administrator", "Administrator", "Administrator" ],
  "name" : "workwflowgroup",
  "packageVersion" : "1.0.0",
  "packageName" : "Package",
  "enabled" : false
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object WorkflowGroupOutput

403

Forbidden from viewing specified workflow group. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

Up
get /members/{name}
Get specified workflow group members info (getMembersOfTheGroup)
Get short info for all members of the specified workflow group

Path parameters

name (required)
Path Parameter — Configuration name

Return type

array[GroupMemberDto]

Example data

Content-Type: application/json
[ {
  "folder" : "Default",
  "name" : "Default.workwflowgroup",
  "packageVersion" : "1.0.0",
  "workflowName" : "workwflow_1",
  "packageName" : "Package",
  "type" : "BATCHWFINSTANCE",
  "prereqs" : [ {
    "folder" : "Default",
    "name" : "Default.workwflowgroup",
    "packageVersion" : "1.0.0",
    "workflowName" : "workwflow_1",
    "packageName" : "Package"
  }, {
    "folder" : "Default",
    "name" : "Default.workwflowgroup",
    "packageVersion" : "1.0.0",
    "workflowName" : "workwflow_1",
    "packageName" : "Package"
  } ]
}, {
  "folder" : "Default",
  "name" : "Default.workwflowgroup",
  "packageVersion" : "1.0.0",
  "workflowName" : "workwflow_1",
  "packageName" : "Package",
  "type" : "BATCHWFINSTANCE",
  "prereqs" : [ {
    "folder" : "Default",
    "name" : "Default.workwflowgroup",
    "packageVersion" : "1.0.0",
    "workflowName" : "workwflow_1",
    "packageName" : "Package"
  }, {
    "folder" : "Default",
    "name" : "Default.workwflowgroup",
    "packageVersion" : "1.0.0",
    "workflowName" : "workwflow_1",
    "packageName" : "Package"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

403

Forbidden from viewing specified workflow group. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

Up
get /workflowgroups
Get all workflow groups info (getWorkflowGroups)
Get short info for all workflow groups allowed to be read by the user

Return type

array[MemberConfigOutput]

Example data

Content-Type: application/json
[ {
  "owner" : "mzadmin",
  "folder" : "Default",
  "isDynamic" : true,
  "name" : "Default.workwflowgroup",
  "packageVersion" : "1.0.0",
  "packageName" : "Package",
  "type" : "BATCH",
  "configType" : "GROUP",
  "version" : 1
}, {
  "owner" : "mzadmin",
  "folder" : "Default",
  "isDynamic" : true,
  "name" : "Default.workwflowgroup",
  "packageVersion" : "1.0.0",
  "packageName" : "Package",
  "type" : "BATCH",
  "configType" : "GROUP",
  "version" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

403

Forbidden from viewing any of the applicable workflow groups. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

Up
patch /members/{name}
Delete a list of members from the specified workflow group (removeMembersFromGroup)

Path parameters

name (required)
Path Parameter — Configuration name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GroupMemberBaseDto (required)
Body Parameter — The list of members' names to delete

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

The workflow group was successfully updated.

403

Forbidden from writing into the specified workflow group. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

Up
patch /workflowgroup/{name}
Update the specified workflow group (updateWorkflowGroup)

Path parameters

name (required)
Path Parameter — Configuration name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowGroupInput (required)
Body Parameter — The workflow group update settings

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

The workflow group was successfully updated.

403

Forbidden from writing into the specified workflow group. ProblemResponse

500

Server error that prevented the request from being processed ProblemResponse

WorkflowState

Up
get /wfstate/{templateName}/{workflowName}
Get workflow state for a workflow. (getWorkflowState)

Path parameters

templateName (required)
Path Parameter — Configuration identified by its folder and name.
workflowName (required)
Path Parameter

Return type

array[WfStateAgentData]

Example data

Content-Type: application/json
[ {
  "agent" : "Disk_1",
  "fields" : {
    "Next_Seqno" : 84
  }
}, {
  "agent" : "Disk_1",
  "fields" : {
    "Next_Seqno" : 84
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

204

Template has no state

403

User has not execution rights for configuration

404

The given template was not found. ProblemResponse

500

Server error that prevented the request from being processed.

Up
get /wfstate/{packageName}/{packageVersion}/{templateName}/{workflowName}
Get workflow state for a workflow. (getWorkflowStateConfigPack)

Path parameters

templateName (required)
Path Parameter — Configuration identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
workflowName (required)
Path Parameter

Return type

array[WfStateAgentData]

Example data

Content-Type: application/json
[ {
  "agent" : "Disk_1",
  "fields" : {
    "Next_Seqno" : 84
  }
}, {
  "agent" : "Disk_1",
  "fields" : {
    "Next_Seqno" : 84
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

204

Template has no state

403

User has not execution rights for configuration

404

The given template was not found. ProblemResponse

500

Server error that prevented the request from being processed.

Up
get /wfstate/{templateName}
Get all workflows for a template with a workflow state. (getWorkflowStateForTemplate)

Path parameters

templateName (required)
Path Parameter — Configuration identified by its folder and name.

Return type

array[WfStateWorkflowData]

Example data

Content-Type: application/json
[ {
  "workflowName" : "workflow_1",
  "agents" : [ {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  }, {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  } ]
}, {
  "workflowName" : "workflow_1",
  "agents" : [ {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  }, {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

204

Template has no state

403

User has not execution rights for configuration.

404

The given template was not found. ProblemResponse

500

Server error that prevented the request from being processed.

Up
get /wfstate/{packageName}/{packageVersion}/{templateName}
Get all workflows for a template with a workflow state. (getWorkflowStateForTemplateConfigPack)

Path parameters

templateName (required)
Path Parameter — Configuration identified by its folder and name.
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Return type

array[WfStateWorkflowData]

Example data

Content-Type: application/json
[ {
  "workflowName" : "workflow_1",
  "agents" : [ {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  }, {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  } ]
}, {
  "workflowName" : "workflow_1",
  "agents" : [ {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  }, {
    "agent" : "Disk_1",
    "fields" : {
      "Next_Seqno" : 84
    }
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

204

Template has no state

403

User has not execution rights for configuration

404

The given template was not found. ProblemResponse

500

Server error that prevented the request from being processed.

Up
put /wfstate/{templateName}/{workflowName}
Set workflow state for a workflow. (setAgentConfig)

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WfStateAgentData (required)
Body Parameter — The created workflow

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

State successfully updated

204

Template has no state

403

User has not execution rights for configuration

404

The given template was not found. ProblemResponse

500

Server error that prevented the request from being processed.

Up
put /wfstate/{packageName}/{packageVersion}/{templateName}/{workflowName}
Set workflow state for a workflow. (setAgentConfig1)

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WfStateAgentData (optional)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

State successfully updated

204

Template has no state

403

User has not execution rights for configuration

404

The given template was not found. ProblemResponse

500

Server error that prevented the request from being processed.

WorkflowTemplates

Up
get /templates/{templateName}
Get a template (getTemplateByName)
Get a template matching templateName

Path parameters

templateName (required)
Path Parameter

Return type

WorkflowTemplateInfo

Example data

Content-Type: application/json
{
  "parametersSchema" : {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "description" : "the schema of the parameters property for any dynamic workflow based on this template",
    "type" : "object",
    "properties" : {
      "someParam" : {
        "type" : "string",
        "description" : "someParam description"
      },
      "someOtherParam" : {
        "description" : "someOtherParam description",
        "enum" : [ "ONE", "TWO" ]
      }
    },
    "required" : [ "someOtherParam" ]
  },
  "templateType" : "Realtime",
  "isDynamic" : true,
  "workflowCount" : 2,
  "templateName" : "Default.myTemplate",
  "isEncrypted" : false,
  "isValid" : true,
  "packageVersion" : "1.0",
  "permission" : {
    "read" : true,
    "write" : true,
    "execute" : true
  },
  "packageName" : "MyConfigPack",
  "nodeNames" : [ "Analysis_1", "Disk_1" ],
  "templateKey" : "MZ1570020702163"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON coded result with template WorkflowTemplateInfo

500

Server error that prevented the request from being processed ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /templates/{packageName}/{packageVersion}/{templateName}
Get a template (getTemplateByNameConfigPack)
Get a template matching templateName, packageName and packageVersion

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Return type

WorkflowTemplateInfo

Example data

Content-Type: application/json
{
  "parametersSchema" : {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "description" : "the schema of the parameters property for any dynamic workflow based on this template",
    "type" : "object",
    "properties" : {
      "someParam" : {
        "type" : "string",
        "description" : "someParam description"
      },
      "someOtherParam" : {
        "description" : "someOtherParam description",
        "enum" : [ "ONE", "TWO" ]
      }
    },
    "required" : [ "someOtherParam" ]
  },
  "templateType" : "Realtime",
  "isDynamic" : true,
  "workflowCount" : 2,
  "templateName" : "Default.myTemplate",
  "isEncrypted" : false,
  "isValid" : true,
  "packageVersion" : "1.0",
  "permission" : {
    "read" : true,
    "write" : true,
    "execute" : true
  },
  "packageName" : "MyConfigPack",
  "nodeNames" : [ "Analysis_1", "Disk_1" ],
  "templateKey" : "MZ1570020702163"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON coded result with template WorkflowTemplateInfo

500

Server error that prevented the request from being processed ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /templatesimage/{templateName}
Get workflow image snapshot (getTemplateImage)
Get the workflow image snapshot by template name

Path parameters

templateName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A PNG image file

500

Server error that prevented the request from being processed ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /templatesimage/{packageName}/{packageVersion}/{templateName}
Get workflow image snapshot (Config pack) (getTemplateImageConfigPack)
Get the workflow image snapshot by package name, config version and template name

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A PNG image file

500

Server error that prevented the request from being processed ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /templates
Get a list of all workflow templates (getTemplates)
Get a list of all workflow templates

Return type

array[WorkflowTemplateInfo]

Example data

Content-Type: application/json
[ {
  "parametersSchema" : {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "description" : "the schema of the parameters property for any dynamic workflow based on this template",
    "type" : "object",
    "properties" : {
      "someParam" : {
        "type" : "string",
        "description" : "someParam description"
      },
      "someOtherParam" : {
        "description" : "someOtherParam description",
        "enum" : [ "ONE", "TWO" ]
      }
    },
    "required" : [ "someOtherParam" ]
  },
  "templateType" : "Realtime",
  "isDynamic" : true,
  "workflowCount" : 2,
  "templateName" : "Default.myTemplate",
  "isEncrypted" : false,
  "isValid" : true,
  "packageVersion" : "1.0",
  "permission" : {
    "read" : true,
    "write" : true,
    "execute" : true
  },
  "packageName" : "MyConfigPack",
  "nodeNames" : [ "Analysis_1", "Disk_1" ],
  "templateKey" : "MZ1570020702163"
}, {
  "parametersSchema" : {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "description" : "the schema of the parameters property for any dynamic workflow based on this template",
    "type" : "object",
    "properties" : {
      "someParam" : {
        "type" : "string",
        "description" : "someParam description"
      },
      "someOtherParam" : {
        "description" : "someOtherParam description",
        "enum" : [ "ONE", "TWO" ]
      }
    },
    "required" : [ "someOtherParam" ]
  },
  "templateType" : "Realtime",
  "isDynamic" : true,
  "workflowCount" : 2,
  "templateName" : "Default.myTemplate",
  "isEncrypted" : false,
  "isValid" : true,
  "packageVersion" : "1.0",
  "permission" : {
    "read" : true,
    "write" : true,
    "execute" : true
  },
  "packageName" : "MyConfigPack",
  "nodeNames" : [ "Analysis_1", "Disk_1" ],
  "templateKey" : "MZ1570020702163"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON coded result with all templates

204

No templates created

500

Server error that prevented the request from being processed ProblemResponse

Workflows

Up
post /workflows/{templateName}/{workflowName}
Create Dynamic Workflow (createWorkflow)
Create Dynamic Workflow based on the given template

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowInput (required)
Body Parameter — The created workflow

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Workflow created WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

404

The given template or workflow was not found. ProblemResponse

Up
post /workflows/{packageName}/{packageVersion}/{templateName}/{workflowName}
Create Dynamic Workflow (createWorkflowConfigPack)
Create Dynamic Workflow based on the given template

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowInput (required)
Body Parameter — The created workflow

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Workflow created WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

404

The given template or workflow was not found. ProblemResponse

Up
delete /workflows/{templateName}/{workflowName}
Delete Dynamic Workflow (deleteWorkflow)
Delete Dynamic Workflow for given template name and workflow name

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Workflow deleted

204

No Workflow found

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

400

The server cannot process the request due to bad/invalid input or the workflow is in running state ProblemResponse

Up
delete /workflows/{packageName}/{packageVersion}/{templateName}/{workflowName}
Delete Dynamic Workflow (deleteWorkflowConfigPack)
Delete Dynamic Workflow for given template name and workflow name

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
workflowName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Workflow deleted

204

No Workflow found

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

400

The server cannot process the request due to bad/invalid input or the workflow is in running state ProblemResponse

Up
put /workflows/execute/{templateName}/{workflowName}
Execute Dynamic Workflow (executeWorkflow)
Execute a Dynamic Workflow START/STOP/DEBUG for the given template name and workflow name,no check on etag, so that user won't blocked on toggling debug if old etag.

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowStatusInput (required)
Body Parameter — Run/Stop/Debug workflow

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

execute workflow WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

412

Precondition failure. Most likely due to a concurrent update. ProblemResponse

Up
put /workflows/execute/{packageName}/{packageVersion}/{templateName}/{workflowName}
Execute Dynamic Workflow (config pack) (executeWorkflowConfigPack)
Execute a Dynamic Workflow START/STOP/DEBUG for the given template name,workflow name, package name and config version.

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowStatusInput (required)
Body Parameter — Run/Stop/Debug workflow

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

execute workflow WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

412

Precondition failure. Most likely due to a concurrent update. ProblemResponse

Up
get /runningevent/{templateName}/{workflowName}
Get running event info on a workflow (getRunningEvent)
Get workflow running event info

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Return type

array[WorkflowETaggedOutput]

Example data

Content-Type: application/json
[ {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
}, {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

204

No dynamic workflows defined

500

Server error that prevented the request from being processed ProblemResponse

Up
get /runningevent/{packageName}/{packageVersion}/{templateName}/{workflowName}
Get running event info on a workflow (config pack) (getRunningEventConfigPack)
Get workflow running event info

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Return type

array[WorkflowETaggedOutput]

Example data

Content-Type: application/json
[ {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
}, {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON object

204

No dynamic workflows defined

500

Server error that prevented the request from being processed ProblemResponse

Up
get /workflows/{templateName}/{workflowName}
Get dynamic workflow (getWorkflow)
Get the dynamically configured workflow for the given template name and workflow name

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The dynamic workflow configuration WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

Up
get /workflows/{packageName}/{packageVersion}/{templateName}/{workflowName}
Get dynamic workflow (getWorkflowConfigPack)
Get the dynamically configured workflow for the given template name and workflow name

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
workflowName (required)
Path Parameter

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The dynamic workflow configuration WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

Up
get /workflowsimage/{packageName}/{packageVersion}/{templateName}/{workflowName}
Get workflow image snapshot(Config Pack) (getWorkflowImageByTeamplateInstanceConfigPack)
Get the workflow image snapshot according to the workflow version saved by package name, package version, template name and workflow name

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A PNG image file

500

Server error that prevented the request from being processed ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /workflowsimage/{templateName}/{workflowName}
Get workflow image snapshot (getWorkflowImageByTemplateInstance)
Get the workflow image snapshot according to the workflow version saved

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A PNG image file

500

Server error that prevented the request from being processed ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /workflows
Get a list of all dynamic workflows (getWorkflows)
Get a list of workflows configured to be dynamic

Return type

array[WorkflowETaggedOutput]

Example data

Content-Type: application/json
[ {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
}, {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON coded result with all workflows

204

No dynamic workflows defined

500

Server error that prevented the request from being processed ProblemResponse

Up
get /workflows/{templateName}
Get a list of workflows matching template (getWorkflowsByTemplate)
Get a list of workflows matching template

Path parameters

templateName (required)
Path Parameter

Return type

array[WorkflowETaggedOutput]

Example data

Content-Type: application/json
[ {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
}, {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON coded result with workflows matching template

500

Server error that prevented the request from being processed ProblemResponse

404

The given template was not found. ProblemResponse

Up
get /workflows/{packageName}/{packageVersion}/{templateName}
Get a list of workflows matching template (getWorkflowsByTemplatePackage)
Get a list of workflows matching template

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter

Return type

array[WorkflowETaggedOutput]

Example data

Content-Type: application/json
[ {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
}, {
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "configVersion" : 3,
  "pendingChanges" : true,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "packageVersion" : "1.0",
  "workflowName" : "Workflow_1",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "ETag" : "ETag",
  "storedEc" : "ec1",
  "packageName" : "myPackage",
  "state" : "Running",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  },
  "runningEc" : "ec1"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

JSON coded result with workflows matching template

500

Server error that prevented the request from being processed ProblemResponse

404

The given template was not found. ProblemResponse

Up
put /workflows/{templateName}/{workflowName}
Update Dynamic Workflow (updateWorkflow)
Update Dynamic Workflow for the given template name and workflow name

Path parameters

templateName (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowInput (required)
Body Parameter — The created workflow

Request headers

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Workflow updated WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

412

Precondition failure. Most likely due to a concurrent update. ProblemResponse

Up
put /workflows/{packageName}/{packageVersion}/{templateName}/{workflowName}
Update Dynamic Workflow (updateWorkflowConfigPack)
Update Dynamic Workflow for the given template name and workflow name

Path parameters

templateName (required)
Path Parameter
packageName (required)
Path Parameter
packageVersion (required)
Path Parameter
workflowName (required)
Path Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body WorkflowInput (required)
Body Parameter — The created workflow

Request headers

Return type

WorkflowOutput

Example data

Content-Type: application/json
{
  "creator" : "SomeUserId",
  "lockerWfName" : "Default.collectWorkflow.wf1",
  "pendingChanges" : true,
  "configVersion" : 3,
  "lastModifiedDate" : "2000-01-23T04:56:07.000+00:00",
  "warnings" : "Workflow is invalid due to missing required parameter x.",
  "workflowName" : "Workflow_1",
  "packageVersion" : "1.0",
  "useExtRef" : {
    "Interval" : true,
    "timeunit" : false
  },
  "nodeNames" : "/{\"agent_1\", \"agent_2\"}",
  "enabled" : true,
  "workflow debug mode" : true,
  "packageNameAndVersion" : "packageNameAndVersion",
  "templateName" : "Default.collectWorkflow",
  "storedEc" : "ec1",
  "state" : "Running",
  "packageName" : "myPackage",
  "runningEc" : "ec1",
  "parameters" : {
    "Interval" : 4096,
    "timeunit" : "SECONDS"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Workflow updated WorkflowOutput

500

Server error that prevented the request from being processed ProblemResponse

404

The given template or workflow was not found. ProblemResponse

400

The server cannot process the request due to bad/invalid input ProblemResponse

412

Precondition failure. Most likely due to a concurrent update. ProblemResponse

Models

[ Jump to Methods ]

Table of Contents

  1. ExternalReferenceIn
  2. ExternalReferenceOut
  3. GroupMemberBaseDto
  4. GroupMemberDto
  5. MemberConfigOutput
  6. MemberWorkflowConfigOutput
  7. ProblemResponse
  8. Reason
  9. WfStateAgentData
  10. WfStateWorkflowData
  11. WorkflowETaggedOutput
  12. WorkflowGroupData
  13. WorkflowGroupDayPlan
  14. WorkflowGroupEvent
  15. WorkflowGroupExecSettings
  16. WorkflowGroupInput
  17. WorkflowGroupInterval
  18. WorkflowGroupOutput
  19. WorkflowGroupOutputData
  20. WorkflowGroupSchedule
  21. WorkflowInput
  22. WorkflowInstanceDetails
  23. WorkflowOutput
  24. WorkflowStatusInput
  25. WorkflowTemplateInfo
  26. WorkflowTemplateInfo_permission
  27. WorkflowTemplatePermission

ExternalReferenceIn Up

values
Object Key/value pairs
example: {"Key1":"Value1","Key2":"Value2"}

ExternalReferenceOut Up

profile
String External reference profile
example: SomeFolder.SomeName
values
Object Key/value pairs
example: {"Key1":"Value1","Key2":"Value2"}
last_modified_date
Date Last modified date format: date-time
packageName
String Name of config package
example: MyConfigPack
packageVersion (optional)
String Version of config package
example: 1.0
isEncrypted (optional)
Boolean Is the profile encrypted
example: false

GroupMemberBaseDto Up

Workflow group member minimal info object
packageName (optional)
String Configuration package name
example: Package
packageVersion (optional)
String Configuration package version
example: 1.0.0
folder
String Configuration folder
example: Default
name
String Configuration name
example: Default.workwflowgroup
workflowName (optional)
String Configuration workflow part of name
example: workwflow_1

GroupMemberDto Up

A short info object of a workflow group member
packageName (optional)
String Configuration package name
example: Package
packageVersion (optional)
String Configuration package version
example: 1.0.0
folder
String Configuration folder
example: Default
name
String Configuration name
example: Default.workwflowgroup
workflowName (optional)
String Configuration workflow part of name
example: workwflow_1
type
String The major type of configuration
Enum:
Task workflow
Batch workflow
Realtime workflow
Group
Template
TASKWFINSTANCE
BATCHWFINSTANCE
RTWFINSTANCE
GROUP
TEMPLATE
example: BATCHWFINSTANCE
prereqs (optional)
array[GroupMemberBaseDto] An array of workflow group member's prerequisites names, which decide the execution order of the different group members

MemberConfigOutput Up

A short info object of a configuration
packageName (optional)
String Configuration package name
example: Package
packageVersion (optional)
String Configuration package version
example: 1.0.0
folder
String Configuration folder
example: Default
name
String Configuration name
example: Default.workwflowgroup
type
String The major type of configuration
Enum:
Batch
Realtime
Task
System Task
BATCH
REALTIME
TASK
SYSTEM_TASK
example: BATCH
version
Integer Configuration version format: int32
example: 1
isDynamic
Boolean Configuration dynamic mode
example: true
owner
String Configuration owner
example: mzadmin
configType
String Whether this is a workflow group or workflow template config
Enum:
GROUP
WORKFLOW
example: GROUP

MemberWorkflowConfigOutput Up

A short info object of a workflow template configuration
packageName (optional)
String Configuration package name
example: Package
packageVersion (optional)
String Configuration package version
example: 1.0.0
folder
String Configuration folder
example: Default
name
String Configuration name
example: Default.workwflowgroup
type
String The major type of configuration
Enum:
Batch
Realtime
Task
System Task
BATCH
REALTIME
TASK
SYSTEM_TASK
example: BATCH
version
Integer Configuration version format: int32
example: 1
isDynamic
Boolean Configuration dynamic mode
example: true
owner
String Configuration owner
example: mzadmin
workflows (optional)
array[WorkflowInstanceDetails] An array of workflow names of given workflow template
configType
String Whether this is a workflow group or workflow template config
Enum:
GROUP
WORKFLOW
example: GROUP

ProblemResponse Up

RFC 7807 compliant response body (https://tools.ietf.org/html/rfc7807).
type
title
status
Integer format: int32
detail
instance
String format: uri
timestamp
Date format: date-time
reasons (optional)
array[Reason] Problem reason(s).

Reason Up

Problem reason(s).
reason
context (optional)
String Reason context. For instance a json path.

WfStateAgentData Up

Workflow state data
agent
String Name of the agent
example: Disk_1
fields (optional)
Object Fields as a JSON object.
example: {"Next_Seqno":84}

WfStateWorkflowData Up

Workflow state data
workflowName
String Name of the workflow
example: workflow_1
agents (optional)
array[WfStateAgentData] An array of agent state fields

WorkflowETaggedOutput Up

templateName
String Name of template
example: Default.collectWorkflow
packageName (optional)
String Config Package name
example: myPackage
packageVersion (optional)
String Config Package version
example: 1.0
workflowName
String Name of workflow
example: Workflow_1
parameters (optional)
Object Parameters as a JSON object
example: {"Interval":4096,"timeunit":"SECONDS"}
state
String State of workflow
Enum:
Invalid
Idle
Loading
Running
Executed
Waiting
Unreachable
Aborted
Hold
Building
Completed
Not started
Running NOT started
Never executed
Locked
Unknown
example: Running
runningEc (optional)
String Name of Execution Context where workflow is or was running
example: ec1
storedEc (optional)
String Name of Execution Context from user
example: ec1
enabled (optional)
Boolean Indicates if the workflow is enabled or disabled
example: true
useExtRef (optional)
map[String, Boolean] Map indicating which parameter(s) that use External Reference value
example: {"Interval":true,"timeunit":false}
workflow debug mode (optional)
Boolean Get the workflow debug mode.
example: true
configVersion (optional)
Integer Configuration data version in Dynamic Workflow table format: int32
example: 3
nodeNames (optional)
array[String] Node Names in a workflow, has values when getWorkflow
example: /{"agent_1", "agent_2"}
lockerWfName (optional)
String Returns locker workflow if state is locked
example: Default.collectWorkflow.wf1
warnings (optional)
array[String] Information about problems that may prevent execution of the workflow.
example: Workflow is invalid due to missing required parameter x.
creator (optional)
String The creator of the workflow.
example: SomeUserId
pendingChanges (optional)
Boolean The workflow has been changed since it was started.
example: true
lastModifiedDate
Date Last modified date format: date-time
packageNameAndVersion (optional)
ETag
String ETag of this workflow. Must be supplied as value of "If-Match" header in any update request (PUT) for this workflow.

WorkflowGroupData Up

Configuration data
memberList
array[GroupMemberDto] List of members to execute
delay
Integer Group startup delay format: int32
example: 0
maxRunningWorkflows
Integer Max simultaneous running workflows format: int32
example: 10
continuousExecution
Boolean Continuous workflow execution
example: false
abortBehavior
String Behavior when member aborts
Enum:
Continue
Batch
Immediate
example: Continue
schedule
executionSettings (optional)

WorkflowGroupDayPlan Up

Schedule day plans list
type
String Day plan type
Enum:
MONTHLY
WEEKLY
DAILY
example: DAILY
day (optional)
Integer Number of day format: int32
example: 1
shallExecute
Boolean Is a day off
example: true
start (optional)
String Day plan start time (hh:mm:ss)
example: 00:00:00
stop (optional)
String Day plan stop time (hh:mm:ss)
example: 09:59:59
interval (optional)

WorkflowGroupEvent Up

Schedule event triggers list
eventName
String Event name
example: Agent Event
className
String Event class full name
example: com.digitalroute.wf.event.AgentEvent
matchers (optional)
map[String, array[String]] Event field name to match values list map
example: {"agentName":["disk_1"]}

WorkflowGroupExecSettings Up

Execution specifics settings
enabled
Boolean Enable execution settings for group
example: false
distributionType
String Execution settings distribution mechanism
Enum:
Sequential
Workflow Count
Machine Load
Round Robin
SEQUENTIAL
WORKFLOW_COUNT
MACHINE_LOAD
ROUND_ROBIN
example: ROUND_ROBIN
executionGroups
array[String] Execution contexts groups
example: ["ecg1","ecg2"]

WorkflowGroupInput Up

A full description object of workflow group
folder (optional)
String Configuration folder
example: Default
name
String Configuration name
example: workwflowgroup
accessGroups
array[String] Configuration access groups
example: ["Administrator","Administrator","Administrator"]
data
comment (optional)
String Configuration version comment
example: some comment
enable (optional)
Boolean Enable the group and all members
example: true

WorkflowGroupInterval Up

Day plan execution interval
type
String Day plan interval type
Enum:
SECOND
MIN
HOUR
example: MIN
number
Integer Day plan interval length format: int32
example: 5

WorkflowGroupOutput Up

A full description object of workflow group
folder (optional)
String Configuration folder
example: Default
name
String Configuration name
example: workwflowgroup
accessGroups
array[String] Configuration access groups
example: ["Administrator","Administrator","Administrator"]
owner
String Configuration owner
example: mzadmin
packageName (optional)
String Configuration package name
example: Package
packageVersion (optional)
String Configuration package version
example: 1.0.0
data
auxiliaryData (optional)
map[String, String] Configuration auxiliary data map
example: {"IsDynamic":true}
enabled (optional)
Boolean Workflow group enabled/disable flag
example: false

WorkflowGroupOutputData Up

Configuration data
memberList
array[GroupMemberDto] List of members to execute
delay
Integer Group startup delay format: int32
example: 0
maxRunningWorkflows
Integer Max simultaneous running workflows format: int32
example: 10
continuousExecution
Boolean Continuous workflow execution
example: false
abortBehavior
String Behavior when member aborts
Enum:
Continue
Batch
Immediate
example: Continue
schedule
executionSettings (optional)
primaryType
String What primary(batch or realtime) type of workflow this group supports
Enum:
Batch
Realtime
Task
System Task
BATCH
REALTIME
TASK
SYSTEM_TASK
example: BATCH

WorkflowGroupSchedule Up

Execution schedule settings
allDPs
array[WorkflowGroupDayPlan] Schedule day plans list
eventTriggers
array[array[WorkflowGroupEvent]] Schedule event triggers list

WorkflowInput Up

state (optional)
String State of workflow
Enum:
Completed
Running
example: Running
ec (optional)
String Name of EC
example: ec1
parameters (optional)
Object Parameters as a JSON object.Must conform to the parametersSchema of the template. To refer a value to an external reference, use the following syntax: "@databaseReference.key". In this case the useExtRef property will also have to be set accordingly.
example: {"interval":4096,"timeunit":"SECONDS","data":"@someDb.someKey"}
enabled (optional)
Boolean Set if the workflow should be enabled or disabled
useExtRef (optional)
map[String, Boolean] Map indicating which parameter(s) that use External Reference value
example: {"interval":false,"timeunit":false,"data":true}
stopType (optional)
String Type of how the workflow should be stopped
Enum:
Immediate
Batch
example: Batch
debug (optional)
Boolean Set if the debug output should be enabled or disabled

WorkflowInstanceDetails Up

An array of workflow names of given workflow template
name (optional)
creator (optional)

WorkflowOutput Up

state
String State of workflow
Enum:
Invalid
Idle
Loading
Running
Executed
Waiting
Unreachable
Aborted
Hold
Building
Completed
Not started
Running NOT started
Never executed
Locked
Unknown
example: Running
runningEc (optional)
String Name of Execution Context where workflow is or was running
example: ec1
storedEc (optional)
String Name of Execution Context from user
example: ec1
parameters (optional)
Object Parameters as a JSON object
example: {"Interval":4096,"timeunit":"SECONDS"}
enabled (optional)
Boolean Indicates if the workflow is enabled or disabled
example: true
workflowName
String Name of workflow
example: Workflow_1
templateName
String Name of template
example: Default.collectWorkflow
useExtRef (optional)
map[String, Boolean] Map indicating which parameter(s) that use External Reference value
example: {"Interval":true,"timeunit":false}
pendingChanges (optional)
Boolean The workflow has been changed since it was started.
example: true
workflow debug mode (optional)
Boolean Get the workflow debug mode.
example: true
configVersion (optional)
Integer Configuration data version in Dynamic Workflow table format: int32
example: 3
lastModifiedDate
Date Last modified date format: date-time
nodeNames (optional)
array[String] Node Names in a workflow, has values when getWorkflow
example: /{"agent_1", "agent_2"}
packageName (optional)
String Config Package name
example: myPackage
packageVersion (optional)
String Config Package version
example: 1.0
lockerWfName (optional)
String Returns locker workflow if state is locked
example: Default.collectWorkflow.wf1
warnings (optional)
array[String] Information about problems that may prevent execution of the workflow.
example: Workflow is invalid due to missing required parameter x.
creator (optional)
String The creator of the workflow.
example: SomeUserId
packageNameAndVersion (optional)

WorkflowStatusInput Up

state (optional)
String State of workflow
Enum:
Completed
Running
example: Running
debug (optional)
Boolean Set if the debug output should be enabled or disabled

WorkflowTemplateInfo Up

templateKey (optional)
String Key of template
example: MZ1570020702163
templateName (optional)
String Name of template
example: Default.myTemplate
packageName (optional)
String Name of config package
example: MyConfigPack
packageVersion (optional)
String Version of config package
example: 1.0
workflowCount (optional)
Integer Number of workflows of this template format: int32
example: 2
parametersSchema (optional)
map[String, Object] The JSON schema of the parameters property for any dynamic workflow based on this template.
example: {"$schema":"http://json-schema.org/draft-04/schema#","description":"the schema of the parameters property for any dynamic workflow based on this template","type":"object","properties":{"someParam":{"type":"string","description":"someParam description"},"someOtherParam":{"description":"someOtherParam description","enum":["ONE","TWO"]}},"required":["someOtherParam"]}
permission (optional)
templateType (optional)
String Type of the template
Enum:
Batch
Realtime
Task
System Task
example: Realtime
nodeNames (optional)
array[String] Workflow Nodes name
example: ["Analysis_1","Disk_1"]
isDynamic (optional)
Boolean Is the template dynamic
example: true
isEncrypted (optional)
Boolean Is the template encrypted
example: false
isValid (optional)
Boolean Is the template valid
example: true

WorkflowTemplateInfo_permission Up

Permissions of the workflow by current user
read (optional)
write (optional)
execute (optional)

WorkflowTemplatePermission Up

Permissions of the workflow by current user
read (optional)
write (optional)
execute (optional)