HCL Workload Automation API

Overview

HCL Workload Automation REST API

Version information

Version : 1.0.1

URI scheme

BasePath : /twsd

Paths

Get Engine Info

GET/engine/info

Responses


HTTP Code	Description	Schema
200	Engine Info Headers : `Context-Locale` (string)	EngineInfo

Produces

application/json

Get Mailbox Filling Percentage

GET/engine/mailbox_fill_percentage

Parameters


Type	Name	Schema
Query	mailboxName optional	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	integer

Produces

application/json

GET operation for the Active Rules

GET/eventrule/deployment/active_rules

Description

Retrieve information about the active rules

Parameters


Type	Name	Description	Schema
Query	scratch optional	The option to recreate the xml file	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WarningMessagesInfo

Produces

application/json

START operation for the event builder

PUT/eventrule/deployment/rule_builder/start

Description

Perform a start operation for the event builder

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

STOP operation for the event builder

PUT/eventrule/deployment/rule_builder/stop

Description

Perform a stop operation for the event builder

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

GET operation for Action Plugin Configuration

GET/eventrule/engine/action_plugin_configuration

Description

Gets the XML file with the possible attributes regarding each Action.

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< string > array

Produces

application/json

GET operation for ActionRun in an EventRule

GET/eventrule/engine/action_run

Description

Returns all the ActionRun, inside the model, used by the EventRule identified by the given Identifier

Parameters


Type	Name	Schema
Query	eventruleId optional	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< ActionRunHeader > array

Produces

application/json

POST operation for run a List of ActionRun

POST/eventrule/engine/action_run/action/run

Description

Runs the specified ActionRun(s).

Parameters


Type	Name	Schema
Body	body optional	< ActionRun > array

Responses


HTTP Code	Description	Schema
201	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

Query operation for ActionRun

POST/eventrule/engine/action_run/header/query

Description

Perform a event rule engine query to retrieve ActionRun in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Body	body optional		QueryFilterEventRuleEngine

Responses


HTTP Code	Description	Schema
200	ActionRun Header responses Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< ActionRunHeader > array

Consumes

application/json

Produces

application/json

Query operation for ActionRun

POST/eventrule/engine/action_run/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Body	body optional		QueryEventRuleEngineContext

Responses


HTTP Code	Description	Schema
200	ActionRun Header responses Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< ActionRunHeader > array

Consumes

application/json

Produces

application/json

GET operation for ActionRun

GET/eventrule/engine/action_run/{actionrunId}

Description

Perform a model get to retrieve an ActionRun object, by its identifier, in its "object" shape.

Parameters


Type	Name	Description	Schema
Path	actionrunId required	ActionRun Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	ActionRun

Produces

application/json

Query operation for AuditRecord

POST/eventrule/engine/audit_record/header/query

Description

Perform a event rule engine query to retrieve AuditRecord in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Body	body optional		QueryFilterEventRuleEngine

Responses


HTTP Code	Description	Schema
200	ActionRun Header responses Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< AuditRecordHeader > array

Consumes

application/json

Produces

application/json

Query operation for AuditRecord

POST/eventrule/engine/audit_record/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Body	body optional		QueryEventRuleEngineContext

Responses


HTTP Code	Description	Schema
200	ActionRun Header responses Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< AuditRecordHeader > array

Consumes

application/json

Produces

application/json

GET operation for AuditRecord

GET/eventrule/engine/audit_record/{auditrecordId}

Description

Perform a model get to retrieve an AuditRecord object, by its identifier, in its "object" shape.

Parameters


Type	Name	Schema
Path	auditrecordId required	string

Responses


HTTP Code	Description	Schema
200	ActionRun Header responses Headers : `Context-Locale` (string)	AuditRecord

Produces

application/json

GET operation for Event Plugin Configuration

GET/eventrule/engine/event_plugin_configuration

Description

Gets the XML file with the possible attributes regarding each Event.

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< string > array

Produces

application/json

Query operation for MessageLogRecord

POST/eventrule/engine/message_log_record/header/query

Description

Perform a event rule engine query to retrieve MessageLogRecord in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Body	body optional		QueryFilterEventRuleEngine

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< MessageLogRecordHeader > array

Consumes

application/json

Produces

application/json

Query operation for MessageLogRecord

POST/eventrule/engine/message_log_record/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Body	body optional		QueryEventRuleEngineContext

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< MessageLogRecordHeader > array

Consumes

application/json

Produces

application/json

GET operation for MessageLogRecord

GET/eventrule/engine/message_log_record/{messagelogrecordId}

Description

Perform a model get to retrieve a MessageLogRecord object, by its identifier, in its "object" shape.

Parameters


Type	Name	Description	Schema
Path	messagelogrecordId required	MessageLogRecord Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	MessageLogRecord

Produces

application/json

Query operation for RuleInstance

POST/eventrule/engine/rule_instance/header/query

Description

Perform a event rule engine query to retrieve RuleInstance in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Body	body optional		QueryFilterEventRuleEngine

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< RuleInstanceHeader > array

Consumes

application/json

Produces

application/json

Query operation for RuleInstance

POST/eventrule/engine/rule_instance/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Body	body optional		QueryEventRuleEngineContext

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< RuleInstanceHeader > array

Consumes

application/json

Produces

application/json

GET operation for RuleInstance

GET/eventrule/engine/rule_instance/{ruleinstanceId}

Description

Perform a model get to retrieve a RuleInstance object, by its identifier, in its "object" shape.

Parameters


Type	Name	Description	Schema
Path	ruleinstanceId required	RuleInstance Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	RuleInstance

Produces

application/json

ADD operation for AccessControlList

POST/model/access_control_list

Description

Returns the identifier of the added object.

Parameters


Type	Name	Schema
Body	body optional	AccessControlList

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for AccessControlList using a TWSKey

GET/model/access_control_list

Description

Perform a model get to retrieve, by its name or key, a AccessControlList object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	AccessControlList

Produces

application/json
text/html
text/plain

DELETE operation for AccessControlList using a TWSKey

DELETE/model/access_control_list

Description

Remove, by its name or key, a AccessControlList object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for AccessControlList using a TWSKey

PUT/model/access_control_list/action/lock

Description

Locks a AccessControlList by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for AccessControlList using a TWSKey

PUT/model/access_control_list/action/unlock

Description

Unlocks a AccessControlList by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for AccessControlList

GET/model/access_control_list/header/query

Description

Perform a model query to retrieve AccessControlLists

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< AccessControlList > array

Produces

application/json
text/html
text/plain

QUERY operation for AccessControlList

GET/model/access_control_list/header/query_next

Description

Returns a list of objects according to the query params. This method should be used only for subsequent calls not for the first one. For the first call use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< AccessControlList > array

Produces

application/json
text/html
text/plain

QUERY operation for AccessControlList keys

GET/model/access_control_list/key/query

Description

Perform a model query to retrieve AccessControlList keys.

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< AccessControlListKey > array

Produces

application/json
text/html
text/plain

GET operation for AccessControlList using a TWSId

GET/model/access_control_list/{accessControlListId}

Description

Perform a model get to retrieve by its identifier a AccessControlList object in its "object" shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	accessControlListId required	AccessControlList Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	AccessControlList

Produces

application/json
text/html
text/plain

UPDATE operation for AccessControlList using a TWSId

PUT/model/access_control_list/{accessControlListId}

Description

Update a AccessControlList object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	accessControlListId required	AccessControlList Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		AccessControlList

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

DELETE operation for AccessControlList using a TWSId

DELETE/model/access_control_list/{accessControlListId}

Description

Remove, by its identifier, a AccessControlList object.

Parameters


Type	Name	Description	Schema
Path	accessControlListId required	AccessControlList Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for AccessControlList using a TWSId

PUT/model/access_control_list/{accessControlListId}/action/lock

Description

Locks a AccessControlList by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	accessControlListId required	AccessControlList Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for AccessControlList using a TWSId

PUT/model/access_control_list/{accessControlListId}/action/unlock

Description

Unlocks a AccessControlList by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	accessControlListId required	AccessControlList Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Calendar

POST/model/calendar

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	Calendar

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for Calendar using a TWSKey

GET/model/calendar

Description

Perform a model get to retrieve, by its name, an Calendar object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Calendar

Produces

application/json

DELETE operation for Calendar using a TWSKey

DELETE/model/calendar

Description

Remove, by its name, an Calendar object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Calendar using a TWSKey

PUT/model/calendar/action/lock

Description

Locks an Calendar by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Calendar using a TWSKey

PUT/model/calendar/action/unlock

Description

Unlocks an Calendar by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Calendar

POST/model/calendar/header/query

Description

Perform a model query to retrieve Calendar in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< CalendarHeader > array

Consumes

application/json

Produces

application/json

QUERY operation for Calendar

POST/model/calendar/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< CalendarHeader > array

Consumes

application/json

Produces

application/json

GET operation for Calendar using a TWSId

GET/model/calendar/{calendarId}

Description

Perform a model get to retrieve, by its identifier, an Calendar object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	calendarId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Calendar

Produces

application/json

UPDATE operation for Calendar using a TWSId

PUT/model/calendar/{calendarId}

Description

Update an Calendar object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	calendarId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Calendar

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for Calendar using a TWSId

DELETE/model/calendar/{calendarId}

Description

Remove, by its identifier, an Calendar object

Parameters


Type	Name	Schema
Path	calendarId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Calendar using a TWSId

PUT/model/calendar/{calendarId}/action/lock

Description

Locks an Calendar by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	calendarId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Calendar using a TWSId

PUT/model/calendar/{calendarId}/action/unlock

Description

Unlocks an Calendar by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	calendarId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Domain

POST/model/domain

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	Domain

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Domain using a TWSKey

GET/model/domain

Description

Perform a model get to retrieve, by its name, an Domain object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Domain

Produces

application/json
text/plain

DELETE operation for Domain using a TWSKey

DELETE/model/domain

Description

Remove, by its name, an Domain object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Domain using a TWSKey

PUT/model/domain/action/lock

Description

Locks an Domain by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Domain using a TWSKey

PUT/model/domain/action/unlock

Description

Unlocks an Domain by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Domain

POST/model/domain/header/query

Description

Perform a model query to retrieve Domain in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Domain > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for Domain

POST/model/domain/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Domain > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Domain using a TWSId

GET/model/domain/{domainId}

Description

Perform a model get to retrieve, by its name, an Domain object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	domainId required	Domain Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	EventRule

Produces

application/json
text/plain

UPDATE operation for Domain using a TWSId

PUT/model/domain/{domainId}

Description

Update an Domain object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	domainId required	Domain Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Domain

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for Domain using a TWSId

DELETE/model/domain/{domainId}

Description

Remove, by its identifier, an Domain object

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Domain using a TWSId

PUT/model/domain/{domainId}/action/lock

Description

Locks an Domain by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	domainId required	Domain Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Domain using a TWSId

PUT/model/domain/{domainId}/action/unlock

Description

Unlocks an Domain by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	domainId required	Domain Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for EventRule

POST/model/eventrule

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	EventRule

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for EventRule using a TWSKey

GET/model/eventrule

Description

Perform a model get to retrieve, by its name, an EventRule object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	EventRule

Produces

application/json

DELETE operation for EventRule using a TWSKey

DELETE/model/eventrule

Description

Remove, by its name, an EventRule object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for EventRule using a TWSKey

PUT/model/eventrule/action/lock

Description

Locks an EventRule by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for EventRule using a TWSKey

PUT/model/eventrule/action/unlock

Description

Unlocks an EventRule by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for EventRule

POST/model/eventrule/header/query

Description

Perform a model query to retrieve EventRule in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< EventRuleHeader > array

Consumes

application/json

Produces

application/json

QUERY operation for EventRule

POST/model/eventrule/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< EventRuleHeader > array

Consumes

application/json

Produces

application/json

GET operation for EventRule using a TWSId

GET/model/eventrule/{eventruleId}

Description

Perform a model get to retrieve, by its name, an EventRule object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	eventruleId required	Eventrule Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	EventRule

Produces

application/json

UPDATE operation for EventRule using a TWSId

PUT/model/eventrule/{eventruleId}

Description

Update an EventRule object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	eventruleId required	Eventrule Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		EventRule

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for EventRule using a TWSId

DELETE/model/eventrule/{eventruleId}

Description

Remove, by its identifier, an EventRule object

Parameters


Type	Name	Description	Schema
Path	eventruleId required	Eventrule Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for EventRule using a TWSId

PUT/model/eventrule/{eventruleId}/action/lock

Description

Locks an EventRule by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	eventruleId required	Eventrule Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for EventRule using a TWSId

PUT/model/eventrule/{eventruleId}/action/unlock

Description

Unlocks an EventRule by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	eventruleId required	Eventrule Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Folder

POST/model/folder

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	Folder

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Folder using a TWSKey

GET/model/folder

Description

Perform a model get to retrieve, by its TWSKey, a Folder object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Folder

Produces

application/json
text/plain

DELETE operation for Folder using a TWSKey

DELETE/model/folder

Description

Remove, by its name, a Folder object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Folder using a TWSKey

PUT/model/folder/action/lock

Description

Locks an Folder by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Folder using a TWSKey

PUT/model/folder/action/unlock

Description

Unlocks an Folder Definition by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Folder

POST/model/folder/header/query

Description

Perform a model query to retrieve Folder Definition in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Folder > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for Folder

POST/model/folder/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Folder > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Folder using a TWSId

GET/model/folder/{folderId}

Description

Perform a model get to retrieve, by its TWSId, a Folder object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	folderId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Folder

Produces

application/json
text/plain

UPDATE operation for Folder using a TWSId

PUT/model/folder/{folderId}

Description

Update an Folder object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	folderId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Folder

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for Folder using a TWSId

DELETE/model/folder/{folderId}

Description

Remove, by its identifier, a Folder object

Parameters


Type	Name	Schema
Path	folderId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Folder using a TWSId

PUT/model/folder/{folderId}/action/lock

Description

Locks an Folder by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	folderId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Folder using a TWSId

PUT/model/folder/{folderId}/action/unlock

Description

Unlocks an Folder by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	folderId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Job Definition

POST/model/jobdefinition

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	JobDefinition

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Job Definition using a TWSKey

GET/model/jobdefinition

Description

Perform a model get to retrieve, by its TWSKey, a Job Definition object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobDefinition

Produces

application/json
text/plain

DELETE operation for Job Definition using a TWSKey

DELETE/model/jobdefinition

Description

Remove, by its name, a Job Definition object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Job Definition using a TWSKey

PUT/model/jobdefinition/action/lock

Description

Locks a Job Definition by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Job Definition using a TWSKey

PUT/model/jobdefinition/action/unlock

Description

Unlocks a Job Definition by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Job Definition

POST/model/jobdefinition/header/query

Description

Perform a model query to retrieve Job Definition in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobDefinitionHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for Job Definition

POST/model/jobdefinition/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobDefinitionHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Job Definition using a TWSId

GET/model/jobdefinition/{jobdefinitionId}

Description

Perform a model get to retrieve, by its TWSId, a Job Definition object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobdefinitionId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobDefinition

Produces

application/json
text/plain

UPDATE operation for Job Definition using a TWSId

PUT/model/jobdefinition/{jobdefinitionId}

Description

Update a Job Definition object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobdefinitionId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		JobDefinition

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for Job Definition using a TWSId

DELETE/model/jobdefinition/{jobdefinitionId}

Description

Remove, by its identifier, a Job Definition object

Parameters


Type	Name	Schema
Path	jobdefinitionId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Job Definition using a TWSId

PUT/model/jobdefinition/{jobdefinitionId}/action/lock

Description

Locks a Job Definition by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobdefinitionId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Job Definition using a TWSId

PUT/model/jobdefinition/{jobdefinitionId}/action/unlock

Description

Unlocks a Job Definition by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobdefinitionId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for JobDetailedStatistic

POST/model/jobdetailedstatistic

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	JobDetailedStatistic

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json

QUERY operation for Job Definition

POST/model/jobdetailedstatistic/query

Description

Perform a model query to retrieve Job Definition in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobDetailedStatistic > array

Consumes

application/json

Produces

application/json

UPDATE operation for JobDetailedStatistic Object using a TWSId

PUT/model/jobdetailedstatistic/{jobdetailedstatisticid}

Description

Update a JobDetailedStatistics object

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobdetailedstatisticid required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		JobDetailedStatistic

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/octet-stream

QUERY operation for Job History Run

POST/model/jobhistoryrun/query

Description

Perform a model query to retrieve Job History Run

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobHistoryRun > array

Consumes

application/json

Produces

application/json

GET operation for JobStatistics using a TWSKey

POST/model/jobstatistics

Description

Perform a model get to retrieve, by Job TWSKey, a JobStatistics object in its shape.

Parameters


Type	Name	Description	Schema
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobStatistics

Produces

application/json

GET operation for JobStatistics using a TWSId

GET/model/jobstatistics/{jobId}

Description

Perform a model get to retrieve, by job identifier, a JobStatistics object in its shape.

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobStatistics

Produces

application/json

ADD operation for JobStream

POST/model/jobstream

Description

Returns the identifier of the added object

Parameters


Type	Name	Description	Schema
Header	Context-JobStreamScope optional	1=The scope integer used to identify the properties of a job stream 2=The scope integer used to identify a job stream with its run cycles only 3=The scope integer used to identify the whole content of a job stream, except for run cycles 4=The scope integer used to identify the whole content of a job stream without job definitions 5=The scope integer used to identify the whole content of a job stream	integer
Body	body optional		JobStream

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-JobStreamScope` (integer) : 1=The scope integer used to identify the properties of a job stream 2=The scope integer used to identify a job stream with its run cycles only 3=The scope integer used to identify the whole content of a job stream, except for run cycles 4=The scope integer used to identify the whole content of a job stream without job definitions 5=The scope integer used to identify the whole content of a job stream. `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for JobStream using a TWSKey

GET/model/jobstream

Description

Perform a model get to retrieve, by its name, an JobStream object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	validFrom optional		string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobStream

Produces

application/json
text/plain

DELETE operation for JobStream using a TWSKey

DELETE/model/jobstream

Description

Remove, by its name, an JobStream object

Parameters


Type	Name	Description	Schema
Header	Context-JobStreamScope optional	1=The scope integer used to identify the properties of a job stream 2=The scope integer used to identify a job stream with its run cycles only 3=The scope integer used to identify the whole content of a job stream, except for run cycles 4=The scope integer used to identify the whole content of a job stream without job definitions 5=The scope integer used to identify the whole content of a job stream	integer
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	validFrom optional		string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-JobStreamScope` (integer) : 1=The scope integer used to identify the properties of a job stream 2=The scope integer used to identify a job stream with its run cycles only 3=The scope integer used to identify the whole content of a job stream, except for run cycles 4=The scope integer used to identify the whole content of a job stream without job definitions 5=The scope integer used to identify the whole content of a job stream. `Context-Locale` (string)	No Content

LOCK operation for JobStream using a TWSKey

PUT/model/jobstream/action/lock

Description

Locks an JobStream by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	validFrom optional		string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for JobStream using a TWSKey

PUT/model/jobstream/action/unlock

Description

Unlocks an JobStream by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	validFrom optional		string
Query	verbose optional		boolean
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for JobStream

POST/model/jobstream/header/query

Description

Perform a model query to retrieve JobStream in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobStreamHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for JobStream

POST/model/jobstream/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobStreamHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for JobStream using a TWSId

GET/model/jobstream/{jobstreamId}

Description

Perform a model get to retrieve, by its name, an JobStream object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobstreamId required	JobStream Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobStream

Produces

application/json
text/plain

UPDATE operation for JobStream using a TWSId

PUT/model/jobstream/{jobstreamId}

Description

Update an JobStream object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobstreamId required	JobStream Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		JobStream

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for JobStream using a TWSId

DELETE/model/jobstream/{jobstreamId}

Description

Remove, by its identifier, an JobStream object

Parameters


Type	Name	Description	Schema
Header	Context-JobStreamScope optional	1=The scope integer used to identify the properties of a job stream 2=The scope integer used to identify a job stream with its run cycles only 3=The scope integer used to identify the whole content of a job stream, except for run cycles 4=The scope integer used to identify the whole content of a job stream without job definitions 5=The scope integer used to identify the whole content of a job stream	integer
Path	jobstreamId required	JobStream Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-JobStreamScope` (integer) : 1=The scope integer used to identify the properties of a job stream 2=The scope integer used to identify a job stream with its run cycles only 3=The scope integer used to identify the whole content of a job stream, except for run cycles 4=The scope integer used to identify the whole content of a job stream without job definitions 5=The scope integer used to identify the whole content of a job stream. `Context-Locale` (string)	No Content

LOCK operation for JobStream using a TWSId

PUT/model/jobstream/{jobstreamId}/action/lock

Description

Locks an JobStream by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobstreamId required	JobStream Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for JobStream using a TWSId

PUT/model/jobstream/{jobstreamId}/action/unlock

Description

Unlocks an JobStream by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	jobstreamId required	JobStream Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Prompt

POST/model/prompt

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	Prompt

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for Prompt using a TWSKey

GET/model/prompt

Description

Perform a model get to retrieve, by its name, an Prompt object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Prompt

Produces

application/json

DELETE operation for Prompt using a TWSKey

DELETE/model/prompt

Description

Remove, by its name, an Prompt object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Prompt using a TWSKey

PUT/model/prompt/action/lock

Description

Locks an Prompt by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Prompt using a TWSKey

PUT/model/prompt/action/unlock

Description

Unlocks an Prompt by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Prompt

POST/model/prompt/header/query

Description

Perform a model query to retrieve Prompt in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Prompt > array

Consumes

application/json

Produces

application/json

QUERY operation for Prompt

POST/model/prompt/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Prompt > array

Consumes

application/json

Produces

application/json

GET operation for Prompt using a TWSId

GET/model/prompt/{promptId}

Description

Perform a model get to retrieve, by its name, an Prompt object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	promptId required	Prompt Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Prompt

Produces

application/json

UPDATE operation for Prompt using a TWSId

PUT/model/prompt/{promptId}

Description

Update an Prompt object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	promptId required	Prompt Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Prompt

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for Prompt using a TWSId

DELETE/model/prompt/{promptId}

Description

Remove, by its identifier, an Prompt object

Parameters


Type	Name	Description	Schema
Path	promptId required	Prompt Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Prompt using a TWSId

PUT/model/prompt/{promptId}/action/lock

Description

Locks an Prompt by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	promptId required	Prompt Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Prompt using a TWSId

PUT/model/prompt/{promptId}/action/unlock

Description

Unlocks an Prompt by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	promptId required	Prompt Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

GET all Model property

GET/model/properties

Description

Returns all Model properties

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< StringMapObj > array

Produces

application/json

GET Model property

GET/model/properties/{propertyName}

Description

Returns a Model properties

Parameters


Type	Name	Schema
Path	propertyName required	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	StringMapObj

Produces

application/json
text/plain

Update a Model property

PUT/model/properties/{propertyName}

Description

Update a Model properties

Parameters


Type	Name	Schema
Path	propertyName required	string
Body	body optional	string

