ActivityInstID |
- Description:
- The unique ID for an activity instance.
- Type
- string
- Allowed Values:
- A valid activity instance ID.
|
AutoStart |
- Description:
- Specifies if the process
starts immediately after it is created.
- Type
- bool
- Allowed Values:
-
- True - The process instance starts immediately after it is created.
- False - The process instance does not start immediately after it is created.
|
clientData |
- Description:
- Specifies the client data, which identifies a client for AgilePoint
Server.
- Type
- string
- Allowed Values:
- A string that contains the client data.
If this value is
null, the system will keep existing client data. Otherwise the relevant data
is overwritten.
|
CustomAttributes |
- Description:
- Specifies custom attributes in XML format.
- Type
- NameValue
- Allowed Values:
- A valid NameValue pair.
|
Designated |
- Description:
- Gets and sets the flag that determines if the event should
be handled by a designated engine.
- Type
- bool
- Allowed Values:
-
- True - The event is handled by a designated engine.
- False - The event is not handled by a designated engine.
|
Diagnostic |
- Description:
- Gets and sets the flag that determines if the process data
will be deleted from the database after the process is completed.
- Type
- bool
- Allowed Values:
-
- True - The process data is deleted from the database.
- False - The process data is not deleted from the database.
|
EndDate |
- Description:
- Specifies the completion date of delegation.
- Type
- DateTime
- Allowed Values:
- A valid DateTime value.
|
Entries |
- Description:
- Gets the relay time of the event.
- Type
- int
- Allowed Values:
- A valid relay time.
|
Error |
- Description:
- Gets and sets the error message of the event.
- Type
- string
- Allowed Values:
- A valid error message.
|
EventID |
- Description:
- Specifies a unique ID for an event.
- Type
- string
- Allowed Values:
- A unique, 32-character ID.
|
EventName |
- Description:
- Specifies the name of the event.
- Type
- string
- Allowed Values:
- A valid event name.
|
ParamsXml |
- Description:
- Gets and sets the parameters as XML.
- Type
- string
- Allowed Values:
- A parameter.
|
ParentProcInstID |
- Description:
- Specifies parent process instance ID.
- Type
- string
- Allowed Values:
- A valid process instance ID.
|
ProcDefID |
- Description:
- Specifies process template (process definition) ID.
- Type
- string
- Allowed Values:
- A valid process definition ID.
|
ProcInstID |
- Description:
- Specifies the unique ID of a process instance.
- Type
- string
- Allowed Values:
- A valid process instance ID
|
ProcInstName |
- Description:
- A unique process name that is associated with the process
definition.
- Type
- string
- Allowed Values:
- A unique process instance name up to 1024
characters.
|
Sender |
- Description:
- Specifies a sender of the event.
- Type
- string
- Allowed Values:
- A valid user name.
|
SentDate |
- Description:
- Specifies a sent date of the event.
- Type
- DateTime
- Allowed Values:
- A valid DateTime value.
|
SourceWorkItemID |
- Description:
- An ID that represents the original, or source, work
item.
- Type
- string
- Allowed Values:
- A valid, unique 32-character ID.
|
Status |
- Description:
- The status of the event.
- Type
- string
- Allowed Values:
- A valid status.
|
ThrowAwayInstance |
- Description:
- Specifies the flag that determines if AgilePoint server
should clear the process from cache.
- Type
- bool
- Allowed Values:
-
- True - AgilePoint Server clears the process from the cache.
- False - AgilePoint Server does not clear the process from cache.
|
UserID |
- Description:
- Specifies the user ID.
- Type
- string
- Allowed Values:
- A valid user ID.
|
WorkItemID |
- Description:
- An ID that represents a work item (task).
- Type
- string
- Allowed Values:
- A valid, unique 32-byte work item (task) ID.
|
workObjectID |
- Description:
- An ID for an object, such as a document, that is
associated with the process instance.
- Type
- string
- Allowed Values:
- A valid, unique 256-character ID.
Even though
the field size is 256 characters, in common practice,
this will usually return a 32-character GUID.
|
