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 creates a subscription for information regarding the current page of a specific work item instance. Use the messaging API to retrieve any message representations that are provided by the server when it is time to show a page, close a page, or indicate that a page command has completed.
Establishing a subscription on this resources will cause Ready for Pages (RFP) to be sent to Process Automation Server. Once both PAS has received the RFP and the interaction used to route the work item instance is in a connected state, PAS may start providing message representations to indicates that a page should be shown or closed, or when a page command has completed.
Only one person can "own" a work item instance at a time, and the owner is the one that has the associated work item interaction picked up. If the user of the current session is not the owner of the work item instance, then this subscription will fail. When PAS receives the subscription for the current page events via this interface (as opposed to via IceLib), PAS knows that the application will want the page definition, data definitions and data values in the JSON formats.
| 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.Required
The ID of the work item instance that identifies this resource.
The watch subscription to events from the indicated page has been created. Expect to receive messages regarding the current page of the indicated work item.
This event message is received when a page command has completed.
This object is returned after Process Automation Server (PAS) has completed the processing of page command. The object is returned regardless of the commandType, regardless of whether there was or was not any data to be saved, and regardless of whether data to be saved was valid or invalid.
Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
Required
This property indicates the ID of the work item instance from which this message was received.
Required
This property contains the same token that was included in the response when the page command was queued. It can be used to correlate this event message to the request that caused the caused the event to occur.
Required
This property is null if the queued page command completed successfully, or is an error object if the page command failed. For translating the error codes, 0 equals unknown error, 1 equals invalid data items, and 2 equals an invalid command ID.
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
A message that describes the current error.This property contains the list of data that was invalid and could not be saved by Process Automation Server (PAS). Data that was valid and successfully saved is not included within this list.
Property type documentation:
This object defines a list of dataReference objects.
This property indicates the fully-scoped ID of the data that is being referenced.
See String Representation of Fully-Scoped GUID for more information about how a fully-scoped GUID is represented as a string.
This event message is received when a new work item page is to be displayed.
This object is received when it is time to show a new page for the work item instance. A work item instance will generally receive one of these messages soon after the subscription for the current page is established, and may receive another one of these messages soon after a Save or Cancel command is sent.
Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
Required
This property indicates the ID of the work item instance from which this message was received.
Required
This property indicates the current Work Item Dynamic Details of the work item instance for which the page is being displayed.
Required
This property indicates the ID of the specific page instance that is being shown as the current page. Each time a command is sent to PAS for the current page, that command request must also include this ID.
This property contains the data values, if any, used for the indicated page. The string value is to be JSON formatted per the IPA Device Independent Work Item Data Value Format.
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.
Required
This property contains the URL where the page definition and data definitions can be found for the current page of this work item instance. The page and data definitions for the specific revision of the specific page definition of the specific process definition are wrapped into a JSON file at this location.
This event message is received when the current work item page is to be closed.
This object is received when Process Automation Server (PAS) is instructing the application to close the work item instance for any reason. The message may be received under a varierty of circumstances ranging from a user pressing a button that caused the work item to end, to Process Automation Server forcing the page to close because the work item is in error, etc..
Note that it is possible for a process to go into error after a work item is picked up but before the first page of the work item is displayed. For example, an error could occur while running an action at the start of a work item, or before showing the first page of the work item. In such cases, the event to close the work item because of a process error will still be received even though an event to show a page was never received.
Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
Required
This property indicates the ID of the work item instance from which this message was received.
This property indicates the reason why the work item page is being closed.
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.The indicated work item instance does not exist.
Required
A message that describes the current error.The watch subscription to events for the current page of the work item instance could not be created. See entity body for details regarding the failure. Perhaps the user does not own the work item, or perhaps another client application has already started watching the work item instance for page pops.
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.IPA License Requirements: An IPA license is not required to call this method.
This method remove the subscription for information regarding the current page of a specified work item instance.
| 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.Required
The ID of the work item instance that identifies this resource.
The watch subscription to events from the indicated page has been removed.
The current session is not allowed to use this method: The current user does not have permission to access the work item.
Required
A message that describes the current error.The watch subscription to events for the indicated page does exist for this session.
Required
A message that describes the current error.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.Required
A message that describes the current error.