Responses


HTTP Code	Description	Schema
default	default response Headers : `Context-Locale` (string)	No Content

Produces

application/json

ADD operation for Resource

POST/model/resource

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	Resource

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for Resource using a TWSKey

GET/model/resource

Description

Perform a model get to retrieve, by its TWSKey, a Resource object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Resource

Produces

application/json

DELETE operation for Resource using a TWSKey

DELETE/model/resource

Description

Remove, by its name, a Resource object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Resource using a TWSKey

PUT/model/resource/action/lock

Description

Locks an Resource by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Resource using a TWSKey

PUT/model/resource/action/unlock

Description

Unlocks a Resource Definition by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Resource

POST/model/resource/header/query

Description

Perform a model query to retrieve Resource in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< ResourceHeader > array

Consumes

application/json

Produces

application/json

QUERY operation for Resource

POST/model/resource/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< ResourceHeader > array

Consumes

application/json

Produces

application/json

GET operation for Resource using a TWSId

GET/model/resource/{resourceId}

Description

Perform a model get to retrieve, by its TWSId, a Resource object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	resourceId required	Resource Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Resource

Produces

application/json

UPDATE operation for Resource using a TWSId

PUT/model/resource/{resourceId}

Description

Update an Resource object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	resourceId required	Resource Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Resource

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for Resource using a TWSId

DELETE/model/resource/{resourceId}

Description

Remove, by its identifier, a Resource object

Parameters


Type	Name	Description	Schema
Path	resourceId required	Resource Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Resource using a TWSId

PUT/model/resource/{resourceId}/action/lock

Description

Locks a Resource by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	resourceId required	Resource Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Resource using a TWSId

PUT/model/resource/{resourceId}/action/unlock

Description

Unlocks a Resource by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	resourceId required	Resource Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Run Cycle Group

POST/model/runcyclegroup

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	RunCycleGroup

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Run Cycle Group using a TWSKey

GET/model/runcyclegroup

Description

Perform a model get to retrieve, by its TWSKey, a RunCycleGroup object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	RunCycleGroup

Produces

application/json
text/plain

DELETE operation for Run Cycle Group using a TWSKey

DELETE/model/runcyclegroup

Description

Remove, by its name, an Run Cycle Group object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Run Cycle Group using a TWSKey

PUT/model/runcyclegroup/action/lock

Description

Locks an Run Cycle Group by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Run Cycle Group using a TWSKey

PUT/model/runcyclegroup/action/unlock

Description

Unlocks an Run Cycle Group Definition by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Run Cycle Group

POST/model/runcyclegroup/header/query

Description

Perform a model query to retrieve Job Definition in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< RunCycleGroupHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for Run Cycle Group

POST/model/runcyclegroup/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< RunCycleGroupHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Run Cycle Group using a TWSId

GET/model/runcyclegroup/{runcyclegroupId}

Description

Perform a model get to retrieve, by its TWSId, a Run Cycle Group object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	runcyclegroupId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	RunCycleGroup

Produces

application/json
text/plain

UPDATE operation for Run Cycle Group using a TWSId

PUT/model/runcyclegroup/{runcyclegroupId}

Description

Update an Run Cycle Group object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	runcyclegroupId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		RunCycleGroup

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for Run Cycle Group using a TWSId

DELETE/model/runcyclegroup/{runcyclegroupId}

Description

Remove, by its identifier, a Run Cycle Group object

Parameters


Type	Name	Schema
Path	runcyclegroupId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Run Cycle Group using a TWSId

PUT/model/runcyclegroup/{runcyclegroupId}/action/lock

Description

Locks an Run Cycle Group by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	runcyclegroupId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Run Cycle Group using a TWSId

PUT/model/runcyclegroup/{runcyclegroupId}/action/unlock

Description

Unlocks an Run Cycle Group by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	runcyclegroupId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for SecurityDomain

POST/model/security_domain

Description

Returns the identifier of the added object.

Parameters


Type	Name	Schema
Body	body optional	SecurityDomain

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for SecurityDomain using a TWSKey

GET/model/security_domain

Description

Perform a model get to retrieve, by its name or key, a SecurityDomain object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	SecurityDomain

Produces

application/json
text/html
text/plain

DELETE operation for SecurityDomain using a TWSKey

DELETE/model/security_domain

Description

Remove, by its name, a SecurityDomain object.

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for SecurityDomain using a TWSKey

PUT/model/security_domain/action/lock

Description

Locks a SecurityDomain by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

RENAME operation for SecurityDomain using its name

PUT/model/security_domain/action/rename

Description

Renames an SecurityDomain by its key, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	newname optional	The new name for the renamed Object	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Produces

application/json
text/html
text/plain

UNLOCK operation for SecurityDomain using a TWSKey

PUT/model/security_domain/action/unlock

Description

Unlocks a SecurityDomain by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for SecurityDomain

GET/model/security_domain/header/query

Description

Perform a model query to retrieve SecurityDomain

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< SecurityDomain > array

Produces

application/json
text/html
text/plain

QUERY operation for SecurityDomain

GET/model/security_domain/header/query_next

Description

Returns a list of objects according to the query params. This method should be used only for subsequent calls not for the first one. For the first call use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< SecurityDomain > array

Produces

application/json
text/html
text/plain

QUERY operation for SecurityDomain keys

GET/model/security_domain/key/query

Description

Perform a model query to retrieve SecurityDomain keys.

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< SecurityDomainKey > array

Produces

application/json
text/html
text/plain

GET operation for SecurityDomain using a TWSId

GET/model/security_domain/{securityDomainId}

Description

Perform a model get to retrieve by its identifier a SecurityDomain object in its "object" shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityDomainId required	SecurityDomain Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	SecurityDomain

Produces

application/json
text/html
text/plain

UPDATE operation for SecurityDomain using a TWSId

PUT/model/security_domain/{securityDomainId}

Description

Update a SecurityDomain object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityDomainId required	SecurityDomain Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		SecurityDomain

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

DELETE operation for SecurityDomain using a TWSId

DELETE/model/security_domain/{securityDomainId}

Description

Remove, by its identifier, a SecurityDomain object.

Parameters


Type	Name	Description	Schema
Path	securityDomainId required	SecurityDomain Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for SecurityDomain using a TWSId

PUT/model/security_domain/{securityDomainId}/action/lock

Description

Locks a SecurityDomain by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityDomainId required	SecurityDomain Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for SecurityDomain using a TWSId

PUT/model/security_domain/{securityDomainId}/action/unlock

Description

Unlocks a SecurityDomain by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityDomainId required	SecurityDomain Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for SecurityRole

POST/model/security_role

Description

Returns the identifier of the added object.

Parameters


Type	Name	Schema
Body	body optional	SecurityRole

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for AccessControlList using a TWSKey

GET/model/security_role

Description

Perform a model get to retrieve, by its name or key, a SecurityRole object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	SecurityRole

Produces

application/json
text/html
text/plain

DELETE operation for SecurityRole using a TWSKey

DELETE/model/security_role

Description

Remove, by its name or key, a SecurityRole object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for SecurityRole using a TWSKey

PUT/model/security_role/action/lock

Description

Locks a SecurityRole by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

RENAME operation for SecurityRole using its name

PUT/model/security_role/action/rename

Description

Renames an SecurityRole by its key, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	newname optional	The new name for the renamed Object	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Produces

application/json
text/html
text/plain

UNLOCK operation for SecurityRole using a TWSKey

PUT/model/security_role/action/unlock

Description

Unlocks a SecurityRole by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for SecurityRole

GET/model/security_role/header/query

Description

Perform a model query to retrieve SecurityRole

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< SecurityRole > array

Produces

application/json
text/html
text/plain

QUERY operation for SecurityRole

GET/model/security_role/header/query_next

Description

Returns a list of objects according to the query params. This method should be used only for subsequent calls not for the first one. For the first call use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< SecurityRole > array

Produces

application/json
text/html
text/plain

QUERY operation for AccessControlList keys

GET/model/security_role/key/query

Description

Perform a model query to retrieve AccessControlList keys.

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	< SecurityRoleKey > array

Produces

application/json
text/html
text/plain

GET operation for SecurityRole using a TWSId

GET/model/security_role/{securityRoleId}

Description

Perform a model get to retrieve by its identifier a SecurityRole object in its "object" shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityRoleId required	SecurityRole Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	SecurityRole

Produces

application/json
text/html
text/plain

UPDATE operation for SecurityRole using a TWSId

PUT/model/security_role/{securityRoleId}

Description

Update a SecurityRole object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityRoleId required	SecurityRole Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		SecurityRole

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

DELETE operation for SecurityRole using a TWSId

DELETE/model/security_role/{securityRoleId}

Description

Remove, by its identifier, a SecurityRole object.

Parameters


Type	Name	Description	Schema
Path	securityRoleId required	SecurityRole Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for SecurityRole using a TWSId

PUT/model/security_role/{securityRoleId}/action/lock

Description

Locks a SecurityRole by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityRoleId required	SecurityRole Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for SecurityRole using a TWSId

PUT/model/security_role/{securityRoleId}/action/unlock

Description

Unlocks a SecurityRole by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	securityRoleId required	SecurityRole Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for User

POST/model/user

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	User

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for User using a TWSKey

GET/model/user

Description

Perform a model get to retrieve, by its TWSKey, a User object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	User

Produces

application/json
text/plain

DELETE operation for User using a TWSKey

DELETE/model/user

Description

Remove, by its name, an User object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for User using a TWSKey

PUT/model/user/action/lock

Description

Locks an User by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for User using a TWSKey

PUT/model/user/action/unlock

Description

Unlocks an User Definition by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean
Query	workstationName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for User

POST/model/user/header/query

Description

Perform a model query to retrieve User in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< User > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for User

POST/model/user/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< User > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for User using a TWSId

GET/model/user/{userId}

Description

Perform a model get to retrieve, by its TWSId, a User object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	userId required	User Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	JobDefinition

Produces

application/json
text/plain

UPDATE operation for User using a TWSId

PUT/model/user/{userId}

Description

Update an User object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	userId required	User Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		User

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for User using a TWSId

DELETE/model/user/{userId}

Description

Remove, by its identifier, a User object

Parameters


Type	Name	Description	Schema
Path	userId required	User Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for User using a TWSId

PUT/model/user/{userId}/action/lock

Description

Locks an User by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	userId required	User Id	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for User using a TWSId

PUT/model/user/{userId}/action/unlock

Description

Unlocks an User by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	userId required	User Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Variable

POST/model/variable

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	Variable

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for Variable using a TWSKey

GET/model/variable

Description

Perform a model get to retrieve, by its TWSKey, a Variable Table object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	isInDefaultTable optional		boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	variableTableName optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Variable

Produces

application/json

DELETE operation for Variable using a TWSKey

DELETE/model/variable

Description

Remove, by its name, a Variable object

Parameters


Type	Name	Description	Schema
Query	isInDefaultTable optional		boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	variableTableName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Variable using a TWSKey

PUT/model/variable/action/lock

Description

Locks a Variable by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	isInDefaultTable optional		boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	variableTableName optional		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Variable using a TWSKey

PUT/model/variable/action/unlock

Description

Unlocks a Variable by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	isInDefaultTable optional		boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	variableTableName optional		string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Variable

POST/model/variable/header/query

Description

Perform a model query to retrieve Variable in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Variable > array

Consumes

application/json

Produces

application/json

QUERY operation for Variable

POST/model/variable/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< Variable > array

Consumes

application/json

Produces

application/json

GET operation for Variable using a TWSId

GET/model/variable/{variableId}

Description

Perform a model get to retrieve, by its TWSId, a Variable object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	VariableTable

Produces

application/json

UPDATE operation for Variable using a TWSId

PUT/model/variable/{variableId}

Description

Update a Variable object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Variable

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for Variable using a TWSId

DELETE/model/variable/{variableId}

Description

Remove, by its identifier, a Variable object

Parameters


Type	Name	Schema
Path	variableId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Variable using a TWSId

PUT/model/variable/{variableId}/action/lock

Description

Locks a Variable by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Variable using a TWSId

PUT/model/variable/{variableId}/action/unlock

Description

Unlocks a Variable by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Variable Table

POST/model/variabletable

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	VariableTable

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for Variable Table using a TWSKey

GET/model/variabletable

Description

Perform a model get to retrieve, by its TWSKey, a Variable Table object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	VariableTable

Produces

application/json

DELETE operation for Variable Table using a TWSKey

DELETE/model/variabletable

Description

Remove, by its name, a Variable Table object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Variable Table using a TWSKey

PUT/model/variabletable/action/lock

Description

Locks a Variable Table by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Variable Table using a TWSKey

PUT/model/variabletable/action/unlock

Description

Unlocks a Variable Table by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Variable Table

POST/model/variabletable/header/query

Description

Perform a model query to retrieve Variable Table in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< VariableTableHeader > array

Consumes

application/json

Produces

application/json

QUERY operation for Variable Table

POST/model/variabletable/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< VariableTableHeader > array

Consumes

application/json

Produces

application/json

GET operation for Variable Table using a TWSId

GET/model/variabletable/{variableTableId}

Description

Perform a model get to retrieve, by its TWSId, a Variable Table object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableTableId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	VariableTable

Produces

application/json

UPDATE operation for Variable Table using a TWSId

PUT/model/variabletable/{variableTableId}

Description

Update a Variable Table object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableTableId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		VariableTable

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json
text/plain

DELETE operation for Variable Table using a TWSId

DELETE/model/variabletable/{variableTableId}

Description

Remove, by its identifier, a Variable Table object

Parameters


Type	Name	Schema
Path	variableTableId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Variable Table using a TWSId

PUT/model/variabletable/{variableTableId}/action/lock

Description

Locks a Variable Table by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableTableId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Variable Table using a TWSId

PUT/model/variabletable/{variableTableId}/action/unlock

Description

Unlocks a Variable Table by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	variableTableId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

CREATE operation for Workload Application

POST/model/workload_application

Description

CREATE operation for Workload Application

Parameters


Type	Name	Description	Schema
Header	Context-Contents optional	Context-Contents True will add only the contents of Workload Application Template without creating a Workload Application , default FALSE	boolean
Body	body optional		DeployWorkloadApplicationTemplate

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	string

Consumes

application/json

Produces

application/json

GET operation for Workload Application using a TWSKey

GET/model/workload_application

Description

Perform a model get to retrieve, using a TWSKey, a Workload Application object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WorkloadApplication

Produces

application/json

DELETE operation for Workload Application using a TWSKey

DELETE/model/workload_application

Description

Remove, by its name, an Workload Application object

Parameters


Type	Name	Description	Schema
Header	Context-Contents optional	Context-Contents True will add only the contents of Workload Application Template without creating a Workload Application , default FALSE	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Workload Application using a TWSKey

PUT/model/workload_application/action/lock

Description

Locks a Workload Application by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Workload Application using a TWSKey

PUT/model/workload_application/action/unlock

Description

Unlocks a Workload Application Definition by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Workload Application

POST/model/workload_application/header/query

Description

Perform a model query to retrieve Workload Application in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkloadApplicationHeader > array

Consumes

application/json

Produces

application/json

QUERY operation for Workload Application

POST/model/workload_application/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkloadApplicationHeader > array

Consumes

application/json

Produces

application/json

GET operation for Workload Application using a TWSId

GET/model/workload_application/{workloadapplicationId}

Description

Perform a model get to retrieve, by its TWSId, a Workload Application object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadapplicationId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WorkloadApplication

Produces

application/json

UPDATE operation for Workload Application using a TWSId

PUT/model/workload_application/{workloadapplicationId}

Description

Update an Workload Application object.

Parameters


Type	Name	Description	Schema
Header	Context-Contents optional	Context-Contents True will add only the contents of Workload Application Template without creating a Workload Application , default FALSE	boolean
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadapplicationId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		WorkloadApplication

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json

Produces

application/json

DELETE operation for Workload Application using a TWSId

DELETE/model/workload_application/{workloadapplicationId}

Description

Remove, by its identifier, an Workload Application object

Parameters


Type	Name	Description	Schema
Header	Context-Contents optional	Context-Contents True will add only the contents of Workload Application Template without creating a Workload Application , default FALSE	boolean
Path	workloadapplicationId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Workload Application using a TWSId

PUT/model/workload_application/{workloadapplicationId}/action/lock

Description

Locks an Workload Application by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadapplicationId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Workload Application using a TWSId

PUT/model/workload_application/{workloadapplicationId}/action/unlock

Description

Unlocks a Workload Application Definition by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadapplicationId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Workload Application Template

POST/model/workload_application_template

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	WorkloadApplicationTemplate

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

GET operation for Workload Application Template using a TWSKey

GET/model/workload_application_template

Description

Perform a model get to retrieve, by its TWSKey, a Variable Table object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WorkloadApplicationTemplate

Produces

application/json
text/html
text/plain

DELETE operation for Workload Application Template using a TWSKey

DELETE/model/workload_application_template

Description

Remove, by its name, a Workload Application Template object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Workload Application Template using a TWSKey

PUT/model/workload_application_template/action/lock

Description

Locks a Workload Application Template by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Workload Application Template using a TWSKey

PUT/model/workload_application_template/action/unlock

Description

Unlocks a Workload Application Template by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Workload Application Template

POST/model/workload_application_template/header/query

Description

Perform a model query to retrieve Workload Application Template in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkloadApplicationTemplateHeader > array

Consumes

application/json

Produces

application/json

QUERY operation for Workload Application Template

POST/model/workload_application_template/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkloadApplicationTemplateHeader > array

Consumes

application/json

Produces

application/json

GET operation for Workload Application Template using a TWSId

GET/model/workload_application_template/{workloadApplicationTemplateId}

Description

Perform a model get to retrieve, by its TWSId, a Workload Application Template object in its shape

Parameters


Type	Name	Description	Schema
Path	workloadApplicationTemplateId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WorkloadApplicationTemplate

Produces

application/json
text/html
text/plain

UPDATE operation for Workload Application Template using a TWSId

PUT/model/workload_application_template/{workloadApplicationTemplateId}

Description

Update a Workload Application Template object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadApplicationTemplateId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		WorkloadApplicationTemplate

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/html
text/plain

DELETE operation for Workload Application Template using a TWSId

DELETE/model/workload_application_template/{workloadApplicationTemplateId}

Description

Remove, by its identifier, a Workload Application Template object

Parameters


Type	Name	Schema
Path	workloadApplicationTemplateId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Workload Application Template using a TWSId

PUT/model/workload_application_template/{workloadApplicationTemplateId}/action/lock

Description

Locks a Workload Application Template by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadApplicationTemplateId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Workload Application Template using a TWSId

PUT/model/workload_application_template/{workloadApplicationTemplateId}/action/unlock

Description

Unlocks a Workload Application Template by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workloadApplicationTemplateId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

ADD operation for Workstation

POST/model/workstation

Description

Returns the identifier of the added object.

Parameters


Type	Name	Schema
Body	body optional	Workstation

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Workstation using a TWSKey

GET/model/workstation

Description

Perform a model get to retrieve, using a TWSKey, a Workstation object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Workstation

Produces

application/json
text/plain

DELETE operation for Workstation using a TWSKey

DELETE/model/workstation

Description

Remove, using a TWSKey, a Workstation object.

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation.	No Content

LOCK operation for Workstation using a TWSKey

PUT/model/workstation/action/lock

Description

Locks a Workstation object by external key, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation.	No Content

UNLOCK operation for Workstation using a TWSKey

PUT/model/workstation/action/unlock

Description

Unlocks a Workstation object by external key, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation.	No Content

QUERY operation for Workstation

POST/model/workstation/header/query

Description

Perform a model query to retrieve Workstations in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkstationHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for Workstation

POST/model/workstation/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkstationHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

Check if the object is a workstation

POST/model/workstation/is_workstation

Description

Returns true if the name belongs to a workstation, false if it belongs to a workstationClass.

Parameters


Type	Name	Schema
Body	body optional	StringMapObj

Responses


HTTP Code	Description	Schema
200	StringResponse	No Content

Consumes

application/json
text/plain

GET operation for Workstation using a TWSId

GET/model/workstation/{workstationId}

Description

Perform a model get to retrieve, by its identifier, a Workstation object in its shape.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationId required	Workstation Id	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Workstation

Produces

application/json
text/plain

UPDATE operation for Workstation using a TWSId

PUT/model/workstation/{workstationId}

Description

Update a Workstation object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationId required	Workstation Id	string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		Workstation

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for Workstation using a TWSId

DELETE/model/workstation/{workstationId}

Description

Remove, by its identifier, a Workstation object.

Parameters


Type	Name	Description	Schema
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation.	No Content

LOCK operation for Workstation using a TWSId

PUT/model/workstation/{workstationId}/action/lock

Description

Locks a Workstation object by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation.	No Content

UNLOCK operation for Workstation using a TWSId

PUT/model/workstation/{workstationId}/action/unlock

Description

Unlocks a Workstation object by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationId required	Workstation Id	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation.	No Content

ADD operation for Workstation Class

POST/model/workstationclass

Description

Returns the identifier of the added object

Parameters


Type	Name	Schema
Body	body optional	WorkstationClass

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Workstation Class using a TWSKey

GET/model/workstationclass

Description

Perform a model get to retrieve, by its TWSKey, a Job Definition object in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WorkstationClass

Produces

application/json
text/plain

DELETE operation for Workstation Class using a TWSKey

DELETE/model/workstationclass

Description

Remove, by its name, a Workstation Class object

Parameters


Type	Name	Description	Schema
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Workstation Class using a TWSKey

PUT/model/workstationclass/action/lock

Description

Locks a Workstation Class by name, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Workstation Class using a TWSKey

PUT/model/workstationclass/action/unlock

Description

Unlocks a Workstation Class by name, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	key optional	Mutual exclusive with the "name" query parameter. One of the two is required.	string
Query	name optional	Mutual exclusive with the "key" query parameter. One of the two is required.	string
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

QUERY operation for Workstation Class

POST/model/workstationclass/header/query

Description

Perform a model query to retrieve Workstation Class in their "header" shape.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Body	body optional		QueryFilterModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkstationClassHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

QUERY operation for Workstation Class

POST/model/workstationclass/header/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		FiltersModel

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkstationClassHeader > array

Consumes

application/json
text/plain

Produces

application/json
text/plain

GET operation for Workstation Class using a TWSId

GET/model/workstationclass/{workstationClassId}

Description

Perform a model get to retrieve, by its TWSId, a Workstation Class in its shape

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationClassId required		string
Query	lock optional	True if the object must be locked while being retrieved. If missing, default is false	boolean

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	WorkstationClass

Produces

application/json
text/plain

UPDATE operation for Workstation Class using a TWSId

PUT/model/workstationclass/{workstationClassId}

Description

