/icws/{sessionId}/ipa/workitem-instances/{workItemInstanceId}/current-page

POST

/icws/{sessionId}/ipa/workitem-instances/{workItemInstanceId}/current-page

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 sends a page command (Submit, Cancel, Hold, Save) to Process Automation Server (PAS) for the current page of the specified IPA Work Item instance. The Submit and Cancel commands correspond to buttons defined on the work item page, and can only be sent for pages that have defined those specific buttons. Each page must have at least one Submit or Cancel button, but may have more than one Submit and/or more than one Cancel button. The Hold and Save commands can be sent for all work item page instances.

Feature Version
ipa 1

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Template
        workItemInstanceId

        Required

        The ID of the work item instance that identifies this resource.

          Representations
          sendPageCommandParameters

          This object is used to send a page command to Process Automation Server (PAS) for the current page of a work item instance. The commandType must be specified. The other properties may or may not be specified based on that commandType.

          Property
          Value
          Comments
          pageInstanceId
          String

          Required

          This is the ID of the specific page instance that the client believes is the current page for the work item instance. Any time the client sends a page command to PAS, it must included this ID which allows PAS to ensure that both PAS and the client agree on what they believe is the current page for this work item instance.

          submit
          1
          cancel
          2
          save
          3
          hold
          4
          commandId
          String

          If the commandType indicates that a submit or cancel page command is being sent, then this property indicates the command ID associated with the button that was pressed on the work item page.

          __type
          "urn:inin.com:ipa:runtimeDataValuesListMeta"

          Required

          The JSON type representing this option.
          payloadType
          String

          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.

          formatVersion
          String

          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.

          Multiple options:

          The value can be assigned any of the following options.
          __type
          "urn:inin.com:ipa:booleanDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:booleanDataInstCollItem"

          Required

          The JSON type representing this option.
          id
          String

          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.

          val
          Boolean

          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.

          __type
          "urn:inin.com:ipa:booleanDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          Boolean

          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.

          __type
          "urn:inin.com:ipa:complexDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:complexDataInstCollItem"

          Required

          The JSON type representing this option.
          id
          String

          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.

          uniqueId
          String

          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.

          Multiple options:

          The value can be assigned any of the following options.
          __type
          "urn:inin.com:ipa:booleanPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:booleanPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          Boolean

          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.

          __type
          "urn:inin.com:ipa:complexPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          items
          List [Unbounded]: Multiple Options: basePropVal

          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.

          __type
          "urn:inin.com:ipa:complexPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          Complex Type: complexValue

          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.

          __type
          "urn:inin.com:ipa:currencyPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:currencyDataInstCollItem"

          Required

          The JSON type representing this option.
          id
          String

          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.

          amount
          String

          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.

          code
          String

          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.

          __type
          "urn:inin.com:ipa:currencyPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:datePropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:stringDataInstCollItem"

          Required

          The JSON type representing this option.
          id
          String

          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.

          val
          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.

          __type
          "urn:inin.com:ipa:datePropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:dateTimePropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:dateTimePropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:decimalPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:decimalPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:durationPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:durationPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:longPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:longPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:mailboxPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:mailboxDataInstCollItem"

          Required

          The JSON type representing this option.
          id
          String

          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.

          val
          String

          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.

          type
          String

          Required

          This field contains a string representation of the mailbox type. Possible values are show below.

          • SMTP
          • OTHER

          See String Representation of Mailbox Values for more information about how a mailbox value is represented.

          __type
          "urn:inin.com:ipa:mailboxPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:skillPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:skillPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:stringPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:stringPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:timePropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:timePropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:uriPropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:uriPropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:userQueuePropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:userQueueDataInstCollItem"

          Required

          The JSON type representing this option.
          id
          String

          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.

          val
          String

          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.

          displayName
          String

          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.

          __type
          "urn:inin.com:ipa:userQueuePropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:workgroupQueuePropValColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          __type
          "urn:inin.com:ipa:workgroupQueuePropValSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          name
          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:complexDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:currencyDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:currencyDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:dateDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:dateDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:dateTimeDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:dateTimeDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:decimalDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:decimalDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:durationDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:durationDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:longDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:longDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:mailboxDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:mailboxDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:skillDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:skillDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:stringDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:stringDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:timeDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:timeDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:uriDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:uriDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          __type
          "urn:inin.com:ipa:userQueueDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:userQueueDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:workgroupQueueDataInstColl"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          __type
          "urn:inin.com:ipa:workgroupQueueDataInstSing"

          Required

          The JSON type representing this option.
          defId
          String

          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.

          id
          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.

          name
          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.

          security
          String

          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.

          val
          String

          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.

          sourceId
          String

          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.

          destinationId
          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.

          items
          List [Unbounded]: 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.

          Response

          202 - Accepted

          The command has been successfully queued by Process Automation Server (PAS), and a requestId token has been assigned to that request. See the associated command completed message that occurs after the command has been processed by PAS, regardless of the command type (Submit, Cancel, Hold, Save).

          sendPageCommandResults

          This object is returned in response to sending a page command, after that page command has been successfully queued by Process Automation Server (PAS).

          Property
          Value
          Comments
          requestId
          String

          Required

          The ID associated with the asynchronous operation request. This can be used to correlate future events and operations.

          Associated Message

          After PAS has processed the queued command, expect the command results to be returned as an event message via the current-page subscription for this same work item instance.

          currentPageSubscriptionCommandCompleteEventArgs

          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.

          Property
          Value
          Comments
          __type
          "urn:inin.com:ipa:currentPageSubscriptionCommandCompleteEventArgs"

          Required

          The JSON type representing this option.
          isDelta
          Boolean

          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.

          workItemInstanceId
          String

          Required

          This property indicates the ID of the work item instance from which this message was received.

          requestId
          String

          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.

          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          dataId
          String

          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.

          400 - Bad Request

          The request was not formatted correctly.

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          401 - Unauthorized

          Invalid session token in request.

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          403 - Forbidden

          The current session is not allowed to use this method:

          • The IPA licensing requirements for this method have not been met.
          • The current user does not have permission to access the work item.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          404 - Not Found

          The indicated work item instance does not exist.

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          500 - Internal Server Error

          Process Automation Server (PAS) was not able to process the request. There could be any number of reasons: maybe a command ID or data ID was invalid; maybe data values were not in the correct format; maybe the command was sent when PAS was not expecting it; etc.

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          410 - Gone
          This resource has been deprecated and removed from the API.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.