REST API

Data: aut

  • Namespace: http://genologics.com/ri/automation
  • XML Schema File: aut.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element automation

The automation element integrates the process with the Automation Worker (previously called External Program Plugin or EPP). When a user runs the process, the system automatically issue a command, or submits files and scripts to third-party programs for further processing.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <aut:automation xmlns:aut="http://genologics.com/ri/automation" uri="..." name="..."> <context> <!--content of type 'context'--> ... </context> <string> <!--content of type 'string'--> ... </string> <run-program-per-event> <!--content of type 'boolean'--> ... </run-program-per-event> <channel> <!--content of type 'string'--> ... </channel> <file:file xmlns:file="http://genologics.com/ri/file">...</file:file> <file:file xmlns:file="http://genologics.com/ri/file">...</file:file> <!--...more "file" elements...--> <process-types> <process-type uri="..." name="..."> <!--content of type 'process-type'--> </process-type> <process-type> <!--(another 'process-type' type)--> </process-type> <!--...more "process-type" elements...--> </process-types> </aut:automation>

Element automations

The representation for a list of automation links.

Example XML

<?xml version="1.0" encoding="UTF-8"?> <aut:automations xmlns:aut="http://genologics.com/ri/automation" uri="..."> <automation name="..." uri="..."> <!--content of type 'automation-link'--> </automation> <automation> <!--(another 'automation-link' type)--> </automation> <!--...more "automation" elements...--> <previous-page uri="..."> <!--content of type 'page'--> </previous-page> <next-page uri="..."> <!--content of type 'page'--> </next-page> </aut:automations>

Type automation

The automation element integrates the process with the Automation Worker (previously called External Program Plugin or EPP). When a user runs the process, the system automatically issue a command, or submits files and scripts to third-party programs for further processing.

Attributes

name type description
uri anyURI The URI of the automation.
Always returns with GET: Yes
name string The name of the automation.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: Yes
Required for PUT: Yes

Child Elements

name (type) min/max
occurs
description
context (context) 0/1 The context of this automation. The only available value is Context.STEP.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: No
Required for PUT: Yes
string (string) 0/1 The value of the automation.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: Yes
Required for PUT: Yes
run-program-per-event (boolean) 0/1 Deprecated, this property is no longer supported. Should the automation run once for each process related event?
Always returns with GET: Yes
channel (string) 0/1 The channel of this automation.
Always returns with GET: Yes
Creatable with POST: Yes
Required for POST: Yes
Updatable with PUT: Yes
Required for PUT: Yes
file () 0/unbounded Each File provides a URI linking to the detailed representation of a File associated with the Automation.
Always returns with GET: No, however if one or more files are attached to a given Automation they will be returned.
Creatable with POST: No
Required for POST: No
Updatable with PUT: No
Required for PUT: No, files cannot be modified through the Automation resource. Use the Files resource instead.
process-types/process-type (process-type) 0/unbounded The list of process types the automation is enabled on.
Always returns with GET: No
Updatable with PUT: No
Required for PUT: No

Type automation-link

automation-Link is a child element type of automations and provides a URI linking to the detailed representation of a automation.

Attributes

name type description
name string The name of the automation.
Always returns with GET: Yes
uri anyURI The URI of the automation.
Always returns with GET: Yes

Type automations

The representation for a list of automation links.

Attributes

name type description
uri anyURI The URI of the automations.
Always returns with GET: Yes

Child Elements

name (type) min/max
occurs
description
automation (automation-link) 0/unbounded The list of automations.
Always returns with GET: Yes
previous-page (page) 0/1 The previous page element, contains a link to the previous page of automations, if required.
Always returns with GET: No
next-page (page) 0/1 The next page element, contains a link to the next page of automations, if required.
Always returns with GET: No

Type context

The available options for the automation context.

Possible Values

value description
STEP The context of this automation will be a step

Type process-type

Provides links to process types the automation is enabled on.

Attributes

name type description
uri anyURI The URI of the process type.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No
name string The name of the process type.
Always returns with GET: Yes
Updatable with PUT: No
Required for PUT: No

Home

REST Endpoints

XML Data Elements

XML Data Types