Update a Workstation Class object.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationClassId required		string
Query	isLocked optional	True if the object is expected to be locked by the user, false if it is expected to be unlocked.	boolean
Query	unlock optional	True if the lock must be released after applying the requested update.	boolean
Body	body optional		WorkstationClass

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-Locale` (string)	Created

Consumes

application/json
text/plain

Produces

application/json
text/plain

DELETE operation for Workstation Class using a TWSId

DELETE/model/workstationclass/{workstationClassId}

Description

Remove, by its identifier, a Workstation Class object

Parameters


Type	Name	Schema
Path	workstationClassId required	string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

LOCK operation for Workstation Class using a TWSId

PUT/model/workstationclass/{workstationClassId}/action/lock

Description

Locks a Workstation Class by identifier, checking that the object is not locked by any user.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationClassId required		string

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

UNLOCK operation for Workstation Class using a TWSId

PUT/model/workstationclass/{workstationClassId}/action/unlock

Description

Unlocks a Workstation Class by identifier, checking that it is currently locked by the requesting user and session.

Parameters


Type	Name	Description	Schema
Header	Context-Session optional	Name of the session. Required if the paramenter lock is true.	string
Path	workstationClassId required		string
Query	force optional	True if the object must be unlocked even if the requesting user is currently holding the lock using another session, or if the lock is held by another user and the requesting user has sufficient rights to unlock it.	boolean
Query	verbose optional		boolean

Responses


HTTP Code	Description	Schema
204	No response body is supplied for this operation Headers : `Context-Locale` (string)	No Content

Create a forecast plan or a trial plan

POST/plan/create_plan

Description

Create a forecast plan or a trial plan

Parameters


Type	Name	Schema
Body	body optional	PlanInfo

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Extends a forecast plan or a trial plan

POST/plan/create_trial_plan_extension

Description

Extends a forecast plan or a trial plan

Parameters


Type	Name	Schema
Body	body optional	PlanInfo

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Query operation for Plan

POST/plan/query

Description

Returns a list of objects according to the Filter in the context

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< SymphonyInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Plan

POST/plan/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< SymphonyInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Critical Job in Plan

POST/plan/{planId}/criticaljob/query

Description

Perform a plan query to retrieve Critical Job in plan

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobInPlanOnCriticalNetwork > array

Consumes

application/json

Produces

application/json

Query operation for Critical Job in Plan

POST/plan/{planId}/criticaljob/query_next

Description

Perform a plan query to retrieve Critical Job in plan according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobInPlanOnCriticalNetwork > array

Consumes

application/json

Produces

application/json

Next predecessors for Critical Job in plan

POST/plan/{planId}/criticaljob/query_next_predecessors_chain

Description

Predecessors for Critical Job in plan. This method should be used only for subsequent calls not for the first one. For the first call use the method query_predecessors_chain. Only available for active and all predecessors.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		NextPredecessorsChainInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobInPlanOnCriticalNetwork > array

Consumes

application/json

Produces

application/json

Summary info for Critical Job in plan

POST/plan/{planId}/criticaljob/summary_info

Description

Summary info for Critical Job in plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	critical jobs summary info Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	CriticalJobsSummaryInfo

Consumes

application/json

Produces

application/json

Predecessors for Critical Job in plan

POST/plan/{planId}/criticaljob/{criticalJobId}/query_predecessors_chain

Description

Predecessors for Critical Job in plan

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	criticalJobId required	Critical Job Id for critical path	string
Path	planId required	Plan id - for current plan	string
Body	body optional		PredecessorsChainInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobInPlanOnCriticalNetwork > array

Consumes

application/json

Produces

application/json

Query operation for Domain in Plan

POST/plan/{planId}/domain/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< DomainInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Domain in Plan

POST/plan/{planId}/domain/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< DomainInPlan > array

Consumes

application/json

Produces

application/json

Get Domain in Plan

GET/plan/{planId}/domain/{domainId}

Description

Retrieve a domain In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	DomainInPlan

Produces

application/json

Links the domain workstation

PUT/plan/{planId}/domain/{domainId}/action/link_domain_workstation

Description

Links the domain workstation

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Starts the domain workstation

PUT/plan/{planId}/domain/{domainId}/action/start_domain_workstation

Description

Starts the domain workstation

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Stops the domain workstation

PUT/plan/{planId}/domain/{domainId}/action/stop_domain_workstation

Description

Stops the domain workstation

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Switch the domain manager of given domain

PUT/plan/{planId}/domain/{domainId}/action/switch_domain_manager

Description

Switch the domain manager

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Unlinks the domain workstation

PUT/plan/{planId}/domain/{domainId}/action/unlink_domain_workstation

Description

Unlinks the domain workstation

Parameters


Type	Name	Description	Schema
Path	domainId required	Domain Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Query operation for File in Plan

POST/plan/{planId}/file/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< FileInPlan > array

Consumes

application/json

Produces

application/json

Query operation for File in Plan

POST/plan/{planId}/file/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< FileInPlan > array

Consumes

application/json

Produces

application/json

Get File in Plan

GET/plan/{planId}/file/{fileId}

Description

Retrieve a File In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	fileId required	File Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	FileInPlan

Produces

application/json

Generates a JobInPlan object starting from a JobDefinition taken from the database.

POST/plan/{planId}/job/action/make

Description

Generates a JobInPlan object starting from a JobDefinition taken from the database.

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Query	alias optional		string
Query	jobDefinitionId optional		string
Query	workstationId optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlan

Produces

application/json

Submit ad Hoc Job

POST/plan/{planId}/job/action/submit_ad_hoc_job

Description

Submit ad Hoc Job

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		SubmitJobInfo

Responses


HTTP Code	Description	Schema
201	201 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	Created

Consumes

application/json
text/html
text/plain

Produces

application/json

Returns the Count for Jobs in plan

POST/plan/{planId}/job/count

Description

Returns the Count for Jobs in plan

Parameters


Type	Name	Description	Schema
Header	Accept-Language optional		string
Header	Context-BrokerInfoRequested optional		integer (int32)
Header	Context-ForceCommand optional		integer (int32)
Header	Context-HasMoreObjects optional		integer (int32)
Header	Context-JobHistoryScope optional		integer (int32)
Header	Context-JobStreamScope optional		integer (int32)
Header	Context-ObjectCount optional		integer (int32)
Header	Context-PlanDependenciesScope optional		integer (int32)
Header	Context-StatusScope optional		integer (int32)
Header	Context-TransferMode optional		integer (int32)
Header	Context-UseCache optional		integer (int32)
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		PredecessorsChainInfo

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	string

Consumes

application/json

Produces

application/json

Return issues from plan

POST/plan/{planId}/job/issues

Description

Return issues from plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		IdentifiersListResult

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	WAObjectIssueResult

Consumes

application/json

Produces

application/json

Parse the Preview of the Job In Plan Successors

POST/plan/{planId}/job/jobsuccessors/action/parse

Description

Parse the Preview of the Job In Plan Successors

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		JobInPlanSuccessorsResult

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlanSuccessorsResult

Consumes

application/json

Produces

application/json
text/plain

Query operation for Job in Plan

POST/plan/{planId}/job/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Job in Plan

POST/plan/{planId}/job/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobInPlan > array

Consumes

application/json

Produces

application/json

Get Job In Plan

GET/plan/{planId}/job/{jobId}

Description

Retrieve a Job In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlan

Produces

application/json
text/plain

Update Job in plan

PUT/plan/{planId}/job/{jobId}

Description

Update Job in plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		JobInPlan

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	Created

Consumes

application/json

Produces

application/json
text/plain

Add dependencies to a job in plan

PUT/plan/{planId}/job/{jobId}/action/add_dependencies

Description

Add dependencies to a job in plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		JobDependenciesInPlan

Responses


HTTP Code	Description	Schema
201	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json
text/plain

Cancel Job In Plan

PUT/plan/{planId}/job/{jobId}/action/cancel

Description

Cancel Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Cancel Pending Job In Plan

PUT/plan/{planId}/job/{jobId}/action/cancelpending

Description

Cancel Pending Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Confirm ABEND for Job In Plan

PUT/plan/{planId}/job/{jobId}/action/confirm_abend

Description

Confirm ABEND for Job In Plan

Parameters


Type	Name	Description	Schema
Header	Conditions optional		string
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Confirm SUCC for Job In Plan

PUT/plan/{planId}/job/{jobId}/action/confirm_succ

Description

Confirm SUCC for Job In Plan

Parameters


Type	Name	Description	Schema
Header	Conditions optional		string
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Hold Job In Plan

PUT/plan/{planId}/job/{jobId}/action/hold

Description

Hold Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Kill Job In Plan

PUT/plan/{planId}/job/{jobId}/action/kill

Description

Kill Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Release Job In Plan

PUT/plan/{planId}/job/{jobId}/action/release

Description

Release Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Release All Dependencies from Job In Plan

PUT/plan/{planId}/job/{jobId}/action/release_all_dependencies

Description

Release All Dependencies from Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Release dependencies from job in plan

PUT/plan/{planId}/job/{jobId}/action/release_dependencies

Description

Release dependencies from job in plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		JobDependenciesInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json
text/plain

Remove dependencies from job in plan

PUT/plan/{planId}/job/{jobId}/action/remove_dependencies

Description

Remove dependencies from job in plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		JobDependenciesInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json
text/plain

Rerun Job In Plan

PUT/plan/{planId}/job/{jobId}/action/rerun

Description

Rerun Job In Plan

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		RerunDetails

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json
text/plain

Runs a command on a Job in plan

PUT/plan/{planId}/job/{jobId}/action/run_command

Description

Runs a command on a Job in plan for distributed engine, can be invoked only on MDM

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		JobCommand

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	string

Consumes

application/json
text/plain

Produces

text/plain

Get the List of Critical Job In Plan of a Job

GET/plan/{planId}/job/{jobId}/critical_successors

Description

Get the List of Critical Job In Plan of a Job

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlanSuccessorsResult

Produces

application/json

Get Job Log

GET/plan/{planId}/job/{jobId}/joblog

Description

Returns the JobInPlan output. There are different mode to retrieve the output: single step or different bunch of data (for a very big output) To get the entire JobInPlan output in a single step, call the API without any query parameter. To get the first bunch of a JobInPlan output using lines query parameter. In almost every case it should be enough. For next bunch use the other parameters.

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Query	fileId optional		string
Query	lines optional		integer (int32)
Query	pageNumber optional		integer (int32)

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobLog

Produces

application/json
text/plain

Rerun Job In Plan Successors

PUT/plan/{planId}/job/{jobId}/jobsuccessors/action/rerun

Description

Rerun Job In Plan Successors

Parameters


Type	Name	Description	Schema	Default
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Query	internalOnly optional		boolean	`"false"`
Query	toSkipJobId optional		string

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlanSuccessorsResult

Produces

application/json
text/plain

Rerun Job In Plan List Successors

PUT/plan/{planId}/job/{jobId}/jobsuccessors/list/action/rerun

Description

Rerun Job In Plan List Successors

Parameters


Type	Name	Description	Schema	Default
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Query	internalOnly optional		boolean	`"false"`
Query	toSkipJobId optional		string
Body	body optional		JobInPlanSuccessorsResult

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlanSuccessorsResult

Consumes

application/json

Produces

application/json
text/plain

Get the Preview of the Job In Plan Successors

GET/plan/{planId}/job/{jobId}/jobsuccessors/preview

Description

Get the Preview of the Job In Plan Successors

Parameters


Type	Name	Description	Schema	Default
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Query	failOnListSecurity optional		boolean	`"true"`
Query	failOnMaxJobs optional		boolean	`"true"`
Query	failOnNotInAction optional		boolean	`"false"`
Query	stopOnHold optional		boolean	`"true"`
Query	toSkipJobId optional		string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlanSuccessorsResult

Produces

application/json
text/plain

Get Job predecessors

GET/plan/{planId}/job/{jobId}/predecessors

Description

Get Job predecessors

Parameters


Type	Name	Description	Schema
Path	jobId required	Job Id	string
Path	planId required	Plan id - for current plan	string
Query	How-Many optional		integer (int32)

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlanOnCriticalNetwork

Produces

application/json
text/plain

Cancel a list of JobStream In Plan

PUT/plan/{planId}/jobstream/action/cancel

Description

Cancel a list of JobStream In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		< string > array

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	< StringMapObj > array

Consumes

application/json

Produces

application/json

Cancel a list of pending JobStream In Plan

PUT/plan/{planId}/jobstream/action/cancel_pending

Description

Cancel a list of pending JobStream In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		< string > array

Responses


HTTP Code	Description	Schema
202	202 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	< StringMapObj > array

Consumes

application/json

Produces

application/json

Get first batch of predecessors

POST/plan/{planId}/jobstream/action/next_predecessors

Description

Get first batch of predecessors

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryPlanContext

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobStreamInPlan > array

Consumes

application/json

Produces

application/json

Submit JobStream instance

POST/plan/{planId}/jobstream/action/submit_jobstream

Description

Submit JobStream instance

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		SubmitJobStreamInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	< string > array

Consumes

application/json

Produces

application/json

Only fo Internal Use

POST/plan/{planId}/jobstream/action/what_if

Description

Only fo Internal Use

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Body	body optional		WhatIfInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	WhatIfResult

Consumes

application/json

Produces

application/json

Query operation for JobStream in Plan

POST/plan/{planId}/jobstream/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobStreamInPlan > array

Consumes

application/json

Produces

application/json

Query operation for JobStream in Plan

POST/plan/{planId}/jobstream/query_next

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobStreamInPlan > array

Consumes

application/json

Produces

application/json

Get Job Stream In Plan

GET/plan/{planId}/jobstream/{jobstreamId}

Description

Retrieve a Job Stream In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobStreamInPlan

Produces

application/json

Update JobStream In Plan properties

PUT/plan/{planId}/jobstream/{jobstreamId}

Description

Update JobStream In Plan properties

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		JobStreamInPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	Created

Consumes

application/json

Produces

application/json

Add dependencies to a JobStream in plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/add_dependencies

Description

Add dependencies to a JobStream in plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		DependenciesInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Cancel JobStream In Plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/cancel

Description

Cancel JobStream In Plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Cancel Pending JobStream In Plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/cancel_pending

Description

Cancel Pending JobStream In Plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Disable monitoring of jobs in JobStream by external applications

PUT/plan/{planId}/jobstream/{jobstreamId}/action/disable_jobs_monitoring

Description

Disable monitoring of jobs in JobStream by external applications

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Enable monitoring of jobs in JobStream by external applications

PUT/plan/{planId}/jobstream/{jobstreamId}/action/enable_jobs_monitoring

Description

Enable monitoring of jobs in JobStream by external applications

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Get first batch of predecessors

GET/plan/{planId}/jobstream/{jobstreamId}/action/first_predecessors

Description

Get first batch of predecessors

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Query	How-Many optional		integer (int32)

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< JobStreamInPlan > array

Produces

application/json

Hold JobStream In Plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/hold

Description

Hold JobStream In Plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Make JobStream instance

POST/plan/{planId}/jobstream/{jobstreamId}/action/make_jobstream

Description

Make JobStream instance

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		MakeJobStreamInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobStreamInPlan

Consumes

application/json

Produces

application/json

Release JobStream In Plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/release

Description

Release JobStream In Plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Release all Jobstream In Plan dependencies

PUT/plan/{planId}/jobstream/{jobstreamId}/action/release_all_dependencies

Description

Release all Jobstream In Plan dependencies

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Release dependencies from JobStream in plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/release_dependencies

Description

Release dependencies from JobStream in plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		DependenciesInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

remove dependencies from JobStream in plan

PUT/plan/{planId}/jobstream/{jobstreamId}/action/remove_dependencies

Description

remove dependencies from JobStream in plan

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		DependenciesInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Submit Job in JobStream instance

POST/plan/{planId}/jobstream/{jobstreamId}/action/submit_job

Description

Submit Job in JobStream instance.The JobstreamId you need to specify in this case is the id of the jobstream in plan where the JobInPlan is going to be submitted. In case you want to submit it into JOBS jobstream, what you have to do is to specify ,instead of the jobstream in plan id, the workstation and name of the jobstream separated by the semicolon,

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		SubmitJobIntoJobStreamInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	JobInPlan

Consumes

application/json

Produces

application/json

Submit JobStream instance

POST/plan/{planId}/jobstream/{jobstreamId}/action/submit_jobstream

Description

Submit JobStream instance

Parameters


Type	Name	Description	Schema
Path	jobstreamId required	JobStream Id	string
Path	planId required	Plan id - for current plan	string
Body	body optional		SubmitJobStreamInfo

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	< string > array

Consumes

application/json

Produces

application/json

Query operation for Resource in Plan

POST/plan/{planId}/prompt/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< PromptInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Resource in Plan

POST/plan/{planId}/prompt/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< PromptInPlan > array

Consumes

application/json

Produces

application/json

Get prompt In Plan

GET/plan/{planId}/prompt/{promptId}

Description

Retrieve a prompt In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	promptId required	Prompt Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	PromptInPlan

Produces

application/json

Replies "YES" (true) or "NO" (false) to the specified prompt.

PUT/plan/{planId}/prompt/{promptId}/action/reply

Description

Replies "YES" (true) or "NO" (false) to the specified prompt

Parameters


Type	Name	Description	Schema
Header	Answer optional		string
Path	planId required	Plan id - for current plan	string
Path	promptId required	Prompt Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Query operation for Resource in Plan

POST/plan/{planId}/resource/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< ResourceInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Resource in Plan

POST/plan/{planId}/resource/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< ResourceInPlan > array

Consumes

application/json

Produces

application/json

Get Resource In Plan

GET/plan/{planId}/resource/{resourceId}

Description

Retrieve a Resource In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	resourceId required	Resource Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	ResourceInPlan

Produces

application/json

Update Resource In Plan properties

PUT/plan/{planId}/resource/{resourceId}

Description

Update Resource In Plan properties

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	resourceId required	Resource Id	string
Body	body optional		ResourceInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Query operation for User in Plan

POST/plan/{planId}/user/query

Description

Returns a list of objects according to the Filter in the context.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WindowsUserInPlan > array

Consumes

application/json

Produces

application/json

Query operation for User in Plan

POST/plan/{planId}/user/query_next

Description

Returns a list of objects according to the Filter in the context.Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WindowsUserInPlan > array

Consumes

application/json

Produces

application/json

Get user In Plan

GET/plan/{planId}/user/{userId}

Description

Retrieve a user In Plan by its user id

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	userId required	User Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	WindowsUserInPlan

Produces

application/json

Set the password for the specified user

PUT/plan/{planId}/user/{userId}/action/set_windows_user_password

Description

Set the password for the specified user

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	userId required	User Id	string
Body	body optional		WindowsUserInPlan

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Query operation for Workstation in plan

POST/plan/{planId}/workstation/query

Description

Perform a plan query to retrieve Workstations in plan

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	How-Many optional	How many objects (max 10000) - mutual exclusive with Query-PageSize and Query-PageNumber - used with a query on a first bunch of object. Use 0 (zero) to retrieve all the objects that match the given filter in one shot	integer (int32)
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Header	Query-PageNumber optional	The offset of the first object that must be returned - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 0	integer (int32)
Header	Query-PageSize optional	The number of elements (max 10000) contained in a single returned page - mutual exclusive with How-Many - In plan queries, is used only with the current plan and mirroring enabled - Default Value 10000	integer (int32)
Path	planId required	Plan id - for current plan	string
Body	body optional		QueryFilterPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkstationInPlan > array

Consumes

application/json

Produces

application/json

Query operation for Workstation in Plan

POST/plan/{planId}/workstation/query_next

Description

Returns a list of objects according to the Filter in the context. Use this method only for subsequent calls not for the first call. For the first call, use the method query.

Parameters


Type	Name	Description	Schema
Header	Context-ObjectCount optional	0=The integer used to specify that no object count is requested in queries 1=The integer used to specify that object count is requested in queries	integer
Header	Context-PlanDependenciesScope optional	0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries	integer
Header	Last-Object optional	Identificative string of the last object (or objects) returned in the last query	string
Path	planId required	Plan id - for current plan	string
Body	body optional		FiltersPlan

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-ObjectCount` (integer) : 0=The integer used to specify that no object count is requested in plan queries 1=The integer used to specify that object count is requested in plan queries. `Context-PlanDependenciesScope` (integer) : 0=Disables loading of dependencies in plan queries 1=Enables loading of dependencies in plan queries. `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache. `How-Many-Returned` (integer) : The total number of returned items - used for query next API. Use 0 (zero) to retrieve all the objects that match the filter simultaneously. `Last-Object` (integer) : The latest object identifier - used for query next API.	< WorkstationInPlan > array

Consumes

application/json

Produces

application/json

Get Workstation In Plan

GET/plan/{planId}/workstation/{workstationId}

Description

Retrieve a Workstation In Plan by its plan id

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
200	200 Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	WorkstationInPlan

Produces

application/json

connect to host cpu

PUT/plan/{planId}/workstation/{workstationId}/action/connect_to_host_cpu

Description

connect to host cpu

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string
Body	body optional		WorkstationConnectInfo

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

return health status of workstation In Plan

GET/plan/{planId}/workstation/{workstationId}/action/health_status

Description

return health status of workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Link workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/link

Description

Link workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
200	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

return monitoring configuration of workstation In Plan

GET/plan/{planId}/workstation/{workstationId}/action/monitoring_configuration

Description

return monitoring configuration of workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Start workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/start

Description

start workstationIn Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string
Body	body required	if the Workstation should start as manager	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

start event monitoring processor workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/start_event_monitoring

Description

start event monitoring processor workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

start event processor workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/start_event_processor

Description

start event processor workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Stop workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/stop

Description

Stop workstationIn Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

stop event processor workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/stop_event_processor

Description

stop event processor workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

switch event processor workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/switch_event_processor

Description

switch event processor workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Unlink workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/unlink

Description

Unlink workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Update fence workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/update_fence

Description

Update fence workstationIn Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string
Body	body required	Fence of workstation	integer

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Update limit workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}/action/update_limit

Description

Update limit workstationIn Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string
Body	body required	Limit of workstation	integer

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Consumes

application/json

Upgrade workstation

PUT/plan/{planId}/workstation/{workstationId}/action/upgrade_workstation

Description

Upgrade workstation

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

stop event monitoring processor workstation In Plan

PUT/plan/{planId}/workstation/{workstationId}action/stop_event_monitoring

Description

stop event monitoring processor workstation In Plan

Parameters


Type	Name	Description	Schema
Path	planId required	Plan id - for current plan	string
Path	workstationId required	Workstation Id	string

Responses


HTTP Code	Description	Schema
202	No response body is supplied for this operation Headers : `Context-CheckResync` (integer) : 0=Disables force resync check 1=Enables force resync check. `Context-DatabasePlan` (integer) : 0=Disables loading of plan on database 1=Enables loading of plan on database. `Context-Locale` (string) `Context-PlanId` (string) : The plan id. `Context-StatusScope` (integer) : 0=The integer used to specify old behaviour in plan queries 1=The integer used to specify that workstation fence must not be considered for job status in plan queries. `Context-UseCache` (integer) : 0=Load information without using the cache 1=Load information using the cache.	No Content

Definitions

ACLProperties


Name	Schema
cpus optional	< string > array
group optional	string
roles optional	< RoleProperties > array
user optional	string

AccessControlList


Name	Schema
aclType optional	enum (D, F)
acls optional	< ACLProperties > array
description optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name required	string

AccessControlListKey


Name	Schema
acltype optional	enum (D, F)
key optional	TWSKey
keyPrefix optional	string
keyText optional	string
name optional	string

ActionProperties


Name	Schema
hosts optional	< string > array
ports optional	< string > array
providers optional	< string > array
types optional	< string > array

ActionPropertiesCollection

Type : < ActionRule > array

ActionRule


Name	Schema
exclude optional	ActionProperties
include optional	ActionProperties

ActionRun


Name	Schema
actionId optional	string
header optional	ActionRunHeader
parameterMap optional	StringMap
ruleId optional	string
ruleInstanceId optional	string

ActionRunFilter


Name	Schema
actionId optional	string
actionScope optional	string
actionStatusList optional	< string > array
actionTypeList optional	< string > array
ruleId optional	string
ruleInstanceId optional	string
ruleName optional	string
ruleTypeList optional	< string > array
timeRange optional	TimeRange

ActionRunHeader


Name	Description	Schema
actionResult optional		string
actionScope optional		string
actionStatus optional		string
actionType optional		string
id optional		string
message optional		string
pluginName optional		string
ruleFolderName optional		string
ruleName optional		string
ruleType optional		string
timestamp optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

AuditRecord


Name	Schema
definitionList optional	< string > array
header optional	AuditRecordHeader
objectId optional	string

AuditRecordFilter


Name	Schema
actionType optional	string
auditId optional	string
auditRecordTypeList optional	< string > array
folderName optional	string
justificationCategory optional	string
justificationDescription optional	string
justificationTicketNum optional	string
objName optional	string
objectId optional	string
objectIdForVersion optional	string
objectName optional	string
objectNameForVersion optional	string
objectType optional	string
planObjectId optional	string
relatedObjName optional	string
timeRange optional	TimeRange
userName optional	string
version optional	string
wksNameRelatedObject optional	string
workstationName optional	string

AuditRecordHeader


Name	Description	Schema
actionData optional		string
actionType optional		string
auditType optional		string
cpuFolderName optional		string
differences optional		string
folderName optional		string
id optional		string
labelVersion optional		string
objName optional		string
objectId optional		string
objectName optional		string
objectType optional		string
planObjectId optional		string
reason optional		string
relatedObjName optional		string
resolutionData optional		JustificationData
timestamp optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
userName optional		string
version optional		string
wksNameRelatedObject optional		string
workstationName optional		string

AvailabilityCalendarInterval


Name	Schema
duration optional	integer (int64)
startTime optional	integer (int64)

CPUProperties


Name	Schema
cpus optional	< string > array
folders optional	< string > array
types optional	< string > array

CPUPropertiesCollection

Type : < CPURule > array

CPURule


Name	Schema
exclude optional	CPUProperties
include optional	CPUProperties

Calendar


Name	Description	Schema
daysDescription optional		StringMap
folderId optional		string
header optional		CalendarHeader
iCalendar optional	A list of dates in the following format: yyyymmdd{,yyyymmdd}	string
iCalendarFreeDates optional	A list of free dates in the following format: yyyymmdd{,yyyymmdd}	string
iCalendarFreeWeekdays optional	A list of free week days in the following format: yyyymmdd{,yyyymmdd}	string
iCalendarWeekdays optional	A list of week days in the following format: yyyymmdd{,yyyymmdd}	string
iCalendarWorkDates optional	A list of working dates in the following format: yyyymmdd{,yyyymmdd}	string
iCalendarWorkWeekdays optional	A list of working week days in the following format: yyyymmdd{,yyyymmdd}	string
shiftEndTime optional	Shift end time in the following format: yyyymmdd{,yyyymmdd}	integer (int64)
workloadApplicationId optional	The identifier of the workload application that includes this calendar	string

CalendarFilter


Name	Description	Schema
calendarIdList optional		< string > array
calendarName optional		string
deployedBatchApplicationName optional	Selects calendars referencing the specified workload application directly	string

CalendarHeader


Name	Schema
description optional	string
folderName optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name optional	string

CalendarSorter


Name	Schema
calendarName optional	SorterModel
description optional	SorterModel
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel

ComplexQueryFilters


Name	Description	Schema
complexFilters optional		< ComplexQueryFilters > array
criticalJobInPlanComplexFilter optional		< CriticalJobInPlanComplexFilter > array
domainInPlanComplexFilter optional		< DomainInPlanComplexFilter > array
fileInPlanComplexFilter optional		< FileInPlanComplexFilter > array
jobInPlanComplexFilter optional		< JobInPlanComplexFilter > array
jobInPlanOnCriticalPathComplexFilter optional		< JobInPlanOnCriticalPathComplexFilter > array
jobInPlanResourceUsageComplexFilter optional		< JobInPlanResourceUsageComplexFilter > array
jobStreamInPlanComplexFilter optional		< JobStreamInPlanComplexFilter > array
operator optional	AND, OR, NOT or empty for NONE. With NOT or empty operator, only one filter can be used. In this case, if more than one filter is specified, the operator will be OR	string
promptInPlanComplexFilter optional		< PromptInPlanComplexFilter > array
resourceInPlanComplexFilter optional		< ResourceInPlanComplexFilter > array
symphonyInPlanComplexFilter optional		< SymphonyInPlanComplexFilter > array
virtualWorkstationInPlanComplexFilter optional		< VirtualWorkstationInPlanComplexFilter > array
windowsUserInPlanComplexFilter optional		< WindowsUserInPlanComplexFilter > array
workstationInPlanComplexFilter optional		< WorkstationInPlanComplexFilter > array

ConditionalDependency


Name	Schema
conditionId optional	string
conditionalJobDependencies optional	< ConditionalJobDependency > array
description optional	string
requiresAll optional	boolean
subsetValue optional	integer (int32)

ConditionalDependencyInPlan


Name	Schema
conditionId optional	string
conditionalJobDependenciesInPlan optional	< ConditionalJobDependencyInPlan > array
description optional	string
extendedConditionStatus optional	string
requiresAll optional	boolean
simpleConditionStatus optional	string
subsetValue optional	integer (int32)

ConditionalJobDependency


Name	Description	Schema
abstractJobId optional		string
abstractJobKey optional		JobKey
conditionCheckType optional	Valid Values are: RETURN_CODE_TYPE, STATUS_TYPE	string
conditionLogicalOperatorType optional	Valid Values are: GE_TYPE, GT_TYPE, LE_TYPE, LT_TYPE, EQ_TYPE, NE_TYPE, RG_TYPE	string
conditionStatus optional	The status conditions. Valid Values are: STARTED, COMPLETED, DUMMY_COMPLETED, ERROR, SUCC, FAIL, SUPPRESS	string
isExternal optional		boolean
jobWorkstationKey optional		string
mandatoryOption optional	The mandatory option. Valid values are: NO, PLAN, CONTROL	string
procedureStep optional		string
resolutionData optional		ResolutionData
returnCodeValue optional		string
returnCodeValue2 optional		string
stepName optional		string
taskData optional		string

ConditionalJobDependencyInPlan


Name	Schema
conditionCheckType optional	string
conditionLogicalOperatorType optional	string
conditionStatus optional	string
criticalPredecessors optional	integer (int32)
isStatusChanged optional	boolean
isStepMissing optional	boolean
jobDepInternalStatus optional	string
jobId optional	string
jobKey optional	JobInPlanKey
jobRemoved optional	boolean
jobWorkstationKey optional	WorkstationInPlanKey
onCriticalPath optional	boolean
pending optional	boolean
procStep optional	string
resolutionData optional	ResolutionData
returnCodeValue optional	string
returnCodeValue2 optional	string
simpleConditionStatus optional	string
stepName optional	string
taskData optional	string
transportTime optional	integer (int32)

ConditionalJoin


Name	Schema
description optional	string
externalConditionalDependencies optional	< ExternalDependency > array
internalConditionalDependencies optional	< InternalDependency > array
jobId optional	string
jobKey optional	JobKey
jobStreamId optional	string
jobStreamKey optional	JobStreamKey
joinId optional	string
joinName optional	string
quantity optional	integer (int32)

Created


Name	Schema
id optional	string

CriticalJobInPlanComplexFilter


Name	Schema
filter optional	CriticalJobInPlanFilter
notOperator optional	boolean

CriticalJobInPlanFilter


Name	Description	Schema
alertLevelList optional	Valid values are HIGH_RISK, POTENTIAL_RISK, ON_TRACK	< string > array
criticalStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
criticalStartTimeRange optional		TimeRange
deadline optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
deadlineRange optional		TimeRange
internalStatusList optional		< string > array
jobName optional		string
jobStreamAbstractId optional		string
jobStreamName optional		string
jobStreamWorkstationName optional		string
lastCritPathRecalcTime optional		string (date-time)
lastCritPathRecalcTimeRange optional		TimeRange
priority optional		integer (int32)
priorityRange optional		IntegerRange
startTime optional		string (date-time)
startTimeRange optional		TimeRange
statusList optional		< string > array
task optional		string
workstationName optional		string

CriticalJobInfo


Name	Description	Schema
alertLevel optional	Valid values are HIGH_RISK, POTENTIAL_RISK, ON_TRACK	string
appliedDeadlineTime optional	Time in ISO 8601 - The applied dealine time, i.e. if present the job deadline, otherwise if present the job stream deadline otherwise a default	string (date-time)
appliedUntilTime optional	Time in ISO 8601 - The applied until time, i.e. if present the job until, otherwise if present the job stream until otherwise a default	string (date-time)
confidenceFactor optional	The Critical Job confidence factor	number (double)
criticalJobStats optional		CriticalJobStats
criticalPathRemainingDuration optional		integer (int64)
lastCritPathRecalculation optional	Time in ISO 8601 - The last critical path recalculation date	string (date-time)

CriticalJobStats


Name	Schema
numberOfActiveCriticalJobsPred optional	integer (int32)
numberOfCompletedCriticalJobsPred optional	integer (int32)
numberOfCritPathRecalculation optional	integer (int32)
numberOfErrorCriticalJobsPred optional	integer (int32)
numberOfLateCriticalJobsPred optional	integer (int32)
numberOfLongDurationCriticalJobsPred optional	integer (int32)
numberOfNotCompletedJobsOnCrithPath optional	integer (int32)
numberofJobsOnHotList optional	integer (int32)

CriticalJobsSummaryInfo


Name	Description	Schema
lastCritPathRecalculation optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
numberOfCriticalJobsHighRisk optional		integer (int32)
numberOfCriticalJobsNoRisk optional		integer (int32)
numberOfCriticalJobsPotentialRisk optional		integer (int32)

DependenciesInPlan


Name	Schema
externalDependencyInPlan optional	< ExternalDependencyInPlan > array
fileDependencyInPlan optional	< FileDependencyInPlan > array
internetworkDependenciesInPlan optional	< InternetworkDependencyInPlan > array
promptDependencyInPlan optional	< PromptDependencyInPlan > array
resourceDependencyInPlan optional	< ResourceDependencyInPlan > array

DependenciesStats


Name	Schema
numberOfDependencies optional	integer (int32)
numberOfFileDependencies optional	integer (int32)
numberOfInternetworkDependencies optional	integer (int32)
numberOfJobDependencies optional	integer (int32)
numberOfJobStreamDependencies optional	integer (int32)
numberOfNonResourceUnresolvedDependencies optional	integer (int32)
numberOfPromptDependencies optional	integer (int32)
numberOfResourceDependencies optional	integer (int32)
numberOfUnresolvedDependencies optional	integer (int32)

DeployWorkloadApplicationTemplate


Name	Schema
force optional	boolean
mapping optional	string
translationRules optional	string
workloadApplicationName optional	string
xml optional	string

Domain


Name	Description	Schema
description optional		string
id optional		string
isMaster optional		boolean
lockData optional		LockData
managerFolderWorkstationName optional		string
managerWorkstationName optional		string
modifyData optional		ModifyData
name optional		string
parentId optional	If specified, must reference an existing domain. Must be null for the master domain.	string
parentName optional	In ADD operations, if specified, must reference an existing domain. If not, the Master Domain will be used as default.	string

DomainFilter


Name	Schema
domainIdList optional	< string > array
domainName optional	string
parentDomainName optional	string

DomainInPlan


Name	Schema
domainInPlanKey optional	DomainInPlanKey
domainModelId optional	string
id optional	string
managerWorkstationFolderId optional	string
managerWorkstationKey optional	WorkstationInPlanKey
modifyData optional	ModifyData
parentDomainId optional	string
parentDomainKey optional	DomainInPlanKey
planId optional	string

DomainInPlanComplexFilter


Name	Schema
filter optional	DomainInPlanFilter
notOperator optional	boolean

DomainInPlanFilter


Name	Schema
domainId optional	string
domainName optional	string
domainNameAsString optional	string
managerNameAsString optional	string
parentDomainNameAsString optional	string

DomainInPlanKey


Name	Schema
href optional	string
name required	string

DomainInPlanSorter


Name	Schema
domId optional	Sorter
domainName optional	Sorter
managerName optional	Sorter
parentDomainName optional	Sorter

DomainSorter


Name	Schema
description optional	SorterModel
domainName optional	SorterModel
isMaster optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
managerFolderWorkstationName optional	SorterModel
managerWorkstationName optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
parentDomainName optional	SorterModel

EngineInfo


Name	Description	Schema
apiLevel optional		integer (int64)
auditModel optional		string
auditPlan optional		string
auditStore optional		string
brand optional		string
codepage optional		string
dbStartOfDay optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string
dbTimezone optional		string
defCalendar optional		string
domainName optional		string
enableLegacyStartOdDayEvaluation optional		boolean
enableRerunOpt optional		boolean
engineType optional		string
executorList optional		< Executor > array
featureLevel optional		integer (int64)
fipsEnabled optional		boolean
functionalLevel optional		integer (int32)
gmtOffset optional		integer (int32)
hasDatabasePlan optional		boolean
hasModel optional		boolean
hasPlan optional		boolean
licenseType optional		string
locale optional		string
ltpEndDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
ltpStartDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
maintenance optional		integer (int32)
masterDomain optional		string
masterWorkstation optional		string
pifLevel optional		integer (int32)
planTimezone optional		string
rdbmsSchema optional		string
rdbmsType optional		string
rdbmsUrl optional		string
rdbmsUser optional		string
regardlessOfStatusFilterEnabled optional		boolean
roleBasedSecurityEnabled optional		boolean
synphonyBatchManStatus optional		string
synphonyFileName optional		string
synphonyFound optional		boolean
synphonyPlanEnd optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
synphonyPlanStart optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
synphonyRunNumber optional		integer (int32)
synphonyScheduledDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
synphonySize optional		integer (int32)
synphonyStartOfDay optional		integer (int64)
synphonyStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
timezone optional		string
timezoneEnable optional		boolean
type optional		string
version optional		string
workstationName optional		string
zRelease optional		integer (int32)
zVersion optional		integer (int32)

EventCondition


Name	Schema
eventName optional	string
eventType optional	string
filteringPredicate optional	string
pluginName optional	string
position optional	integer (int32)
scope optional	string

EventObjectRule


Name	Schema
exclude optional	EventProperties
include optional	EventProperties

EventProperties


Name	Schema
customs optional	< string > array
providers optional	< string > array
types optional	< string > array

EventPropertiesCollection

Type : < EventObjectRule > array

EventRule


Name	Description	Schema
actions optional		< RuleAction > array
folderId optional		string
groupAttributeNames optional		< string > array
header optional		EventRuleHeader
thresholdCount optional		integer (int32)
timeInterval optional		integer (int64)
timeIntervalMode optional	The time interval mode. Valid values are: FIXED, SLIDING	string
triggerEvents optional		< EventCondition > array

EventRuleFilter


Name	Description	Schema
actionScope optional	The action scope filter	string
actionTypeList optional	The action type list filter. List of String parameters	< string > array
draft optional	The rule draft filter	boolean
eventRuleId optional		string
eventRuleIdList optional		< string > array
eventRuleName optional	The rule name filter. String parameter	string
eventRuleTypeList optional	The rule type list filter. List of EventRuleType parameters. Valid values are COLLECTION, DUPLICATE, FILTER, SEQUENCE, SET, THRESHOLD	< string > array
eventRulestatusList optional	The rule status list filter. List of EventRuleStatus parameters.Valid values are ACTIVE, INACTIVE	< string > array
eventScope optional	The event scope filter	string
eventTypeList optional		< string > array
jobDefinitionFlowTargetName optional	The job definition flow target name filter	string
jobDefinitionName optional	The job definition name filter	string
jobStreamFlowTargetName optional	The job stream flow target name filter	string
jobStreamName optional	The job stream name filter	string
noLongerValidOnDate optional	Selects the event rules whose validity period has expired before the specified date parameter. Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
notStillValidOnDate optional	Selects the event rules whose validity period comes after the specified date parameter. Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
validRange optional		TimeRange
variableTableName optional	The variable table name filter	string

EventRuleHeader


Name	Description	Schema
description optional		string
endOffset optional		integer (int64)
folderName optional		string
id optional		string
isDraft optional		boolean
lockData optional		LockData
modifyData optional		ModifyData
name optional		string
processStatus optional		string
ruleType optional	The rule type. Valid values are: COLLECTION, DUPLICATE, FILTER, SEQUENCE, SET, THRESHOLD. If the value specified is not valid, the null value is automatically used.	string
startOffset optional		integer (int64)
status optional		string
timeZone optional		string
validFrom optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
validTo optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

EventRuleSorter


Name	Schema
description optional	SorterModel
draft optional	SorterModel
endOffset optional	SorterModel
eventRuleName optional	SorterModel
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
ruleType optional	SorterModel
startOffset optional	SorterModel
timeZone optional	SorterModel
validFrom optional	SorterModel
validTo optional	SorterModel

Executor


Name	Schema
application optional	string
factory optional	string
labels optional	< StringMapObj > array
namespace optional	string
produceLog optional	boolean
produceLogWhenRunning optional	boolean
restartable optional	boolean
schemaLocation optional	string
stoppable optional	boolean
supportedOs optional	string
supportedWs optional	string
version optional	string

ExternalDependency


Name	Description	Schema
abstractJobId optional		string
abstractJobKey optional		JobKey
abstractJobStreamId optional		string
abstractJobStreamKey optional		JobStreamKey
conditionalDependencyId optional	For external conditional dependency ONLY	string
joinId optional		string
mandatoryOption optional	The mandatory option. Valid Values are: NO, PLAN, CONTROL	string
outputConditions optional	For external conditional dependency ONLY	< OutputCondition > array
resolutionData optional		ResolutionData
statusConditions optional	The status conditions. Valid Values are: STARTED, COMPLETED, DUMMY_COMPLETED, ERROR, SUCC, FAIL, SUPPRESS	< string > array

ExternalDependencyInPlan


Name	Schema
conditional optional	boolean
depSequence optional	integer (int32)
jobActualKey optional	string
jobId optional	string
jobKey optional	JobInPlanKey
jobStreamActualKey optional	string
jobStreamId optional	string
jobStreamKey optional	JobStreamInPlanKey
jobStreamOriginalKey optional	string
jobStreamSuccId optional	string
jobSuccId optional	string
jobWorkstationName optional	string
joinName optional	string
joinQuantity optional	integer (int32)
outputConditionList optional	string
pending optional	boolean
satisfied optional	boolean
status optional	Status
statusConditions optional	< string > array
zombie optional	boolean

FileDependency


Name	Schema
fileId optional	string
fileName optional	string
folderWorkstationName optional	string
qualifiers optional	string
workstationId optional	string
workstationName optional	string

FileDependencyInPlan


Name	Description	Schema
depSequence optional		integer (int32)
fileInPlan optional		FileInPlan
satisfied optional		boolean
status optional		string
timeLastCheck optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

FileInPlan


Name	Schema
cpuFolderId optional	string
fileInPlanKey optional	FileInPlanKey
id optional	string
planId optional	string
qualifier optional	string
resourceModelId optional	string
status optional	string
workstationId optional	string

FileInPlanComplexFilter


Name	Schema
filter optional	FileInPlanFilter
notOperator optional	boolean

FileInPlanFilter


Name	Schema
fileId optional	string
fileName optional	string
fileNameAsString optional	string
qualifierAsString optional	string
status optional	string
statusAsString optional	string
statusList optional	< string > array
workstationName optional	string
workstationNameAsString optional	string
workstationSymId optional	string

FileInPlanKey


Name	Schema
href optional	string
id optional	string
name required	string
qualifier optional	string
workstationInPlanKey optional	WorkstationInPlanKey

FileInPlanSorter


Name	Schema
name optional	Sorter
qualifiers optional	Sorter
resId optional	Sorter
status optional	Sorter
workstationName optional	Sorter

FileStartCondition

If specified, jobStartCondition must not be set


Name	Description	Schema
advancedParameters optional		string
alias optional		string
fileName optional		string
folderWorkstationName optional		string
id optional		string
interval optional		integer (int64)
isProcessInBatch optional	Default : `false`	boolean
jobStreamId optional	Must reference an existing jobstream	string
jobStreamKey optional		JobStreamKey
outputFile optional		string
type optional	Valid values are: FileCreated and FileModified	string
userLogin optional		string
workstationId optional		string
workstationName optional	Must reference an existing workstation or class	string

FiltersEventRuleEngine


Name	Schema
actionRunFilter optional	ActionRunFilter
auditRecordFilter optional	AuditRecordFilter
messageLogRecordFilter optional	MessageLogRecordFilter
ruleInstanceFilter optional	RuleInstanceFilter

FiltersModel


Name	Schema
calendarFilter optional	CalendarFilter
domainFilter optional	DomainFilter
eventRuleFilter optional	EventRuleFilter
folderFilter optional	FolderFilter
jobCustomStatisticsFilter optional	JobCustomStatisticsFilter
jobDefinitionFilter optional	JobDefinitionFilter
jobDetailedStatisticsFilter optional	JobDetailedStatisticFilter
jobFilter optional	JobFilter
jobHistoryRunFilter optional	JobHistoryRunFilter
jobStreamInstancesFilter optional	JobStreamInstancesFilter
jobstreamFilter optional	JobstreamFilter
promptFilter optional	PromptFilter
resourceFilter optional	ResourceFilter
runCycleGroupFilter optional	RunCycleGroupFilter
variableFilter optional	VariableFilter
variableTableFilter optional	VariableTableFilter
windowsUserFilter optional	WindowsUserFilter
workloadApplicationFilter optional	WorkloadApplicationFilter
workloadApplicationTemplateFilter optional	WorkloadApplicationTemplateFilter
workstationClassFilter optional	WorkstationClassFilter
workstationFilter optional	WorkstationFilter

FiltersPlan


Name	Schema
criticalJobInPlanFilter optional	CriticalJobInPlanFilter
dateFormat optional	string
dateTimeFormat optional	string
dateTimeOffset optional	integer (int32)
domainInPlanFilter optional	DomainInPlanFilter
durationFormat optional	string
fileInPlanFilter optional	FileInPlanFilter
jobInPlanFilter optional	JobInPlanFilter
jobInPlanOnCriticalPathFilter optional	JobInPlanOnCriticalPathFilter
jobInPlanResourceUsageFilter optional	JobInPlanResourceUsageFilter
jobStreamInPlanFilter optional	JobStreamInPlanFilter
promptInPlanFilter optional	PromptInPlanFilter
resourceInPlanFilter optional	ResourceInPlanFilter
symphonyInPlanFilter optional	SymphonyInPlanFilter
virtualWorkstationInPlanFilter optional	VirtualWorkstationInPlanFilter
windowsUserInPlanFilter optional	WindowsUserInPlanFilter
workstationInPlanFilter optional	WorkstationInPlanFilter

Folder


Name	Schema
cancPending optional	boolean
depth optional	integer (int32)
description optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name required	string
parentId optional	string
userFields optional	StringMap

FolderFilter


Name	Schema
cancPending optional	boolean
depth optional	integer (int32)
folderId optional	string
folderIdList optional	< string > array
folderName optional	string
parentFolderId optional	string
parentFolderName optional	string

FolderKey


Name	Schema
baseName optional	string
className optional	string
key optional	TWSKey
keyPrefix optional	string
keyText optional	string
name optional	string
parentName optional	string

FolderPropertiesCollection

Type : < NameObjectRule > array

FolderSorter


Name	Schema
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel

IWSObjectUIPreferences


Name	Schema
id optional	string
objectType optional	string
preferences optional	string

Identifier


Name	Schema
value optional	string

IdentifiersListResult


Name	Schema
jobIdList optional	< string > array

IntegerRange


Name	Schema
rangeEnd optional	integer (int32)
rangeStart optional	integer (int32)

InterNetworkDependency


Name	Schema
dependency optional	string
networkAgentId optional	string
networkAgentKey optional	string

InternalDependency


Name	Description	Schema
conditionalDependencyId optional	For internal conditional dependency ONLY	string
description optional		string
jobId optional		string
jobKey optional		JobKey
joinId optional	For internal conditional dependency ONLY	string
outputConditions optional	For internal conditional dependency ONLY	< OutputCondition > array
reportPrintOption optional	The print option. Valid Values are: ALWAYS, CONDITIONAL	string
statusConditions optional		< string > array
taskData optional		string
transportTime optional		integer (int64)

InternalDependencyInPlan


Name	Description	Schema
conditional optional		boolean
depSequence optional		integer (int32)
jobId optional		string
jobInPlanActualKey optional		string
jobInPlanKey optional		JobInPlanKey
jobInPlanOriginalKey optional		string
jobSuccId optional		string
joinName optional	The name of the join associated to an Internal Conditional Dependency. Used with Conditional Dependency	string
joinQuantity optional	The quantity of the join associated to an Internal Conditional Dependency. Used with Conditional Dependency	integer (int32)
outputConditionList optional	The list of the output condition - separated by comma - associated to an Internal Conditional Dependency. Used with Conditional Dependency.	string
satisfied optional		boolean
status optional		Status
statusConditions optional	The list of the status conditions associated to an Internal Conditional Dependency. Possible status are STARTED COMPLETED DUMMY_COMPLETED ERROR SUCC FAIL SUPPRESS	< string > array

InternetworkDependencyInPlan


Name	Schema
depSequence optional	integer (int32)
dependency optional	string
jobId optional	string
jobStreamId optional	string
networkAgentId optional	string
satisfied optional	boolean
status optional	Status
workstationInPlanKey optional	WorkstationInPlanKey

Job


Name	Description	Schema
abstractId optional		string
abstractJobStreamId optional		string
comment optional		string
conditionalDependencies optional		< ConditionalDependency > array
conditionalJoins optional		< ConditionalJoin > array
distJobDefinition optional		JobDefinition
externalConditionalDependencies optional		< ExternalDependency > array
externalDependencies optional		< ExternalDependency > array
fileDependencies optional		< FileDependency > array
header optional		JobHeader
interNetworkDependencies optional		< InterNetworkDependency > array
internalConditionalDependencies optional		< InternalDependency > array
internalDependencies optional		< InternalDependency > array
isMonitored optional		boolean
jobDefinitionId optional		string
jobDefinitionKey optional		JobDefinitionKey
jobStreamId optional		string
noOperation optional		boolean
pollingCondition optional		string
pollingInterval optional		integer (int64)
position optional		integer (int32)
promptDependencies optional		< PromptDependency > array
repeatInterval optional		integer (int64)
requiresConfirmation optional		boolean
resourceDependencies optional		< ResourceDependency > array
statisticsType optional	The statistics type. Valid Values are: AUTOMATIC, CUSTOM	string
timeRestrictions optional		TimeRestrictions

JobCommand


Name	Schema
command optional	string
input optional	string

JobCustomStatisticsFilter


Name	Schema
jobId optional	Identifier
jobPredictions optional	string
predictionDate optional	TimeRange
toPredict optional	boolean
toTrain optional	boolean
trainDate optional	TimeRange
weightsReference optional	string

JobDefinition


Name	Description	Schema
abendPrompt optional		Prompt
abendPromptId optional		string
definedByJsdl optional	True if the job definition task is defined through a jsdl	boolean
folderId optional		string
header optional		JobDefinitionHeader
isInteractive optional		boolean
normalElapsedTime optional		integer (int64)
outputConditions optional		< OutputCondition > array
recoveryJobId optional		string
recoveryJobKey optional		JobDefinitionKey
recoveryOption optional	Valid values are: STOP, CONTINUE, RERUN	string
recoveryRepeatAffinity optional		boolean
recoveryRepeatInterval optional		integer (int64)
recoveryRepeatOccurrences optional		integer (int32)
taskString optional	If it is defined through a jsdl, definedByJsdl must be set to true. Affinity value (Define an affinity relationship to have the current job run on the same workstation) of the JobDefinition must be set after the jsdl with the following syntax: -twsAffinity jobname=. To set the following 2 properties must be added to the jsdl:jobDefinition tag: 1) xmlns:XMLSchema= 2) XMLSchema:text=	string
workloadApplicationId optional		string
workstationFolderId optional		string
workstationId optional		string

JobDefinitionFilter


Name	Description	Schema
deployedBatchApplicationName optional	Selects jobs referencing the specified workload application directly	string
jobDefinitionIdList optional		< string > array
jobDefinitionName optional		string
recoveryFlowTargetName optional		string
recoveryJobDefinitionName optional		string
userLogin optional		string
workstationName optional		string

JobDefinitionHeader


Name	Schema
description optional	string
id optional	string
isCommand optional	boolean
jobDefinitionKey optional	JobDefinitionKey
lastRunTime optional	string (date-time)
lockData optional	LockData
modifyData optional	ModifyData
taskType optional	string
userLogin optional	string

JobDefinitionInPlan


Name	Schema
abendPromptId optional	string
abendPromptKey optional	PromptInPlanKey
abendPromptText optional	string
autoErrorCompletion optional	boolean
autoRelease optional	boolean
autoSubmit optional	boolean
automatedFunction optional	string
cancelIfLate optional	boolean
catManagementOption optional	string
cleanUpOption optional	string
command optional	boolean
commandText optional	string
completeIfBindFails optional	boolean
completionInfo optional	string
cpuFolderId optional	string
cpuFolderName optional	string
deadlineWTO optional	boolean
definedByJsdl optional	boolean
description optional	string
estimatedDuration optional	integer (int64)
execDest optional	string
expandedJCL optional	boolean
extendedName optional	string
folderId optional	string
folderName optional	string
formNumber optional	string
hasCentralizedScript optional	boolean
highestOkReturnCode optional	integer (int32)
interactive optional	boolean
jclName optional	string
jobClass optional	string
jobDefinitionInPlanKey optional	JobDefinitionInPlanKey
jobDefinitionModelId optional	string
outputConditions optional	< OutputConditionInPlan > array
owningOpNumber optional	integer (int32)
planId optional	string
pluginTaskType optional	string
printClass optional	string
recoveryCpuFolderId optional	string
recoveryCpuFolderName optional	string
recoveryJob optional	JobInPlan
recoveryJobId optional	string
recoveryJobKey optional	JobDefinitionInPlanKey
recoveryOption optional	string
recoveryRepeatAffinity optional	boolean
recoveryRepeatInterval optional	integer (int64)
recoveryRepeatOccurrences optional	integer (int32)
remoteIdentifier optional	string
remoteJCLName optional	string
remoteJsName optional	string
remoteStartTime optional	string (date-time)
remoteWsName optional	string
reportingAttribute optional	string
reroutableOption optional	string
restartableOption optional	string
returnCode optional	integer (int32)
returnCodeMapping optional	string
schedulingEnvironmentName optional	string
securityElement optional	string
taskString optional	string
taskStringInfo optional	string
taskType optional	string
userLogin optional	string
userSysOut optional	boolean
virtDest optional	string
wlmClass optional	string
wlmCriticalJob optional	boolean
wlmCriticalJobType optional	string
wlmPolicy optional	string
workstationId optional	string

JobDefinitionInPlanKey


Name	Schema
name required	string
workstationInPlanKey optional	WorkstationInPlanKey

JobDefinitionKey

Must reference an existing job definition


Name	Schema
folderName optional	string
folderWorkstationName optional	string
name optional	string
workstationName optional	string

JobDefinitionSorter


Name	Schema
description optional	SorterModel
folderName optional	SorterModel
jobDefinitionName optional	SorterModel
lastRunTime optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
taskType optional	SorterModel
userLogin optional	SorterModel
workstationFolderName optional	SorterModel
workstationName optional	SorterModel

JobDependenciesInPlan


Name	Schema
conditionalDependencyInPlan optional	< ConditionalDependencyInPlan > array
externalDependencyInPlan optional	< ExternalDependencyInPlan > array
fileDependencyInPlan optional	< FileDependencyInPlan > array
internalDependencyInPlan optional	< InternalDependencyInPlan > array
internetworkDependenciesInPlan optional	< InternetworkDependencyInPlan > array
promptDependencyInPlan optional	< PromptDependencyInPlan > array
resourceDependencyInPlan optional	< ResourceDependencyInPlan > array

JobDetailedStatistic


Name	Schema
criticalType optional	string
deadlineAction optional	string
deadlineOffset optional	integer (int64)
detailedStatsData optional	integer (int32)
detailedStatsType optional	string
estimatedDuration optional	integer (int64)
jobDefinitionId optional	string
jobId optional	string
jobStreamId optional	string
jobStreamKey optional	JobStreamKey
manualHold optional	string
nop optional	string
numberOfSamples optional	integer (int32)
rcName optional	string
runcycleId optional	string
sigma optional	integer (int64)
variableNotStartedAction optional	string
variableNotStartedActionTime optional	integer (int64)
variableNotStartedAlertTime optional	integer (int64)

JobDetailedStatisticFilter


Name	Description	Schema
jobDefinitionId optional	The job definition identifier filter	string
jobDetailedStaticId optional	The job detailed statistics identifier filter	string
jobStatisticsData optional	The job operation number filter	integer (int32)
jobStatisticsType optional	The job detailed statistics type filter. Valid Values are: GLOBAL, WEEKLY, MONTHLY, MONTHLY_INVERTED, RUNCYCLE	string
runcycleId optional	The run cycle identifier filter	string

JobFilter


Name	Schema
jobId optional	string
statisticsType optional	string

JobHeader


Name	Schema
critical optional	boolean
description optional	string
id optional	string
key optional	JobKey
priority optional	integer (int32)
timeZone optional	string

JobHistoryRun


Name	Description	Schema
actualWorkstationFolderName optional		string
actualWorkstationName optional		string
actualWorkstationSymId optional		string
criticalLatestStart optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
errorCode optional		string
executionDestination optional		string
isAutogenerated optional		boolean
isCritical optional		boolean
isLongDuration optional		boolean
isPromoted optional		boolean
jobDefinitionId optional		string
jobId optional		string
jobName optional		string
jobNumber optional		integer (int32)
jobStatistics optional		JobStatistics
jobStreamFolderPath optional		string
jobStreamInstanceId optional		string
jobStreamName optional		string
jobStreamWorkstationFolderName optional		string
jobStreamWorkstationName optional		string
jobStreamWorkstationSymId optional		string
lateEndTime optional		integer (int64)
lateStartTime optional		integer (int64)
licenseType optional		string
modifyData optional		ModifyData
plannedDuration optional		integer (int64)
rerunNumber optional		integer (int32)
rerunType optional		string
returnCode optional		integer (int32)
runCycleId optional		string
runDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
scheduledStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
status optional		string
submissionDestination optional		string
totalCPUTime optional		integer (int64)
totalElapsedTime optional		integer (int64)
userLogin optional		string
workstationFolderName optional		string
workstationName optional		string
workstationSymId optional		string

JobHistoryRunFilter


Name	Description	Schema
isDelayed optional		boolean
isLateEnd optional		boolean
isLateStart optional		boolean
isLongDuration optional		boolean
jobId optional		string
jobstreamId optional		string
jobstreamName optional		string
jobstreamWorkstationName optional		string
name optional		string
rerunTypeList optional	The Job Rerun Type List. Valid Values are: RERUN, RERUN_EVERY, RERUN_FROM, RECOVERY, REGULAR	< string > array
runCycleId optional		string
runDateRange optional		TimeRange
runInRange optional		TimeRange
status optional	The Job Run Status List. Valid Values are: ABEND, ERROR, SUCCESSFUL, UNKNOWN, CANCELED	string
statusList optional	The Job Run Status List. Valid Values are: ABEND, ERROR, SUCCESSFUL, UNKNOWN, CANCELED	< string > array
workstationName optional		string

JobInPlan


Name	Description	Schema
actualKey optional	The actual key value	string
actualWorkstation optional		string
aliased optional		boolean
altJobIssue optional		boolean
applicationName optional	job task type application name	string
autogenerated optional		boolean
buckujob optional		boolean
canceledInSuccStatus optional		boolean
centralized optional		boolean
centralizedSatisfied optional		boolean
cpuFolderId optional		string
cpuTime optional		integer (int64)
criticalNetworkInfo optional		JobOnCriticalNetworkInfo
criticalSuccId optional	Reference to the DB id of the closest business critical successor (job or job stream)	string
definedByJsdl optional		boolean
delayRerun optional	delayRerun	boolean
dependencies optional		JobDependenciesInPlan
dependenciesStats optional		DependenciesStats
dependencySequenceNumber optional	The dependency sequence number	integer (int32)
description optional		string
dontTouch optional		boolean
estimatedEndSigma optional		integer (int64)
every optional		boolean
everyRerun optional	The Job is a every rerun job	boolean
extendedProperties optional		string
external optional		boolean
folderId optional		string
hasResource optional		boolean
headJobRunId optional	The database identifier of the head job run	string
headJobRunName optional	The name of the head job run	string
headRecordNumber optional		integer (int64)
heldByUser optional		boolean
id optional		string
ignoreFlags optional		boolean
interactive optional		boolean
jApplication optional		string
jobDefinition optional		JobDefinitionInPlan
jobDefinitionId optional	job definition identifier	string
jobLate optional		boolean
jobModelId optional	The database identifier of the job in the model	string
jobNumber optional		integer (int32)
jobRunId optional	The database identifier of the job run	string
jobStreamId optional	The Identifier of the Job Stream to which this Job belong	string
jobStreamInPlan optional		JobStreamInPlanKey
lastInRerunChain optional		boolean
maxDurationGone optional		boolean
minDurationNotReached optional		boolean
monitored optional		boolean
msgGenerated optional		boolean
name required		string
needMessage optional		boolean
needResource optional		boolean
noOperation optional	No Operation flag	boolean
originalKey optional	The original key value	string
originalPriority optional		integer (int32)
pendingCancellation optional		boolean
pendingPredecessor optional		boolean
planId optional		string
pollingJobUsed optional		boolean
position optional	The position of this job in the job stream	integer (int32)
priority optional		integer (int32)
programmatic optional		boolean
recordNumber optional		integer (int64)
recoveryDefinition optional	true if the Job is a Recovery job definition	boolean
recoveryJobId optional	The database identifier of the recovery prompt	string
recoveryRepeatIterations optional		integer (int32)
recoveryRerunJob optional		boolean
released optional		boolean
repeatInterval optional		integer (int64)
replicated optional		boolean
requiresConfirmation optional		boolean
rerunInstancesNumber optional	job rerun sequence	integer (int32)
rerunJob optional		boolean
rerunStep optional	the Job is a rerun job with step name	boolean
rerunType optional	the type of rerun	string
restarted optional		boolean
running optional		boolean
sigma optional		integer (int64)
status optional		NodeStatus
successPending optional		boolean
taskType optional		TaskTypeInPlan
timeInfo optional		TimeInfo
timeRestriction optional		TimeRestrictionsInPlan
untilGone optional		boolean
userJob optional		boolean
userRerunAgain optional		boolean
wildcarded optional		boolean
workstationInPlan optional		WorkstationInPlanKey

JobInPlanComplexFilter


Name	Schema
filter optional	JobInPlanFilter
notOperator optional	boolean

JobInPlanFilter


Name	Description	Schema
actualEndTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
actualEndTimeAsString optional		string
actualEndTimeRange optional		TimeRange
actualKey optional		string
actualStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
actualStartTimeAsString optional		string
actualStartTimeRange optional		TimeRange
actualWorkstation optional		string
authGroup optional		string
autogenerated optional		boolean
buckujob optional		boolean
buckujobList optional		< boolean > array
canceled optional		boolean
canceledList optional		< boolean > array
cleanupStatus optional	STATUSNONE, STATUSCOMPLETE, STATUSERROR	string
cleanupType optional	NONE, IMMEDIATE, AUTOMATIC, MANUAL	string
conditionalRecoveryJob optional		boolean
confirmed optional		boolean
confirmedAsString optional		string
critical optional		boolean
criticalAsString optional		string
criticalList optional		< boolean > array
criticalStart optional		string
deadlineAction optional		string
deadlineActionList optional		< boolean > array
deadlineTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
deadlineTimeAsString optional		string
delayRerun optional		boolean
errorCode optional		string
estimatedDuration optional		integer (int32)
estimatedDurationAsString optional		string
every optional		boolean
everyList optional		< boolean > array
everyTime optional		integer (int64)
everyTimeAsString optional		string
everyTimeRange optional		LongRange
extendedName optional		string
fileDependencyId optional		string
fileDependencyName optional		string
fileDependencyWorkstationName optional		string
fileDeps optional		string
folderId optional		string
headJobId optional		string
inetDeps optional		string
inputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
inputArrivalTimeAsString optional		string
inputArrivalTimeRange optional		TimeRange
internalStatusAsString optional	Valid values are READY, HOLD, EXEC, EXEC_PLUS, ABEND, SUCC, CANCEL, UNKNOWN, USER_STREAM, CANCELP, ADD, RJOB, FAILED, MPE_SUSP, WAIT, INTRO, INTRO_PLUS, WAITD, SCHED, ABENDP, SUCCP, ENDP, EXTRN, ERROR, FENCE, BOUND, SUSP, SUPPRESS, RECOVERY_IN_PROGRESS	string
internalStatusList optional		< string > array
jobCommand optional		boolean
jobDeps optional		string
jobId optional		string
jobMatchingCriteria optional		string
jobName optional		string
jobNameQf optional		string
jobNumber optional		string
jobPendPred optional		boolean
jobStreamName optional		string
jobWksName optional		string
jobstreamOwner optional		string
jsDeps optional		string
lastInRerunChain optional		boolean
late optional		boolean
lateAsString optional		string
maxDuration optional		integer (int32)
maxDurationAction optional	SUPPRESS, CONTINUE, CANCEL	string
maxDurationActionList optional		< boolean > array
maxDurationAsString optional		string
maxDurationGone optional		boolean
maxDurationGoneList optional		< boolean > array
maxDurationUsed optional		boolean
maxDurationUsedList optional		< boolean > array
minDuration optional		integer (int32)
minDurationAction optional	ABEND, CONTINUE, CONFIRM	string
minDurationActionList optional		< string > array
minDurationAsString optional		string
minDurationNotReached optional		boolean
minDurationNotReachedList optional		< boolean > array
minDurationUsed optional		boolean
minDurationUsedList optional		< boolean > array
modifyTime optional		string
monitored optional		string
monitoredJob optional		boolean
monitoredJobList optional		< boolean > array
nopAsString optional		string
nopJob optional		boolean
nopJobList optional		< boolean > array
originalKey optional		string
originalPriority optional		string
pendingCanc optional		boolean
pendingCancList optional		< boolean > array
polling optional		boolean
position optional		integer (int32)
positionAsString optional		string
priority optional		integer (int32)
priorityAsString optional		string
priorityRange optional		IntegerRange
promoted optional		boolean
promotedAsString optional		string
promotedList optional		< boolean > array
promptDependencyId optional		string
promptDependencyName optional		string
promptDependencyNumber optional		integer (int32)
promptDeps optional		string
recordNumber optional		integer (int64)
recoveredByCondition optional		boolean
recoveryDefinition optional		boolean
recoveryOptionList optional		< string > array
released optional		boolean
releasedList optional		< boolean > array
replyNeeded optional		boolean
replyNeededList optional		< boolean > array
rerun optional		boolean
rerunAsString optional		string
rerunNumber optional		integer (int32)
rerunOpt optional		boolean
rerunType optional	RERUN, RERUN_EVERY, RERUN_FROM, RECOVERY, REGULAR	string
rerunTypeAsString optional		string
resourceDependencyId optional		string
resourceDependencyName optional		string
resourceDependencyWorkstationName optional		string
resourceDeps optional		string
returnCode optional		string
runNumber optional		integer (int32)
runNumberAsString optional		string
scheduledTime optional		string
schedulingEnvironmentName optional		string
shadowJob optional		boolean
sigma optional		integer (int64)
sigmaAsString optional		string
startTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
startTimeAsString optional		string
startTimeRange optional		TimeRange
statusAsString optional	Valid values are WAITING, READY, RUNNING, SUCCESSFUL, ERROR, CANCELED, HELD, UNDECIDED, BLOCKED, SUPPRESS	string
statusList optional	Valid values are WAITING, READY, RUNNING, SUCCESSFUL, ERROR, CANCELED, HELD, UNDECIDED, BLOCKED, SUPPRESS	< string > array
successorsId optional		string
successorsInputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
successorsInputArrivalTimeRange optional		TimeRange
successorsInternetworkString optional		string
successorsJobName optional		string
successorsJobStreamName optional		string
successorsWorkstationName optional		string
task optional		string
taskType optional		string
taskTypeList optional		< string > array
timeFinishedToString optional		string
totalElapsedTime optional		string
unexpected optional		boolean
unresolvedDeps optional		string
untilAction optional	SUPPRESS, CONTINUE, CANCEL	string
untilActionList optional		< boolean > array
untilExpired optional		boolean
untilExpiredList optional		< boolean > array
untilTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
untilTimeAsString optional		string
untilTimeRange optional		TimeRange
userLogin optional		string
userjob optional		boolean
userjobList optional		< boolean > array
virtDest optional		string
waitingForSchedulingEnvironment optional		boolean
waitingForWorkstationDelay optional		boolean
wlmClass optional		string
wlmCritical optional		boolean
wlmCriticalType optional	NO, PATH, WLM	string
wlmPolicy optional	DEFAULT, LONGDURATION, DEADLINE, LATESTSTART, CONDITIONAL	string
workstationName optional		string
zombie optional		boolean

JobInPlanKey


Name	Schema
href optional	string
id optional	string
jobStreamInPlanKey optional	JobStreamInPlanKey
name required	string

JobInPlanOnCriticalNetwork


Name	Description	Schema
cpuTime optional		integer (int64)
criticalNetworkInfo optional		JobOnCriticalNetworkInfo
dependencies optional		DependenciesInPlan
dependenciesStats optional		DependenciesStats
description optional		string
estimatedEndSigma optional	The standard deviation of the estimated end	integer (int64)
hasExternalDependencies optional		boolean
id optional		string
isCancelled optional		boolean
isHold optional		boolean
isInternal optional		boolean
isJob optional		boolean
isOnCriticalJobPath optional		boolean
isRerunBlockedBySecurity optional		boolean
isRerunBlockedByStatus optional		boolean
jobDefinition optional		JobDefinitionInPlan
jobDefinitionId optional		string
jobPredecessors optional		< string > array
jobStreamId optional		string
jobSuccessors optional		< string > array
key optional		JobInPlanKey
modifiedBy optional		string
modifiedTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
monitored optional		boolean
origPriority optional		integer (int32)
predecessors optional		< string > array
priority optional		integer (int32)
realStatus optional		NodeStatus
recordNumber optional		integer (int64)
sigma optional	The standard deviation of the estimated duration	integer (int64)
status optional		NodeStatus
successors optional		< string > array
timeInfo optional		TimeInfo
timeRestriction optional		TimeRestrictionsInPlan
timeZone optional		string
unresolvedPreds optional		< string > array

JobInPlanOnCriticalPathComplexFilter


Name	Schema
filter optional	JobInPlanOnCriticalPathFilter
notOperator optional	boolean

JobInPlanOnCriticalPathFilter


Name	Schema
internalStatusList optional	< string > array
late optional	boolean
longRunning optional	boolean
missingDeadline optional	boolean
promotedToUrgentQueue optional	boolean
promotedToWlm optional	boolean
statusList optional	< string > array

JobInPlanResourceUsageComplexFilter


Name	Schema
filter optional	JobInPlanResourceUsageFilter
notOperator optional	boolean

JobInPlanResourceUsageFilter


Name	Schema
jobsUsing optional	boolean
jobsWaiting optional	boolean
resourceName optional	string

JobInPlanSorter


Name	Schema
actualEndTime optional	Sorter
actualKey optional	Sorter
actualStartTime optional	Sorter
actualWorkstation optional	Sorter
aliased optional	Sorter
autogenerated optional	Sorter
buckujob optional	Sorter
cancelStatus optional	Sorter
centrSatisfied optional	Sorter
deadlineAction optional	Sorter
deadlineFlag optional	Sorter
deadlineTime optional	Sorter
delayRerun optional	Sorter
durationLimit optional	Sorter
earliestStartTime optional	Sorter
estimatedDuration optional	Sorter
everyRerun optional	Sorter
hasResource optional	Sorter
heldByUser optional	Sorter
internalStatus optional	Sorter
jobBuckujob optional	Sorter
jobCentralized optional	Sorter
jobCritical optional	Sorter
jobCriticalStart optional	Sorter
jobDefCommand optional	Sorter
jobDefDefinedByJsdl optional	Sorter
jobDefInteractive optional	Sorter
jobDefName optional	Sorter
jobDefRecoveryOption optional	Sorter
jobDefReturnCodeMapping optional	Sorter
jobDefTaskString optional	Sorter
jobDefTaskType optional	Sorter
jobDefUserLogin optional	Sorter
jobDefWorkstationName optional	Sorter
jobDontTouch optional	Sorter
jobEvery optional	Sorter
jobExternal optional	Sorter
jobId optional	Sorter
jobName optional	Sorter
jobNop optional	Sorter
jobNumber optional	Sorter
jobPending optional	Sorter
jobPolling optional	Sorter
jobRunName optional	Sorter
jobWildcarded optional	Sorter
jobZombie optional	Sorter
jobstreamFolderName optional	Sorter
jobstreamName optional	Sorter
jobstreamScheduledTime optional	Sorter
jobstreamWksName optional	Sorter
lastInChain optional	Sorter
late optional	Sorter
maxDuration optional	Sorter
maxDurationAction optional	Sorter
maxDurationFlag optional	Sorter
maxDurationGone optional	Sorter
minDuration optional	Sorter
minDurationAction optional	Sorter
minDurationFlag optional	Sorter
minDurationNotReached optional	Sorter
modifyTime optional	Sorter
monitored optional	Sorter
needResource optional	Sorter
numDeps optional	Sorter
numFileDeps optional	Sorter
numInetDeps optional	Sorter
numJobDeps optional	Sorter
numJsDeps optional	Sorter
numPromptDeps optional	Sorter
numResDeps optional	Sorter
numUnresolvedDeps optional	Sorter
originalKey optional	Sorter
originalPriority optional	Sorter
position optional	Sorter
priority optional	Sorter
programmatic optional	Sorter
promoted optional	Sorter
recordNumber optional	Sorter
recoveryRerunJob optional	Sorter
released optional	Sorter
repeatInterval optional	Sorter
replicated optional	Sorter
replyNeeded optional	Sorter
requiresConfirmation optional	Sorter
rerunJob optional	Sorter
rerunNumber optional	Sorter
rerunStep optional	Sorter
rerunType optional	Sorter
restarted optional	Sorter
returnCode optional	Sorter
runNumber optional	Sorter
running optional	Sorter
startTime optional	Sorter
status optional	Sorter
successPending optional	Sorter
timeDependent optional	Sorter
totalCpuTime optional	Sorter
totalElapsedTime optional	Sorter
untilAction optional	Sorter
untilExpired optional	Sorter
untilFlag optional	Sorter
untilTime optional	Sorter
userJob optional	Sorter
userRerunAgain optional	Sorter

JobInPlanSuccessorsResult


Name	Schema
allAllowed optional	boolean
internalAllowed optional	boolean
question optional	string
sublist optional	< JobInPlanOnCriticalNetwork > array
values optional	< JobInPlanOnCriticalNetwork > array

JobKey


Name	Schema
jobStreamKey optional	JobStreamKey
name optional	string

JobLog


Name	Schema
fileId optional	string
jobId optional	string
lastPage optional	boolean
lines optional	integer (int32)
log optional	string
pageNumber optional	integer (int32)

JobOnCriticalNetworkInfo


Name	Description	Schema
actualArrival optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
actualEnd optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
critical optional		boolean
criticalJobInfo optional		CriticalJobInfo
criticalStart optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
estimatedEndTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
estimatedStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
every optional		boolean
late optional		boolean
latestOut optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
longRunning optional		boolean
onCriticalPath optional		boolean
plannedRestriction optional		TimeRestrictionsInPlan
promotedToUrgentQueue optional		boolean
promotedToWLM optional		boolean
restarted optional		boolean
riskForJobFence optional		boolean
riskForJobPriority optional		boolean
riskForJobStreamFence optional		boolean
riskForJobStreamLimit optional		boolean
riskForJobStreamPriority optional		boolean
riskForJobStreamSuppressed optional		boolean
riskForJobSuppressed optional		boolean
riskForStartTime optional		boolean
riskForWorkStationIgnore optional		boolean

JobProperties


Name	Schema
cpuFolders optional	< string > array
cpus optional	< string > array
folders optional	< string > array
jcls optional	< string > array
jcltypes optional	< string > array
logons optional	< string > array
names optional	< string > array

JobPropertiesCollection

Type : < JobRule > array

JobRule


Name	Schema
exclude optional	JobProperties
include optional	JobProperties

JobStartCondition

If specified, fileStartCondition must not be set


Name	Description	Schema
alias optional		string
id optional		string
interval optional		integer (int64)
jobDefinitionId optional	Must reference an existing job definition	string
jobDefinitionKey optional		JobDefinitionKey
jobStreamId optional	Must reference an existing jobstream	string
jobStreamKey optional		JobStreamKey
mappingExpression optional		string
type optional		string

JobStatistics


Name	Schema
averageCPUTime optional	integer (int64)
averageElapsedTime optional	integer (int64)
id optional	string
jobDefinition optional	JobDefinition
jobDefinitionKey optional	JobDefinitionKey
lastCPUTime optional	integer (int64)
lastElapsedTime optional	integer (int64)
lastRunDate optional	string (date-time)
lateEnds optional	integer (int32)
lateStarts optional	integer (int32)
longDurationRuns optional	integer (int32)
maxCPUTime optional	integer (int64)
maxElapsedTime optional	integer (int64)
maxRunDate optional	string (date-time)
minCPUTime optional	integer (int64)
minElapsedTime optional	integer (int64)
minRunDate optional	string (date-time)
runCycleId optional	string
successfulRuns optional	integer (int32)
suppressedRuns optional	integer (int32)
totalCPUTime optional	integer (int64)
totalElapsedTime optional	integer (int64)
totalReruns optional	integer (int32)
variance optional	integer (int64)

JobStream


Name	Description	Schema
UIPreferences optional		IWSObjectUIPreferences
abstractId optional		string
comment optional		string
conditionalJoins optional		< ConditionalJoin > array
externalConditionalDependencies optional		< ExternalDependency > array
externalDependencies optional		< ExternalDependency > array
fileDependencies optional		< FileDependency > array
fileStartCondition optional		FileStartCondition
folderId optional		string
freeDaysCalendarId optional	If specified, must reference an existing calendar	string
hasMonitoredJob optional	Default value is false Default : `false`	boolean
header optional		JobStreamHeader
interNetworkDependencies optional		< InterNetworkDependency > array
isMonitored optional	Default value is false Default : `false`	boolean
isSaturdayFree optional	Default value is true Default : `true`	boolean
isSundayFree optional	Default value is true Default : `true`	boolean
jobStartCondition optional		JobStartCondition
jobs optional		< Job > array
onRequest optional	Default value is false Default : `false`	boolean
promptDependencies optional		< PromptDependency > array
resolutionData optional		ResolutionData
resourceDependencies optional		< ResourceDependency > array
runCycles optional		< RunCycle > array
runningRuleAction optional	Valid values are: DO_NOT_START, PARALLEL, ENQUEUE	string
timeRestrictions optional		TimeRestrictions
triggerOnce optional	Default value is false Default : `false`	boolean
variableTableFolderName optional		string
variableTableId optional		string
variableTableName optional		string
workloadApplicationId optional		string
workstationId optional		string
workstationSymId optional		string

JobStreamHeader


Name	Description	Schema
authorityGroup optional		string
carryForward optional	Default : `false`	boolean
deadlineLimitFeedback optional		integer (int32)
deadlineSmoothingFactor optional		integer (int32)
description optional		string
freeDaysCalendarFolderName optional		string
freeDaysCalendarName optional		string
groupName optional		string
id optional		string
key optional		JobStreamKey
limit optional		integer (int32)
lockData optional		LockData
modifyData optional		ModifyData
nextTimeZone optional read-only	Default is the timeZone value of the next version. This is a read-only field.	string
ownerDescription optional		string
ownerName optional		string
priority optional		integer (int32)
timeZone optional		string
validTo optional read-only	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss. Default is the validFrom value of the next version. This is a read-only field	string (date-time)

JobStreamInPlan


Name	Description	Schema
actualKey optional		string
aliasJobStreamName optional	The aliased Job Stream Name	string
aliased optional	Job Stream is aliased. Specify this flag if you would like to alias this Job Stream	boolean
carriedForward optional read-only	Job Stream has been carried forward	boolean
carryForward optional	Job Stream is to be carried forward	boolean
cpuFolderId optional		string
cpuTime optional		integer (int64)
dependencies optional		DependenciesInPlan
dependenciesStats optional		DependenciesStats
description optional		string
dontTouch optional read-only	Job Stream Until Date has passed. Read Only attribute	boolean
estimatedEndSigma optional	The standard deviation of the estimated end	integer (int64)
every optional read-only	Job Stream contains at least one Job EVERY. Read Only attribute	boolean
external optional read-only	Job Stream is EXTERNAL. Read Only attribute	boolean
folderId optional		string
folderName optional		string
followsDepSequenceNum optional	The follows dependency sequence number	integer (int32)
hasInternetworkDependencies optional read-only	Job Stream has InternetworkDependencyInPlan. Read Only attribute	boolean
hasResources optional read-only	Job Stream owns Resources. Read Only attribute	boolean
heldByUser optional read-only	Job Stream has priority set to zero. Read Only attribute	boolean
id optional		string
inOrder optional	The Job Stream is in Order. Read Only attribute	boolean
internalIdentifier optional		string
jobStreamDbIdentifier optional		string
jobStreamModelId optional		string
jobStreamStats optional		JobStreamStats
jobs optional		< JobInPlan > array
jsInstanceId optional		string
key optional		JobStreamInPlanKey
lateJobStream optional read-only	Job Stream is a Late Job Stream. Read Only attribute	boolean
limit optional	The Job Stream Limit. Valid values between -1 (NO_LIMIT) and 1024. Default value NO_LIMIT	integer (int32)
modifiedBy optional		string
modifiedTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
monitored optional		boolean
needResources optional	Job Stream has ResourceDependencyInPlan	boolean
origPriority optional		integer (int32)
originalJobStreamName optional read-only	The original Job Stream Name. Before it was aliased. Read Only attribute	string
originalKey optional		string
pendingCancellation optional	Job Stream is pending cancellation	boolean
pendingPredecessor optional		boolean
planId optional		string
planOriginalId optional		string
priority optional		integer (int32)
productionDate optional read-only	Time in ISO 8601 - The Date when the Job Stream was selected. Read Only attribute	string (date-time)
recordNumber optional		integer (int64)
released optional read-only	Job Stream has been release. Read Only attribute	boolean
replicated optional read-only	Job Stream replicated for Workstation Class. Read Only attribute	boolean
resDepSequenceNum optional	The resource dependency sequence number	integer (int32)
scheduledDate optional	Time in ISO 8601 - The Scheduled Date of the Job Stream Instance	string (date-time)
sigma optional	The standard deviation of the estimated duration	integer (int64)
startonce optional read-only	Job Stream is StartOnce	boolean
status optional		NodeStatus
thisCpu optional read-only	Job Stream is on this Workstation. Read Only attribute	boolean
timeInfo optional		TimeInfo
timeRestriction optional		TimeRestrictionsInPlan
timeZone optional		string
userJobs optional read-only	This is a USERJOBS Job Stream. Read Only attribute	boolean
variableTableId optional		string
workstation optional		WorkstationInPlanKey
workstationClass optional	The Job Stream Workstation Class	string
workstationId optional		string
zombie optional		boolean

JobStreamInPlanComplexFilter


Name	Schema
filter optional	JobStreamInPlanFilter
notOperator optional	boolean

JobStreamInPlanFilter


Name	Description	Schema
actualEndTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - The Finish Time Filter. It is Time Started plus Elapsed Time	string (date-time)
actualEndTimeRange optional		TimeRange
actualKey optional	The job stream actual key filter	string
actualStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - The Time Started Filter	string (date-time)
actualStartTimeRange optional		TimeRange
aliasName optional		string
carriedForward optional		boolean
carryForward optional		boolean
deadlineTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - The Deadline Time Filter	string (date-time)
deadlineTimeAsString optional		string
deadlineTimeRange optional		TimeRange
estimatedDurationAsString optional		string
fileDependencyId optional		string
fileDependencyName optional		string
fileDependencyWorkstationName optional		string
folderId optional	The Folder Identifier filter	string
inputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - The Input Arrival Time Filter	string (date-time)
internalIdentifierAsString optional		string
internalStatusAsString optional		string
internalStatusList optional	The Internal status list filter	< string > array
jobStreamId optional	The Job Stream Identifier filter	string
jobStreamName optional	The job stream real name filter	string
limit optional		integer (int32)
limitAsString optional		string
limitRange optional		IntegerRange
monitoredJob optional		boolean
monitoredJobList optional		< boolean > array
nameAsString optional		string
numCurrentNodes optional	The current node filter	integer (int32)
numFileDepsAsString optional		string
numInetDepsAsString optional		string
numJobDepsAsString optional		string
numJsDepsAsString optional		string
numPromptDepsAsString optional		string
numResDepsAsString optional		string
numSkelJobsAsString optional		string
numUnresolvedDepsAsString optional		string
originalKey optional	The job stream actual key filter	string
originalName optional		string
originalPriority optional		string
priority optional		integer (int32)
priorityAsString optional		string
priorityRange optional		IntegerRange
promptDependencyId optional		string
promptDependencyName optional		string
promptDependencyNumber optional		integer (int32)
resourceDependencyId optional		string
resourceDependencyName optional		string
resourceDependencyWorkstationName optional		string
scheduledTimeAsString optional		string
scheduledTimeRange optional		TimeRange
startTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - The Start Time Filter	string (date-time)
startTimeAsString optional		string
startTimeRange optional		TimeRange
statusAsString optional		string
statusList optional	The status filter	< string > array
successfulJobsAsString optional		string
successorsId optional	The successors job Identifier filter	string
successorsInputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - The successors input arrival time filter	string (date-time)
successorsInputArrivalTimeRange optional		TimeRange
successorsInternetwork optional	The successors internetwork filter	string
successorsJobName optional	The successors job name filter	string
successorsJobStreamName optional	The successors schedule name filter	string
successorsWorkstationName optional	The successors workstation name filter	string
timeStartedAsString optional		string
totalElapsedTimeAsString optional		string
totalJobsAsString optional		string
untilTime optional		string (date-time)
untilTimeAsString optional		string
untilTimeRange optional		TimeRange
workstationName optional	The Workstation name filter	string
workstationNameAsString optional		string

JobStreamInPlanKey


Name	Description	Schema
folderKey optional		FolderKey
href optional		string
id optional		string
name required		string
startTime optional	Time in ISO 8601 - The Scheduled Time (AKA Input Arrival Time) of This Job Stream	string (date-time)
workstationKey optional		WorkstationInPlanKey

JobStreamInPlanSorter


Name	Schema
actualStartTime optional	Sorter
cancelStatus optional	Sorter
carriedForward optional	Sorter
carryForward optional	Sorter
critical optional	Sorter
deadlineTime optional	Sorter
earliestStartTime optional	Sorter
estimatedDuration optional	Sorter
folderName optional	Sorter
internalIdentifier optional	Sorter
internalStatus optional	Sorter
isPendingCancellation optional	Sorter
jobStreamId optional	Sorter
late optional	Sorter
limit optional	Sorter
monitored optional	Sorter
name optional	Sorter
numDeps optional	Sorter
numFileDeps optional	Sorter
numInetDeps optional	Sorter
numJobDeps optional	Sorter
numJsDeps optional	Sorter
numPromptDeps optional	Sorter
numResDeps optional	Sorter
numSkelJobs optional	Sorter
numUnresolvedDeps optional	Sorter
originalName optional	Sorter
originalPriority optional	Sorter
priority optional	Sorter
scheduledTime optional	Sorter
startTime optional	Sorter
status optional	Sorter
successfulJobs optional	Sorter
totalElapsedTime optional	Sorter
totalJobs optional	Sorter
untilTime optional	Sorter
workstationName optional	Sorter

JobStreamInTemplate


Name	Schema
jobStreamFolder optional	string
jobStreamId optional	string
jobStreamName optional	string
validFrom optional	string (date-time)
workstationFolder optional	string
workstations optional	string

JobStreamInstancesFilter


Name	Description	Schema
jobStreamId optional		string
jobStreamName optional		string
planId optional		string
scheduledDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
scheduledFromDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
scheduledToDate optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
status optional	Valid values are: COMPLETED, NOT_COMPLETED, OBSOLETE	string
workstationId optional		string

JobStreamKey

Must reference an existing jobstream


Name	Description	Schema
folderName optional	Must reference an existing folder. The value is null if it belongs to folder.	string
folderWorkstationName optional	Must reference an existing folder. The value is null if it belongs to folder.	string
isDraft optional		boolean
isGroup optional		boolean
name optional	Alphanumeric characters. Starting with alphabetic character. and ’_’ characters allowed. Blank spaces not allowed. Maximum length 16 characters. Maximal length : `16`	string
validFrom optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss. It must be GMT midnight, but the meaning is . Values stored in the database are truncated to GMT midnight	string (date-time)
workstationName optional	Must reference an existing workstation or class	string

JobStreamProperties


Name	Schema
cpuFolders optional	< string > array
cpus optional	< string > array
folders optional	< string > array
names optional	< string > array

JobStreamPropertiesCollection

Type : < JobStreamRule > array

JobStreamRule


Name	Schema
exclude optional	JobStreamProperties
include optional	JobStreamProperties

JobStreamSorter


Name	Schema
description optional	SorterModel
draft optional	SorterModel
folderName optional	SorterModel
jobStreamName optional	SorterModel
limit optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
priority optional	SorterModel
timeZone optional	SorterModel
validFrom optional	SorterModel
validTo optional	SorterModel
workstationFolderName optional	SorterModel
workstationName optional	SorterModel

JobStreamStats


Name	Description	Schema
numberOfAbendedJob optional read-only	The number of Jobs Abended in this Job Stream. Read Only attribute	integer (int32)
numberOfCurrentNodes optional read-only	The number of Jobs that are part of this Job Stream excluding the reruns and recoveries. Read Only attribute	integer (int32)
numberOfDeltaJob optional read-only	The number of Jobs that are archieved by stageman but that belongs to the Job Stream. Read Only attribute	integer (int32)
numberOfDeltaSuccJob optional read-only	The number of Jobs in Success that are archieved by stageman but that belongs to the Job Stream. Read Only attribute	integer (int32)
numberOfExecutingJob optional read-only	The number of Jobs Executing in this Job Stream. Read Only attribute	integer (int32)
numberOfFailedJob optional read-only	The number of Jobs Failed in this Job Stream. Read Only attribute	integer (int32)
numberOfJob optional read-only	The number of Jobs that are part of this Job Stream. Read Only attribute	integer (int32)
numberOfNotRunningJob optional read-only	The number of Jobs Not Yet Run in this Job Stream. Read Only attribute	integer (int32)
numberOfSkelJob optional read-only	The number of Jobs still to execute in this Job Stream. Read Only attribute	integer (int32)
numberOfSuccessfullJob optional read-only	The number of Jobs in Success that are part of this Job Stream. Read Only attribute.	integer (int32)
numberOfUndecidedJob optional read-only	The number of Jobs Undecided in this Job Stream. Read Only attribute	integer (int32)

JobstreamFilter


Name	Description	Schema
abstractId optional		string
deployedBatchApplicationName optional	Selects jobstreams referencing the specified workload application directly	string
draft optional	Default : `"false"`	string
fileName optional		string
fileWorkstationName optional		string
freeDaysCalendarName optional		string
jobDefinitionName optional		string
jobDefinitionWorkstationName optional		string
jobName optional		string
jobStreamIdList optional		< string > array
jobStreamName optional		string
jobstreamVariableTableName optional	Selects job streams referencing the specified variable table directly	string
name optional		string
promptName optional		string
resourceName optional		string
resourceWorkstationName optional		string
runcycleCalendarName optional		string
runcycleRunCycleGroupName optional		string
runcycleVariableTableName optional		string
validFrom optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
validIn optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss, selects the job streams whose validity period contains the time instant specified by the parameter	string (date-time)
validInRange optional		TimeRange
validTo optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
variableTableName optional	Selects job streams referencing the specified variable table either directly or indirectly through defined run cycles	string
workstationName optional		string

JustificationData


Name	Schema
category optional	string
description optional	string
ticketNumber optional	string

KeyValues

Type : < StringMapObj > array

LateInfo

Type : object

LockData

Data about locking information


Name	Description	Schema
lockedBy optional read-only		string
lockedSession optional read-only	Session Name	string
lockedTime optional read-only	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

LongRange


Name	Schema
rangeEnd optional	integer (int64)
rangeStart optional	integer (int64)

MakeJobStreamInfo


Name	Description	Schema
alias optional		string
inputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
parameterMap optional		< StringMapObj > array

MessageLogRecord


Name	Schema
header optional	MessageLogRecordHeader
ruleId optional	string
ruleInstanceId optional	string

MessageLogRecordFilter


Name	Schema
eventTypeList optional	< string > array
informationTypeList optional	< string > array
ruleId optional	string
ruleInstanceId optional	string
ruleName optional	string
ruleTypeList optional	< string > array
scope optional	string
timeRange optional	TimeRange

MessageLogRecordHeader


Name	Description	Schema
eventType optional		string
group optional		string
id optional		string
informationType optional		string
lineOfBusiness optional		string
message optional		string
ruleFolderName optional		string
ruleName optional		string
ruleType optional		string
scope optional		string
source optional		string
timestamp optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
workstationName optional		string

ModifyData


Name	Description	Schema
modifiedBy optional read-only		string
modifiedTime optional read-only	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

NameFolderObjectPropertiesCollection

Type : < NameObjectRule > array

NameObjectProperties


Name	Schema
fodlers optional	< string > array
folders optional	< string > array
names optional	< string > array

NameObjectPropertiesCollection

Type : < NameObjectRule > array

NameObjectRule


Name	Schema
exclude optional	NameObjectProperties
include optional	NameObjectProperties

NextPredecessorsChainInfo


Name	Schema
filter optional	QueryPlanContext
option optional	string

NoResponse

Type : object

NodeStatus


Name	Description	Schema
canceled optional		boolean
commonStatus optional	Valid values are WAITING, READY, RUNNING, SUCCESSFUL, ERROR, CANCELED, HELD, UNDECIDED, BLOCKED, SUPPRESS	string
internalStatus optional	Valid values are READY, HOLD, EXEC, EXEC_PLUS, ABEND, SUCC, CANCEL, UNKNOWN, USER_STREAM, CANCELP, ADD, RJOB, FAILED, MPE_SUSP, WAIT, INTRO, INTRO_PLUS, WAITD, SCHED, ABENDP, SUCCP, ENDP, EXTRN, ERROR, FENCE, BOUND, SUSP, SUPPRESS, RECOVERY_IN_PROGRESS	string

ObjectProperties


Name	Schema
cpuFolders optional	< string > array
cpus optional	< string > array
folders optional	< string > array
names optional	< string > array

ObjectPropertiesCollection

Type : < ObjectRule > array

ObjectRule


Name	Schema
exclude optional	ObjectProperties
include optional	ObjectProperties

OutputCondition

For internal conditional dependency ONLY


Name	Schema
conditionId optional	string
conditionName optional	string
jobDefinitionModelId optional	string
jobDefinitionModelKey optional	JobDefinitionKey
mappingExpression optional	string
succCondition optional	boolean

OutputConditionInPlan


Name	Schema
conditionId optional	string
conditionName optional	string
jobDefinitionInPlanId optional	string
jobDefinitionInPlanKey optional	JobDefinitionInPlanKey
mappingExpression optional	string
satisfied optional	boolean
succCondition optional	boolean

PlanInfo


Name	Description	Schema
key optional		SymphonyInPlanKey
startTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
timeExtension optional		integer (int64)

PredecessorsChainInfo


Name	Schema
filter optional	QueryFilterPlan
option optional	string

Prompt


Name	Description	Schema
dbaId optional		string
folderId optional		string
folderName optional		string
id optional		string
lockData optional		LockData
modifyData optional		ModifyData
name required	Required for predefined prompts, null for recovery and ad-hoc ones. Alphanumeric characters. Starting with alphabetic character. and ’_’ characters allowed. Blank spaces not allowed. Not longer than 8 characters. Maximal length : `8`	string
promptSymId optional		string
text optional		string

PromptDependency


Name	Description	Schema
adHoc optional	If true, the field is required. Otherwise, the field is required.	boolean
folderId optional		string
prompt optional		Prompt
promptId optional		string

PromptDependencyInPlan


Name	Schema
depSequence optional	integer (int32)
folderId optional	string
loadedFromDB optional	boolean
promptId optional	string
promptKey optional	PromptInPlanKey
promptNumber optional	integer (int32)
promptStatus optional	string
promptType optional	string
satisfied optional	boolean
status optional	string
text optional	string
workstationId optional	string
workstationInPlanKey optional	WorkstationInPlanKey

PromptFilter


Name	Description	Schema
deployedBatchApplicationName optional	Selects prompts referencing the specified workload application directly	string
promptIdList optional		< string > array
promptName optional		string

PromptInPlan


Name	Schema
cpuFolderId optional	string
cpuJsFolderId optional	string
folderId optional	string
id optional	string
jobId optional	string
jobInPlanKey optional	JobInPlanKey
jobStreamId optional	string
jobStreamInPlanKey optional	JobStreamInPlanKey
number optional	integer (int32)
planId optional	string
promptInPlanKey optional	PromptInPlanKey
resourceModelId optional	string
status optional	string
text optional	string
timeAsked optional	string (date-time)
timeRespond optional	string (date-time)
type optional	string
workstationId optional	string
workstationInPlanKey optional	WorkstationInPlanKey

PromptInPlanComplexFilter


Name	Schema
filter optional	PromptInPlanFilter
notOperator optional	boolean

PromptInPlanFilter


Name	Schema
promptId optional	string
promptJobId optional	string
promptName optional	string
promptNumber optional	integer (int32)
promptSymId optional	string
promptText optional	string
promptType optional	string
promptTypeList optional	< string > array
statusList optional	< string > array

PromptInPlanKey


Name	Schema
folderKey optional	FolderKey
href optional	string
name required	string
originalName optional	string
symId optional	string

PromptInPlanSorter


Name	Schema
askTime optional	Sorter
folderName optional	Sorter
name optional	Sorter
number optional	Sorter
replyTime optional	Sorter
resId optional	Sorter
status optional	Sorter
text optional	Sorter
type optional	Sorter
workstationName optional	Sorter

PromptSorter


Name	Schema
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
promptName optional	SorterModel
promptText optional	SorterModel

QueryEventRuleEngineContext


Name	Schema
filters optional	FiltersEventRuleEngine
howMany optional	integer (int32)
objectsKeys optional	< string > array

QueryFilterEventRuleEngine


Name	Schema
filters optional	FiltersEventRuleEngine
username optional	string

QueryFilterModel


Name	Schema
filters optional	FiltersModel
sorters optional	SortersModel
username optional	string

QueryFilterPlan


Name	Schema
complexFilters optional	ComplexQueryFilters
filters optional	FiltersPlan
sorters optional	Sorters

QueryPlanContext


Name	Schema
filters optional	FiltersPlan
howMany optional	integer (int32)
objectCount optional	integer (int32)
objectsIds optional	< string > array
restartIndex optional	integer (int64)
sequenceNumber optional	integer (int32)

RerunDetails


Name	Schema
asap optional	boolean
id optional	string
jobDefinitionInPlan optional	JobDefinitionInPlan
priority optional	integer (int32)
rerunJobOnSameWorkstation optional	boolean
rerunJobOnTermination optional	boolean
skipCheckForJobSuccessorRerun optional	boolean
startTime optional	string (date-time)
stepName optional	string

ResolutionData


Name	Description	Schema
endOffset optional		integer (int64)
resolutionRule optional	The resolution rule. Valid Values are: NEAREST_BEFORE, IN_SAME_DAY, IN_ABSOLUTE_INTERVAL, IN_RELATIVE_INTERVAL, CLOSEST_PRECEDING, SAME_DAY	string
startOffset optional		integer (int64)

Resource


Name	Schema
connectedWorkstationLinks optional	< string > array
connectedWorkstationLinksObjs optional	< WorkstationLink > array
dbaId optional	string
folderId optional	string
header optional	ResourceHeader
ownerName optional	string
resourceAvailabilityIntervals optional	< ResourceAvailabilityInterval > array
resourceSymId optional	string
workloadApplicationId optional	string
workstationId optional	string

ResourceAvailabilityInterval


Name	Schema
connectedWorkstationLinks optional	< WorkstationLink > array
description optional	string
intervalEndTime optional	integer (int64)
intervalStartTime optional	integer (int64)
intervalValidityDate optional	string (date-time)
intervalValidityDayOfWeek optional	integer (int32)
isAvailable optional	string
isDateIntervalType optional	boolean
isDayOfWeekIntervalType optional	boolean
isStandardIntervalType optional	boolean
quantity optional	integer (int32)

ResourceBaseConstraints


Name	Schema
actionOnComplete optional	string
actionOnError optional	string
alternateWorkstationInPlanKeys optional	< string > array
groupId optional	string
isAvailable optional	string
maxUsageLimitType optional	string
maxUsageLimitValue optional	integer (int32)
quantity optional	integer (int32)
usedFor optional	string
zOSHiperbatch optional	boolean

ResourceDependency


Name	Description	Schema
actionOnComplete optional	The action after completion. Valid values are: DEFAULT, YES, NO, RESET	string
allocationType optional	The allocation type. Valid values are: SHARED, EXCLUSIVE	string
folderId optional		string
onError optional	The error management. Valid values are: KEEP, RELEASE, DEFAULT	string
quantity optional		integer (int32)
resourceId optional		string
resourceKey optional		ResourceKey
resourceQuantity optional		integer (int32)

ResourceDependencyInPlan


Name	Schema
allocationType optional	string
available optional	integer (int32)
depSequence optional	integer (int32)
folderId optional	string
onError optional	string
quantity optional	integer (int32)
quantityHeld optional	integer (int32)
resourceActionOnComplete optional	string
resourceId optional	string
resourceKey optional	ResourceInPlanKey
satisfied optional	boolean
status optional	string
workstationId optional	string

ResourceFilter


Name	Description	Schema
deployedBatchApplicationName optional	Selects resources referencing the specified workload application directly	string
resourceIdList optional		< string > array
resourceName optional		string
workstationName optional		string

ResourceHeader


Name	Schema
defaultConstraints optional	ResourceBaseConstraints
description optional	string
id optional	string
key optional	ResourceKey
lockData optional	LockData
modifyData optional	ModifyData

ResourceHolderInPlan


Name	Schema
jobId optional	string
jobKey optional	JobInPlanKey
jobStreamId optional	string
jobStreamInternalName optional	string
jobStreamKey optional	JobStreamInPlanKey
quantity optional	integer (int32)

ResourceInPlan


Name	Schema
cpuFolderId optional	string
defaultConstraints optional	ResourceBaseConstraints
description optional	string
folderId optional	string
holders optional	< ResourceHolderInPlan > array
id optional	string
modifyData optional	ModifyData
planId optional	string
quantityAvailable optional	integer (int32)
quantityDefined optional	integer (int32)
quantityInUse optional	integer (int32)
resourceInPlanAvailabilityIntervals optional	< ResourceInPlanAvailabilityInterval > array
resourceInPlanKey optional	ResourceInPlanKey
resourceKey optional	ResourceInPlanKey
resourceModelId optional	string
status optional	string
workstationId optional	string

ResourceInPlanAvailabilityInterval


Name	Schema
connectedWorkstationInPlanKeys optional	< WorkstationInPlanKey > array
isAvailable optional	string
quantity optional	integer (int32)

ResourceInPlanComplexFilter


Name	Schema
filter optional	ResourceInPlanFilter
notOperator optional	boolean

ResourceInPlanFilter


Name	Description	Schema
quantityAvailable optional		integer (int32)
quantityAvailableAsString optional		string
quantityAvailableRange optional		IntegerRange
quantityDefined optional		string
quantityInUse optional		string
resourceId optional		string
resourceName optional		string
resourceSymId optional		string
resourceType optional		string
status optional	Possible values are AVAILABLE, NOT_AVAILABLE, UNDECIDED	string
statusAsString optional		string
statusList optional		< string > array
workstatioName optional		string
workstationNameAsString optional		string
workstationSymId optional		string

ResourceInPlanKey


Name	Schema
folderKey optional	FolderKey
href optional	string
name required	string
originalName optional	string
symId optional	string
workstationInPlanKey optional	WorkstationInPlanKey

ResourceInPlanSorter


Name	Schema
availableQuantity optional	Sorter
folderName optional	Sorter
name optional	Sorter
quantity optional	Sorter
quantityInUse optional	Sorter
resId optional	Sorter
status optional	Sorter
workstatioName optional	Sorter

ResourceKey


Name	Schema
folderName optional	string
folderWorkstationName optional	string
name optional	string
workstationName optional	string

ResourceProperties


Name	Schema
cpuFolders optional	< string > array
cpus optional	< string > array
folders optional	< string > array
names optional	< string > array

ResourcePropertiesCollection

Type : < ResourceRule > array

ResourceRule


Name	Schema
exclude optional	ResourceProperties
include optional	ResourceProperties

ResourceSorter


Name	Schema
description optional	SorterModel
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
resourceName optional	SorterModel
resourceQuantity optional	SorterModel
workstationFolderName optional	SorterModel
workstationName optional	SorterModel

RoleProperties


Name	Schema
description optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name required	string

RuleAction


Name	Description	Schema
actionType optional		string
description optional		string
eventRuleId optional	The identifier of the event rule to which this rule action belongs	string
fromProps optional		< string, object > map
id optional		string
parameterMap optional		StringMap
pluginName optional	The name of the plug-in that is able to handle the rule action	string
position optional	The position of this action in the action list of the event rule	integer (int32)
responseType optional	Valid values are ON_DETECTION, ON_NEXT_EVENT, ON_TIME_OUT, ON_TIME_WINDOW_COMPLETE	string
scope optional	The scope of the action	string
type optional		string

RuleInstance


Name	Schema
header optional	RuleInstanceHeader
ruleId optional	string

RuleInstanceFilter


Name	Schema
ruleId optional	string
ruleName optional	string
ruleStatusList optional	< string > array
ruleTypeList optional	< string > array
timeRange optional	TimeRange

RuleInstanceHeader


Name	Description	Schema
id optional		string
isTimeoutExpired optional		boolean
ruleFolderName optional		string
ruleName optional		string
ruleStatus optional		string
ruleType optional		string
timestamp optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

RunCycle

A valid object must contain at least one RunCycle


Name	Description	Schema
availabilityCalendarId optional		string
availabilityValue optional		string
calendarFolderName optional		string
calendarId optional		string
calendarName optional		string
description optional		string
freeDaysRule optional	The FreeDaysRule Type. Valid Values are: NONE, NEAREST_BEFORE, NEAREST_AFTER, DO_NOT_SELECT, DO_NOT_COUNT	string
iCalendar optional	Required if type is not CALENDAR; must be null if type is CALENDAR. Must comply with the RFC2445 standard	string
id optional		string
inclusive optional		boolean
intervals optional		< AvailabilityCalendarInterval > array
jobStreamId optional		string
name optional		string
offsetType optional	The OffsetType Type. Valid values are: DEFAULT, DAYS, WORKDAYS, WEEKDAYS, MINUTES, PERCENTAGE. Required if type is not CALENDAR; must be null if type is CALENDAR.	string
offsetValue optional	Must be 0 if type is not CALENDAR	integer (int32)
parentRunCycleGroupId optional		string
priority optional		integer (int32)
repeatEndTime optional		integer (int64)
repeatEveryTime optional		integer (int64)
runCycleExceptions optional		RunCycleExceptions
runCycleGroupFolderName optional		string
runCycleGroupId optional		string
runCycleGroupName optional		string
subsetId optional		string
subsetOperator optional		string
timeRestrictions optional		TimeRestrictions
type optional	The RunCycle Type. Valid Values are: SIMPLE, CALENDAR, RULE, GROUP, NORMAL, NEGATIVE, EXCLUSION, RULE_INCLUSIVE, RULE_EXCLUSIVE	string
validFrom optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
validTo optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
variableTable optional		string
variableTableFolderName optional		string
variableTableId optional		string
variableTableName optional	Must be null if run cycle is exclusive (inclusive=false)	string

RunCycleExceptions


Name	Description	Schema
calendarId optional		string
calendarName optional		string
iCalendar optional		string
offsetType optional		string
offsetValue optional	The OffsetType Type. Valid values are: DEFAULT, DAYS, WORKDAYS, WEEKDAYS, MINUTES, PERCENTAGE	integer (int32)
type optional	The RunCycle Type. Valid Values are: SIMPLE, CALENDAR, RULE, GROUP, NORMAL, NEGATIVE, EXCLUSION, RULE_INCLUSIVE, RULE_EXCLUSIVE	string

RunCycleGroup


Name	Description	Schema
calendarId optional		string
folderId optional		string
freeDaysCalendarFolderName optional		string
freeDaysCalendarName optional		string
header optional		RunCycleGroupHeader
owner optional		string
runCycles optional	A valid object must contain at least one RunCycle	< RunCycle > array
saturdayFree optional		boolean
sundayFree optional		boolean
variableTableFolderName optional		string
variableTableId optional		string
variableTableName optional		string
workloadApplicationId optional		string

RunCycleGroupFilter


Name	Description	Schema
calendar optional		string
deployedBatchApplicationName optional	Selects runcycles referencing the specified workload application directly	string
name optional		string
owner optional		string
runCycleCalendar optional		string
runCycleCalendarName optional		string
runCycleGroupIdList optional		< string > array
runCycleName optional		string
runCycleVariableTable optional		string
runCycleVariableTableName optional		string
subsetId optional		string
variableTable optional		string

RunCycleGroupHeader


Name	Schema
defaultCalendar optional	string
description optional	string
folderName optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name optional	string
timeRestrictions optional	TimeRestrictions

RunCycleGroupSorter


Name	Schema
description optional	SorterModel
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
runCycleGroupName optional	SorterModel

SecurityDomain


Name	Schema
description optional	string
filter optional	SecurityDomainFilter
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name required	string
type optional	string

SecurityDomainFilter


Name	Schema
action optional	action
calendar optional	calendar
common optional	common
cpu optional	cpu
event optional	event
eventrule optional	eventrule
file optional	file
folder optional	folder
job optional	job
lob optional	lob
parameter optional	parameter
prompt optional	prompt
report optional	report
resource optional	resource
runcygrp optional	runcygrp
schedule optional	schedule
userobj optional	userobj
vartable optional	vartable
wkldappl optional	wkldappl

action


Name	Schema
empty optional	boolean

calendar


Name	Schema
empty optional	boolean

common


Name	Schema
empty optional	boolean

cpu


Name	Schema
empty optional	boolean

event


Name	Schema
empty optional	boolean

eventrule


Name	Schema
empty optional	boolean

file


Name	Schema
empty optional	boolean

folder


Name	Schema
empty optional	boolean

job


Name	Schema
empty optional	boolean

lob


Name	Schema
empty optional	boolean

parameter


Name	Schema
empty optional	boolean

prompt


Name	Schema
empty optional	boolean

report


Name	Schema
empty optional	boolean

resource


Name	Schema
empty optional	boolean

runcygrp


Name	Schema
empty optional	boolean

schedule


Name	Schema
empty optional	boolean

userobj


Name	Schema
empty optional	boolean

vartable


Name	Schema
empty optional	boolean

wkldappl


Name	Schema
empty optional	boolean

SecurityDomainKey


Name	Schema
key optional	TWSKey
keyPrefix optional	string
keyText optional	string
name optional	string

SecurityRole


Name	Schema
description optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name required	string
permissions optional	SecurityRolePermissions

SecurityRoleKey


Name	Schema
key optional	TWSKey
keyPrefix optional	string
keyText optional	string
name optional	string

SecurityRolePermissions


Name	Schema
action optional	< string > array
calendar optional	< string > array
cpu optional	< string > array
event optional	< string > array
eventrule optional	< string > array
file optional	< string > array
folder optional	< string > array
job optional	< string > array
lob optional	< string > array
parameter optional	< string > array
prompt optional	< string > array
report optional	< string > array
resource optional	< string > array
runcygrp optional	< string > array
schedule optional	< string > array
userobj optional	< string > array
vartable optional	< string > array
wkldappl optional	< string > array

Sorter


Name	Description	Schema
descending optional	True is descending	boolean
priority optional	The priority used to sort on multiple level ordering - small number is higher	integer (int32)

SorterModel


Name	Description	Schema
descending optional	True is descending	boolean
priority optional	The priority used to sort on multiple level ordering - small number is higher	integer (int32)

Sorters


Name	Schema
domainInPlanSorter optional	DomainInPlanSorter
fileInPlanSorter optional	FileInPlanSorter
jobInPlanSorter optional	JobInPlanSorter
jobStreamInPlanSorter optional	JobStreamInPlanSorter
promptInPlanSorter optional	PromptInPlanSorter
resourceInPlanSorter optional	ResourceInPlanSorter
windowsUserInPlanSorter optional	WindowsUserInPlanSorter
workstationInPlanSorter optional	WorkstationInPlanSorter

SortersModel


Name	Schema
calendarSorter optional	CalendarSorter
domainSorter optional	DomainSorter
eventRuleSorter optional	EventRuleSorter
folderSorter optional	FolderSorter
jobDefinitionSorter optional	JobDefinitionSorter
jobStreamSorter optional	JobStreamSorter
promptSorter optional	PromptSorter
resourceSorter optional	ResourceSorter
runCycleGroupSorter optional	RunCycleGroupSorter
variableTableSorter optional	VariableTableSorter
windowsUserSorter optional	WindowsUserSorter
workloadApplicationTemplateSorter optional	WorkloadApplicationTemplateSorter
workstationClassSorter optional	WorkstationClassSorter
workstationSorter optional	WorkstationSorter

Status


Name	Schema
commonStatus optional	string
internalStatus optional	string

StringMap


Name	Schema
value optional	< StringMapObj > array

StringMapObj


Name	Schema
key optional	string
value optional	string

SubmitJobInfo


Name	Schema
alias optional	string
hasUniqueName optional	boolean
job optional	JobInPlan
variableTable optional	< StringMapObj > array
variableTableId optional	string
workstationId optional	string

SubmitJobIntoJobStreamInfo


Name	Description	Schema
alias optional		string
hasUniqueName optional		boolean
inputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
jobDefinitionId optional		string
variableTable optional		< StringMapObj > array
variableTableId optional		string

SubmitJobStreamInfo


Name	Description	Schema
alias optional		string
inputArrivalTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
jobstream optional		JobStreamInPlan
variableTable optional		< StringMapObj > array
variableTableId optional		string

SymphonyInPlan


Name	Schema
active optional	boolean
companyName optional	string
creationDate optional	string (date-time)
criticalPathEnabled optional	boolean
dbId optional	string
emptySchedsAreSucc optional	boolean
eventProcessorEIFPort optional	integer (int32)
eventProcessorEIFSSLPort optional	integer (int32)
eventProcessorPort optional	integer (int32)
eventProcessorWorkstationName optional	string
id optional	string
key optional	SymphonyInPlanKey
lastTimeOpened optional	string (date-time)
listSecurityCheckEnabled optional	boolean
masterDomainName optional	string
masterWorkstationName optional	string
numberOfCpu optional	integer (int32)
recoveryPromptBase optional	integer (int32)
recoveryPromptDelta optional	integer (int32)
rerunSameName optional	boolean
runNumber optional	integer (int32)
size optional	integer (int32)
startOfDay optional	integer (int32)
timeFirstJobStarted optional	string (date-time)
timezoneEnabled optional	boolean
untilDays optional	integer (int32)
validFrom optional	string (date-time)
validTo optional	string (date-time)
whatIfEnabled optional	boolean

SymphonyInPlanComplexFilter


Name	Schema
filter optional	SymphonyInPlanFilter
notOperator optional	boolean

SymphonyInPlanFilter


Name	Description	Schema
planId optional		string
planName optional		string
planType optional	The Plan Type. Valid Values are: ARCHIVED, SYMNEW, TRIAL, FORECAST, CURRENT, UNKNOWN	string

SymphonyInPlanKey


Name	Schema
name required	string
type optional	string

TWSKey


Name	Schema
name optional	string

TaskTypeInPlan


Name	Schema
id optional	string
name required	string
recordNumber optional	integer (int32)

TimeInfo


Name	Description	Schema
actualEndTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
actualStartTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss - This is the Real Start Time. This Time plus the Real Duration (elapsedTime) gives the Finish Time	string (date-time)
elapsedTime optional	Time in milliseconds	integer (int64)
estimatedDuration optional	Time in milliseconds	integer (int64)

TimeRange


Name	Description	Schema
rangeEnd optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
rangeStart optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

TimeRestrictions


Name	Description	Schema
deadlineAction optional		string
deadlineOffset optional		integer (int64)
frequency optional	The frequencyWithinDayType Type. Valid values are: NONE, HOURLY, MINUTELY	string
hoursList optional		string
interval optional		integer (int64)
isTimeDependent optional		boolean
latestStartAction optional	Valid values are: SUPPRESS, CONTINUE, CANCEL	string
latestStartOffset optional		integer (int64)
maxDuration optional		integer (int64)
maxDurationAction optional	Valid values are: SUPPRESS, CONTINUE, CANCEL	string
maxDurationType optional	The OffsetType Type. Valid values are: DEFAULT, DAYS, WORKDAYS, WEEKDAYS, MINUTES, PERCENTAGE	string
minDuration optional		integer (int64)
minDurationAction optional	Valid values are: ABEND, CONTINUE, CANCEL	string
minDurationType optional	The OffsetType Type. Valid values are: DEFAULT, DAYS, WORKDAYS, WEEKDAYS, MINUTES, PERCENTAGE	string
minutesList optional		string
numberOfOccurrences optional		integer (int64)
perJobUntil optional	Default value is false Default : `false`	boolean
repeatEndTime optional		integer (int64)
repeatInterval optional		integer (int64)
startOffset optional		integer (int64)

TimeRestrictionsInPlan


Name	Description	Schema
deadlineAction optional	Can be defined only on Job. Valid value is: SUPPRESS	string
deadlineTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
lateInfo optional		LateInfo
maxDuration optional	Time in milliseconds - applicable only for Job in plan	integer (int32)
maxDurationAction optional	Applicable only for Job in plan	string
minDuration optional	Time in milliseconds - applicable only for Job in plan	integer (int32)
minDurationAction optional	Applicable only for Job in plan	string
moveToTailEnd optional		boolean
originalDeadline optional		string (date-time)
perJobUntil optional	Default : `false`	boolean
startTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
timeDependent optional		boolean
untilAction optional		string
untilJobStreamTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)
untilTime optional	Time in ISO 8601 UTC with format yyyy-MM-dd’T’HH:mm:ss	string (date-time)

User


Name	Description	Schema
id optional		string
isPasswordEncrypted optional		boolean
key optional		WindowsUserKey
lockData optional		LockData
modifyData optional		ModifyData
password optional	The Password is a required parameter to create the windows user object, but it is not required to update the windows user object.	string
workstationId optional		string

UserobjProperties


Name	Schema
cpuFolders optional	< string > array
cpus optional	< string > array
logons optional	< string > array

UserobjPropertiesCollection

Type : < UserobjRule > array

UserobjRule


Name	Schema
exclude optional	UserobjProperties
include optional	UserobjProperties

Variable


Name	Schema
description optional	string
id optional	string
key optional	VariableKey
lockData optional	LockData
modifyData optional	ModifyData
value optional	string
variableTableId optional	string

VariableFilter


Name	Schema
variableName optional	string
variableTableName optional	string

VariableKey


Name	Schema
isInDefaultTable optional	boolean
name optional	string
variableTableFolderName optional	string
variableTableName optional	string

VariableTable


Name	Schema
folderId optional	string
header optional	VariableTableHeader
ownerName optional	string
variables optional	< Variable > array
workloadApplicationId optional	string

VariableTableFilter


Name	Description	Schema
deployedBatchApplicationName optional	Selects variable tables referencing the specified workload application directly	string
isDefaultTable optional		boolean
ownerName optional		string
variableName optional		string
variableTableIdList optional		< string > array
variableTableName optional		string

VariableTableHeader


Name	Schema
description optional	string
folderName optional	string
id optional	string
isDefault optional	boolean
lockData optional	LockData
modifyData optional	ModifyData
name optional	string

VariableTableSorter


Name	Schema
description optional	SorterModel
folderName optional	SorterModel
isDefaultTable optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
variableTableName optional	SorterModel

VirtualWorkstationInPlanComplexFilter


Name	Schema
filter optional	VirtualWorkstationInPlanFilter
notOperator optional	boolean

VirtualWorkstationInPlanFilter


Name	Schema
accessMethod optional	string
automation optional	boolean
destination optional	string
domainName optional	string
isFaultTolerant optional	boolean
isVirtual optional	boolean
reportingAttributesList optional	< string > array
supportedTaskType optional	string
wait optional	boolean
workstationName optional	string
workstationTypeList optional	< string > array
workstationVDest optional	string

WAObjectIssue


Name	Schema
id optional	string
issueMessage optional	string
issueType optional	string

WAObjectIssueResult


Name	Schema
value optional	WAObjectIssue

WarningMessagesInfo


Name	Schema
isWarning optional	boolean
listMessages optional	< object > array
warning optional	boolean

WhatIfInfo


Name	Schema
getPredecessors optional	boolean
getSuccessors optional	boolean
jobs optional	< string > array
levels optional	integer (int32)
limitOnCompletedObj optional	boolean
maxObjs optional	integer (int32)
returnReqJobs optional	boolean

WhatIfResult


Name	Schema
key optional	string
value optional	JobInPlanOnCriticalNetwork

WindowsUserFilter


Name	Schema
userIdList optional	< string > array
userName optional	string
workstationName optional	string

WindowsUserInPlan


Name	Schema
cpuFolderId optional	string
id optional	string
isPasswordEncrypted optional	boolean
modifyData optional	ModifyData
password optional	string
planId optional	string
userDefinitionId optional	string
windowsUserInPlanKey optional	WindowsUserInPlanKey
workstationId optional	string

WindowsUserInPlanComplexFilter


Name	Schema
filter optional	WindowsUserInPlanFilter
notOperator optional	boolean

WindowsUserInPlanFilter


Name	Schema
userId optional	string
userName optional	string
workstationName optional	string
workstationSymId optional	string

WindowsUserInPlanKey


Name	Schema
href optional	string
name required	string
workstationKey optional	WorkstationInPlanKey

WindowsUserInPlanSorter


Name	Schema
userId optional	Sorter
userName optional	Sorter
workstationName optional	Sorter

WindowsUserKey


Name	Schema
folderWorkstationName optional	string
name optional	string
workstationName optional	string

WindowsUserSorter


Name	Schema
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
userName optional	SorterModel
workstationFolderName optional	SorterModel
workstationName optional	SorterModel

WorkloadApplication


Name	Schema
calendars optional	< Calendar > array
distJobDefinitions optional	< JobDefinition > array
header optional	WorkloadApplicationHeader
jobStreams optional	< JobStream > array
mapping optional	string
prompts optional	< Prompt > array
resources optional	< Resource > array
runCycleGroups optional	< RunCycleGroup > array
variableTables optional	< VariableTable > array
xmlObject optional	string

WorkloadApplicationFilter


Name	Description	Schema
workloadApplicationName optional	Selects workload application referencing the specified workload application directly	string
workloadApplicationOwnerName optional	Selects workload application referencing the specified workload application owner name directly	string

WorkloadApplicationHeader


Name	Schema
deployedFrom optional	string
description optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name optional	string
vendor optional	string

WorkloadApplicationTemplate


Name	Schema
header optional	WorkloadApplicationTemplateHeader
jobStreams optional	< JobStreamInTemplate > array

WorkloadApplicationTemplateFilter


Name	Description	Schema
jobStreamName optional		string
workloadApplicationTemplateIdList optional		< string > array
workloadApplicationTemplateName optional	Selects workload application template referencing the specified workload application template directly	string
workloadApplicationTemplateOwnerName optional	Selects workload application template referencing the specified workload application template owner name directly	string

WorkloadApplicationTemplateHeader


Name	Schema
description optional	string
id optional	string
lockData optional	LockData
modifyData optional	ModifyData
name required	string
vendor optional	string

WorkloadApplicationTemplateSorter


Name	Schema
description optional	SorterModel
folderName optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
workloadApplicationTemplateName optional	SorterModel

Workstation


Name	Description	Schema
accessMethod optional	This field is required when the Workstation Type specified in the WorkstationHeader object is XA. Access Method is the name of a method file that resides in the TWShome/methods directory on the agent host workstation. For local UNIX extended agents, the method name is unixlocl. For remote UNIX extended agents the method name is unixrsh. For network agents, the method name is netmth.	string
agentLinks optional		< WorkstationLink > array
autoLink optional		boolean
domainId optional		string
folderId optional		string
fullStatus required	This field must be set to TRUE if the Workstation Type specified in the WorkstationHeader object is MANAGER.	boolean
header optional		WorkstationHeader
hostFolderWorkstationName optional		string
hostWorkstationId optional		string
hostWorkstationName optional		string
isHostedByManager optional		boolean
isHostedByMaster optional		boolean
requirements optional		string
server optional		string
variableTableFolderName optional		string
variableTableId optional		string
variableTableName optional		string
workstationSymId optional		string

WorkstationClass


Name	Schema
allWorkstationsIncluded optional	boolean
folderId optional	string
header optional	WorkstationClassHeader
workstationLinks optional	< WorkstationLink > array
workstationSymId optional	string

WorkstationClassFilter


Name	Schema
workstationClassIdList optional	< string > array
workstationClassName optional	string

WorkstationClassHeader


Name	Schema
description optional	string
folderName optional	string
id optional	string
includeInPlan optional	boolean
lockData optional	LockData
modifyData optional	ModifyData
name optional	string

WorkstationClassSorter


Name	Schema
description optional	SorterModel
folderName optional	SorterModel
includeInPlan optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
workstationClassName optional	SorterModel

WorkstationConnectInfo


Name	Schema
command optional	string
connection optional	string

WorkstationFilter


Name	Description	Schema
hostWorkstationName optional		string
variableTableName optional		string
workstationAccessMethod optional		string
workstationDomainName optional		string
workstationIdList optional		< string > array
workstationName optional		string
workstationOperatingSystem optional	The Workstation Operating System. Valid values are: WINDOWS, UNIX, ZOS, LINUX, AIX, HPUX, SOLARIS, AS400, WEB, OTHER	string
workstationOperatingSystemList optional		< string > array
workstationSymId optional		string
workstationType optional	The Workstation Type. Valid values are: MANAGER, FTA, XA, SA, WORKLOAD_BROKER, AGENT, POOL, DYNAMIC_POOL, REMOTE_ENGINE, GENERAL, COMPUTER, PRINTER, ZCENTRIC	string
workstationTypeList optional		< string > array

WorkstationHeader


Name	Description	Schema
behindFirewall optional		boolean
description optional		string
domainName optional		string
folderName optional		string
id optional		string
includeInPlan optional		boolean
licenseType optional		string
lockData optional		LockData
modifyData optional		ModifyData
name optional		string
nodeName required	Must be a valid hostname or internet address Maximal length : `51`	string
os required		enum (WINDOWS, UNIX, ZOS, LINUX, AIX, HPUX, SOLARIS, AS400, WEB, OTHER)
remoteEnginePort optional		integer (int32)
remoteEngineType optional		string
securityLevel optional	Required if type is not XA, null if type is XA	enum (ON, NONE, ENABLED, FORCE, HTTP, HTTPS)
sslPort optional		integer (int32)
tcpPort optional		integer (int32)
timeZone optional		string
type required		enum (MANAGER, FTA, XA, SA, BROKER, AGENT, POOL, DYNAMIC_POOL, REMOTE_ENGINE, GENERAL, COMPUTER, PRINTER, ZCENTRIC)

WorkstationInPlan


Name	Description	Schema
accessMethod optional read-only	The (XA only) Workstation access method, used during the connectToHostCpu API	string
applicationServerStatus optional read-only	The Application Server Status. Valid Values are: RUNNING, NOT_RUNNING, RESTARTING	string
autoLink optional read-only		boolean
behindFirewall optional read-only		boolean
configUpdated optional read-only	SSM Agent’s configuration is updated	boolean
daylightTime optional read-only		boolean
defaultUser optional read-only	Default user name. Used by OPC	string
domainId optional read-only		string
domainInPlanKey optional		DomainInPlanKey
elapsedTime optional read-only		integer (int64)
evtProcRunning optional read-only	Event Processor is running	boolean
fence optional read-only		integer (int32)
folderId optional read-only		string
folderName optional read-only		string
fullStatus optional read-only		boolean
hostType optional read-only	The Host Workstation Type. Valid Values are: MASTER, MANAGER, WORKSTATION	string
hostWorkstationId optional read-only		string
hostWorkstationKey optional		WorkstationInPlanKey
id optional read-only		string
initExec optional read-only	JobMan updating Workstation for exececuting job	boolean
initialized optional read-only		boolean
jobLauncherDisabled optional read-only		boolean
jobmanUp optional read-only		boolean
key optional		WorkstationInPlanKey
licenseType optional read-only	The License Type. Valid Values are: PerJob, PerServer	string
limit optional read-only		integer (int32)
linkStatus optional read-only	The Workstation link status. Valid values are: LINKED, UNLINKED, FULLY_LINKED, NOT_APPLICABLE	string
mailReceived optional read-only	Used to check if the link is Up	boolean
modifyData optional		ModifyData
monmanCurrentCfg optional read-only	Monman current monitoring configuration crc	integer (int32)
monmanNewCfg optional read-only	Monman new monitoring configuration crc	integer (int32)
nodeName optional read-only		string
os optional read-only	The Workstation Operating System. Valid Values are: WINDOWS, UNIX, ZOS, LINUX, AIX, HPUX, SOLARIS, AS400, WEB, OTHER	string
planId optional read-only		string
remoteEnginePort optional read-only	The remote engine port (broker port on broker workstations)	integer (int32)
requestedJobs optional read-only	Number of requested jobs	integer (int32)
resolveDependencies optional read-only		boolean
securityLevel optional read-only	The Workstation Security Level. Valid Values are: ON, NONE, ENABLED, FORCE, HTTP, HTTPS	string
server optional read-only	A char representing the server code	string
sslPort optional read-only		integer (int32)
ssmRunning optional read-only		boolean
symDwnld optional read-only	Symphony downloaded for new day	boolean
symRunNumber optional read-only	The Symphony RunNumber of the Workstation	integer (int32)
tcpLink optional read-only		boolean
tcpPort optional read-only		integer (int32)
timeStarted optional read-only	Time in ISO 8601 - The Date this Workstation started	string (date-time)
timeZone optional read-only		string
type optional read-only	The Workstation Type. Valid Values are: MANAGER, FTA, XA, SA, BROKER, AGENT, POOL, DYNAMIC_POOL, REMOTE_ENGINE, GENERAL, COMPUTER, PRINTER, ZCENTRIC	string
userInfo optional read-only		string
version optional read-only		string
workstationInPlanKey optional		WorkstationInPlanKey
workstationModelId optional read-only		string
writerDs optional read-only	Mailman is writing to Mailbox	boolean
writerUp optional read-only		boolean

WorkstationInPlanComplexFilter


Name	Schema
filter optional	WorkstationInPlanFilter
notOperator optional	boolean

WorkstationInPlanFilter


Name	Description	Schema
accessMethod optional		string
automation optional		boolean
destination optional		string
domainName optional		string
dynamicSchedulingWs optional		boolean
evtProcRunning optional		boolean
evtProcRunningList optional		< boolean > array
fence optional		string
hostId optional		string
hostName optional		string
hostType optional	Valid values are MASTER, MANAGER, WORKSTATION	string
isFaultTolerant optional		boolean
isZCentricAgent optional		boolean
jobmanUp optional		boolean
jobmanUpList optional		< boolean > array
limit optional		string
linkStatus optional		string
linkStatusList optional		< string > array
nodeName optional		string
remoteEngineType optional		string
reportingAttributesList optional		< string > array
securityLevel optional		string
server optional		string
sslPort optional		string
ssmConfigUpdated optional		boolean
ssmConfigUpdatedList optional		< boolean > array
startTimeAsString optional		string
supportedTaskType optional		string
symRunNumber optional		string
tcpPort optional		string
timezoneId optional		string
userInfo optional		string
version optional		string
virtual optional		boolean
wait optional		boolean
workstationId optional		string
workstationName optional		string
workstationNameAsString optional		string
workstationSymId optional		string
workstationType optional		string
workstationTypeList optional		< string > array
writerUp optional		boolean
writerUpList optional		< boolean > array

WorkstationInPlanKey


Name	Schema
folderKey optional	FolderKey
href optional	string
name required	string
originalName optional	string
symId optional	string

WorkstationInPlanSorter


Name	Schema
accessMethod optional	Sorter
applicationSrvStatus optional	Sorter
autolink optional	Sorter
behindFirewall optional	Sorter
domainName optional	Sorter
elapsedTime optional	Sorter
engineAddressPort optional	Sorter
evtProcRunning optional	Sorter
fence optional	Sorter
folderName optional	Sorter
fullStatus optional	Sorter
hostName optional	Sorter
initExec optional	Sorter
initialized optional	Sorter
jobmanUp optional	Sorter
limit optional	Sorter
linkStatus optional	Sorter
mailReceived optional	Sorter
mailmanWriting optional	Sorter
monmanCurrCfg optional	Sorter
monmanNewCfg optional	Sorter
nodeName optional	Sorter
operatingSystem optional	Sorter
remoteEnginePort optional	Sorter
requestedJobs optional	Sorter
securityLevel optional	Sorter
server optional	Sorter
sslPort optional	Sorter
ssmConfigUpdated optional	Sorter
ssmRunning optional	Sorter
startTime optional	Sorter
symDownloaded optional	Sorter
symRunNumber optional	Sorter
tcpLinked optional	Sorter
tcpPort optional	Sorter
timezoneId optional	Sorter
userInfo optional	Sorter
version optional	Sorter
workstationId optional	Sorter
workstationName optional	Sorter
workstationSymId optional	Sorter
workstationType optional	Sorter
writerUp optional	Sorter

WorkstationLink


Name	Schema
folderWorkstationName optional	string
workstationId optional	string
workstationName optional	string

WorkstationSorter


Name	Schema
behindFirewall optional	SorterModel
description optional	SorterModel
domainName optional	SorterModel
folderName optional	SorterModel
includeInPlan optional	SorterModel
lockedBy optional	SorterModel
lockedTime optional	SorterModel
modifiedBy optional	SorterModel
modifiedTime optional	SorterModel
nodeName optional	SorterModel
os optional	SorterModel
securityLevel optional	SorterModel
sslPort optional	SorterModel
tcpPort optional	SorterModel
timeZone optional	SorterModel
workstationLicenseType optional	SorterModel
workstationName optional	SorterModel
workstationType optional	SorterModel

ZosStatusObjectCount


Name	Description	Schema
count optional	Number of jobs	integer
fieldValue optional		fieldValue

fieldValue


Name	Description	Schema
charValue optional	:held,:waiting,:blocked,:ready,:started,:complete,:error,:undecided,:suppressed by condition	string

Security

basicAuth

Type : basic

HCL Workload Automation API

Overview

Version information

URI scheme

Paths

Get Engine Info

Responses

Produces

Tags

Get Mailbox Filling Percentage

Parameters

Responses

Produces

Tags

GET operation for the Active Rules

Description

Parameters

Responses

Produces

Tags

START operation for the event builder

Description

Responses

Tags

STOP operation for the event builder

Description

Responses

Tags

GET operation for Action Plugin Configuration

Description

Responses

Produces

Tags

GET operation for ActionRun in an EventRule

Description

Parameters

Responses

Produces

Tags

POST operation for run a List of ActionRun

Description

Parameters

Responses

Tags

Query operation for ActionRun

Description

Parameters

Responses

Consumes

Produces

Tags

Query operation for ActionRun

Description

Parameters

Responses

Consumes

Produces

Tags

GET operation for ActionRun

Description

Parameters

Responses

Produces

Tags

Query operation for AuditRecord

Description

Parameters

Responses

Consumes

Produces

Tags

Query operation for AuditRecord

Description

Parameters

Responses

Consumes

Produces

Tags

GET operation for AuditRecord

Description