IPA License Requirements: An IPA License must be allocated to the current user and must have been acquired by the current session to call this method. Applications must use the /icws/{sessionId}/licenses resource to acquire an IPA license.
This method launches an IPA process, thus creating a new process instance. The launch request can optionally specify a specific revision of the process definition and/or values to use for process input parameters.
Feature | Version | |
---|---|---|
ipa | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.This object is used in the request to launch a new process instance.
Required
This property indicates the definition ID of the process that is to be launched.
When specified, this property indicates the specific revision of the process that is to be launched. If this property is not specified, the most recently published version of the process will be lauched.
When specified, this property indicates the data values to use as process input parameters when the process is launched. None, some or all of the process input parameters may be specified. Process input parameters that are not specified will start with the initial values defined within the process definition. Format.
This property can be null.
Property type documentation:
This class defines the structure that contains the list of runtime data values, item selections, etc.
Required
This property contains meta infomation about the data values.
Required
The JSON type representing this option.Required
This field specifies the type of payload that is described by the object that contains this meta object.
The value of this field will always be "dataValue" for the data values received as part of a show page event message.
Required
This field contains a string value that looks like a typical #.#.#.# version string. The numbers represented in this string may change over time as new features are added to IPA.
The current value for formatVersion
is 3.0.0.0
.
This property contains the list of runtime data values that described the data object instances used on the work item page.
This property can be null.
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of boolean values to use for this boolean data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a boolean value to use for this data object instance collection item . If this field is not emitted or if its value is null, then an not set should be assumed.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a boolean value to use for this data type object instance . If this field is not emitted or if its value is null, then an not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of complex values to use for this items collection for complex data collection instance. If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a complex object value to use for this data object instance collection item . If this field is not emitted or if it value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
This field contains the unique identifier ($ID) for the complex data type instance. If the field is not emitted, then it should be assumed that either the field does not apply in this context, or that no unique ID was defined for the corresponding complex data type definition. But, if the value is null or empty string, then it should be assumed that a unique ID is defined, but the value resolves to null or empty string.
It should be noted that, unlike most of the other fields with a name that ends in "Id" that are GUIDs, this uniqueId field is not a GUID. Rather, the value of this field is a string calculated by Process Automation Server. For example, it could be the concatentation of all of the string representations from all of the fields identified as being part of the unique identifier within the complex data definition. Or, it could be the result of a custom calculation.
The class that contains this value is used in various different contexts, and this uniqueId field does not apply in every context. The unique ID is a runtime concept, so it does not make sense in definitions. Similarly, the value is only calculated by Process Automation Server, so it does not make sense when sending values from a client to the server.
This property can be null.
This field contains the values to use for the various properties of a complex object.
This property can be null.
Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of boolean values to use for this boolean property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a boolean value to use for this complex object property value . If this field is not emitted or if its value is null, then an not set should be assumed.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
Recursive
TODO: Description.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
Recursive
This field contains a complex object value to use for this complex object property value . If this field is not emitted or if it value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of currency values to use for this currency property value collection . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a currency value to use for this data object instance collection item . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
This field contains a string representation of the amount of the currency, which may be postive or negative.
See String Representation of Currency Values for more information about how a currency value is represented.
This property can be null.
This field specifies the currency code that is associated with the amount field.
See String Representation of Currency Values for more information about how a currency value is represented.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a currency value to use for this complex object property value . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this date property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the string representation of the value to use for this string representation of value . If this field is not emitted or if its value is null, a value of not set should be assumed.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this date complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this date-time property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this date-time complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this decimal property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this decimal complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this duration property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this duration complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this long property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this long complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of mailbox values to use for this mailbox property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a mailbox value to use for this data object instance collection item . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
This field contains a string representation of the mailbox value.
See String Representation of Mailbox Values for more information about how a mailbox value is represented.
Required
This field contains a string representation of the mailbox type. Possible values are show below.
See String Representation of Mailbox Values for more information about how a mailbox value is represented.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a mailbox value to use for this complex object property value . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this skill property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a skill value is simply the name of the skill.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this skill complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a skill value is simply the name of the skill.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this string property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a string value is simply the string itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this string complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a string value is simply the string itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this time property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this time complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this uri property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a URI value is simply the URI itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this uri complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a URI value is simply the URI itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of user queue values to use for this user queue property value collection . If this field is not emitted or if its value is null, then a not set should be assumed.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.Required
This field contains the object instance ID for this object instance.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains a user queue value to use for this data object instance collection item . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
This field holds the username associated with the user queue.
See String Representation of User Queue Values for more information about how a user queue value is represented.
This field specifies the display name is associated with the val field. If the field is not emitted or the value is null or empty string, then it is assumed that there is no display name configured in IA for this user.
See String Representation of User Queue Values for more information about how a user queue value is represented.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a user queue value to use for this complex object property value . If this field is not emitted or if its value is null, then not set should be assumed.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains a list of the string representations of values to use for this workgroup queue property value collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the property definition that corresponds to this property value.
See the section on defId and name fields for more information about when the defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
This field contains the string representation of the value to use for this user queue complex object property value . If this field is not emitted or if its value is null, a value of not set should be assumed.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a complex object value to use for this data type object instance . If this field is not emitted or if it value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a complex object value, includes values for the object's properties and may include a unique ID depending on the context in which this class is used.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of currency values to use for this currency data object instance collection . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a currency value to use for this data type object instance . If this field is not emitted or if its value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a currency value, which includes both an amount and a currency code.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this date data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this date data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date Values for more information about how a date value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this date-time data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this date-time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Date-Time Values for more information about how a date-time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this decimal data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this decimal data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Decimal Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this duration data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this duration data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Duration Values for more information about how a decimal value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this long data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this long data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Long Values for more information about how a long value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of mailbox values to use for this mailbox data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a mailbox value to use for this data type object instance . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a mailbox value, which includes both a string value and a mailbox type.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this skill data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a skill value is simply the name of the skill.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this skill data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a skill value is simply the name of the skill.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this string data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a string value is simply the string itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this string data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a string value is simply the string itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this time data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this time data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
See String Representation of Time Values for more information about how a time value is represented as a string.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this uri data object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a URI value is simply the URI itself.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this uri data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a URI value is simply the URI itself.
This property can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of user queue values to use for this user queue data object instance collection . If this field is not emitted or if its value is null, then a not set should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a user queue value to use for this data type object instance . If this field is not emitted or if its value is null, then not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
This property can be null.
Property type documentation:
This class represents a user queue value, which includes both a value (username) and a display name.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains a list of the string representations of values to use for this workgroup queue object instance collection . If this field is not emitted or if its value is null, then an empty list should be assumed.
Note that if the security field is emitted and has a value, then the items field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
The items in this list can be null.
Required
The JSON type representing this option.This field contains the ID of the data definition from which the object instance is being created.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field contains the object instance ID for this object instance.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This field is used to specify the name of the process parameter when launching a new process with input and/or input/output parameters.
See the section on id, defId and name fields for more information about when the id, defId and name fields are used.
This property can be null.
The "security" field contains the name of the security profile, if any, that is preventing the user from seeing the current data. If this field is not emitted, null or empty string then no such security profile is preventing the user from seeing the data.
This property can be null.
This field contains the string representation of the value to use for this workgroup queue data type object instance . If this field is not emitted or if its value is null, a value of not set should be assumed.
Note that if the security field is emitted and has a value, then the val field will not also be emitted because, by definition, the values are being hidden from the user.
The string representation of a workgroup queue value is simply the name of the workgroup.
This property can be null.
This property contains the lists of selected items for the various controls in the work item page definition, such as a grid, that may be used as single-select or multi-select controls. If this property is not emitted or is null or empty, then the work item page definition must not contain any grids configured for use as selection controls.
It should be noted that the drop list control does not use this same selections property. This is because the drop list is always single select to a collection of basic or simple types (no complex types), and always selects by value and not by object instance ID or unique ID of a complex object.
Also, note that this selections field only applies in the context of a specific page, and does not apply in the context of multiple pages, an entire work item or entire process. Therefore, it can optionally be used in the show page event or when sending a page command, but is not used and will be ignored when launching a process.
This property can be null.
Required
This field indicates the fully scoped GUID that is the ID or the collection that contains the list if items (singleton or complex) from which a selection may be made.
For example, this could be the ID for a collection of basic or simple types displayed in a single-column grid. Or, it could be the ID of a collection that contains a complex object for each row that is to be displayed in a multi-column grid. Either way, this is the ID of a collection of all of the items, not just the selected items.
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
Required
This field indicates the fully scoped GUID that is the ID of the variable that holds the selected item (single select mode), or the ID of the collection that holds the list of selected items (multi-select mode).
When configured to select "by unique identifier", the variable indicated by this ID will be a string singleton (single-select mode) or string collection (multi-select mode), and only a string representation of the uniqueId(s) of the selected item(s) will be in that variable.
When configured to select "by data type", the variable indicated by this ID will be a singleton (single-select mode) or collection (multi-select mode) of the same type indicated by the sourceId field, which could be a basic, simple or complex type. And, in this case, a complete copy of each select item is stored in the variable indicated by this destination field; not just the uniqueId(s).
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
This field holds the list of simple GUIDs that are the IDs of the selected items, regardless of whether configured to select "by data type" or "by unique identifier".
This field is always a collection regardless of whether single-select mode or mult-select mode is being used. But, at most one item can exist in this list for single-select mode, whereas multiple items can exist in this list for mult-select mode.
See String Representation of Simple GUID for more information about how a simple GUID is represented as a string.
This property can be null.
This property specifies the desired behavior if PAS is overloaded at the time of the launch request. The fail option will be assumed if a value is not specified.
Process Automation has created successfully launched a process and has created a new process instance. The Process Instance ID for the newly created process is returned.
This object is returned in response to launching a new process.
Required
This property indicates the unique ID that was assigned to the process instance that was just created.
Required
This property indicates the state of the process instance immediately after it was created.
Property type documentation:
The request was not formatted correctly.
Required
A message that describes the current error.Invalid session token in request.
Required
A message that describes the current error.The current session is not allowed to use this method:
Required
A message that describes the current error.Process Automation Server (PAS) was not able to process the request. There could be any number of reasons: maybe a data ID was invalid or a data name was unknown; maybe data values were not in the correct format; etc.
Required
A message that describes the current error.Required
A message that describes the current error.IPA License Requirements: An IPA License must be allocated to the current user and must have been acquired by the current session to call this method. Applications must use the /icws/{sessionId}/licenses resource to acquire an IPA license.
This method searches for existing IPA process instances. It will find process instances that are still running as well as those that have already been completed or canceled.
Feature | Version | |
---|---|---|
ipa | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Specifies the range of results to be returned.
Example: Range: items=10-20.
Required
This property specifies the date & time for the beginning of the window used when searching for process instances. All process instances returned must have been running both on or after this time as well as on or before the specified endSearchWindow. This value is expected to be an ISO 8601 YYYYMMDDTHHMMSSZ date time.
Required
This property specifies the date & time for the end of the window used when searching for process instances. All process instances returned must have been running both on or before this time as well as on or after the specified beginSearchWindow. This value is expected to be an ISO 8601 YYYYMMDDTHHMMSSZ date time.
This property specifies the launch mode. Only processes created with the specified launchedMode will be returned in the search results. Either do not include this field or use the value "all" if it is desired to return all processes regardless of launchMode.
Default value: all
This property specifies the search terms to use for the process search. The search terms are generally space separate words used in the search.
A comma-delimited list of properties to be returned. The list of property names that can be used is the list of properties available in each item object within the items property included with the 200 response. If no properties are specified then only the instanceId is returned, and the instanceId is always returned even if it not specifically specified in this select clause.
Example (Before URL Encoding): select=instanceId,definitionId,details
One can also specify that all of the properties should be returned by using the '*' wildcard value. This is a shortcut to specifying all of the properties names in the parameter.
Default value: instanceId
A comma-delimited list of conditions to apply to the query. Only items that satisfy all conditions will be returned. It is possible to have conditions in this where clause for properties that were not included in the select clause.
The following operators can be used:
eq
- equalsct
- containsExample (Before URL Encoding): where definitionId eq
It is supported for the following properties, where the names and value formats of these properties correspond to the fields of the queryProcessInstancesResults objects returned in the items list of the response.
definitionId
details
initiatingUser.id
numericId
processName
revision
The name of the field to sort the results by. A query can only be sorted by one field.
To order in descending order use desc
.
Example (Before URL Encoding): orderBy startOfProcess desc
It is supported for the following properties, where the names and value formats of these properties correspond to the fields of the queryProcessInstancesResults objects returned in the items list of the response.
definitionId
details
endOfProcess
initiatingUser.id
launchMode
numericId
The query was understood and processed, and the result set (which may be empty) is included in the response.
Required
Specifies the range of items being returned in the result along with the total number of items.
Example: Content-Range: items 5-10/200
This object is returned in response to the query for process instances.
Required
List item type documentation:
This object represents a single process instance returned search result.
Required
This property indicates the ID that is unique to this process instance.
This property indicates the ID of the process definition that was used to create this process instance.
This property holds the dynamic details for this process instance.
This property indicates the timestamp of when the process ended, if it has ended. It will be null if the process has not yet ended.
This property can be null.
This property indicates the user that launched the process instance.
Property type documentation:
This object represents information about a user.
Required
The unique identifier used to reference this configuration object.This property can be null.
This property indicates whether the process was launched in test mode or production mode.
Indicates process instances launched in test mode.
Indicates process instances launched in production mode.
This property indicates the numeric ID that has been assigned to this process instance. The value of this ID is not guaranteed to be unique across all process instances.
This is the name of the process instance. This name is obtained from the process definition.
This is the revision of the process definition that was used to create the process.
This property indicates the timestamp of when the process was started.
This property indicates the numeric value for the current flow status of the process instance.
Property type documentation:
Invalid parameter value was specified; the query criteria was not valid.
Required
A message that describes the current error.The current session is not allowed to use this method: The IPA licensing requirements for this method have not been met.
Required
A message that describes the current error.An unexpected error occurred while processing the request. For example, if the search cannot be completed because of a misconfigured or inaccessible database, this code would be returned.
Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.