wfm.GetProcessListByObject

This job returns a list of processes that have a specific object in their file.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization

ObjectId

INT

Yes

ID of the object

[UserId]

STRING

No

ID of the user from the organization structure

[AllProcesses]

INT

No

If 1, ended processes are also determined. Otherwise, only running processes are returned. Default: 0.

2. Return Value

(INT): 0 = Job successful, otherwise error code.

3. Output Parameters

Name Type Dependency Description

Processes

BASE64

Information about the requested processes in XML format (see note)

4. Note

Structure of Processes
<Processes>
  <Process
    Id="9E813BD6D4054B6ABD9385A804FEA398"
    Name="test 231"
    Subject="Test (€42)"
    State="2"
    CreatorId="8FDD6BCB06CE467FAE8885E81F078699"
    CreationTime="1077888972"
    ProcessResponsible="0"/>
</Processes>

Process — structure with the following content:

  • Id (STRING): ID of the process

  • Name (STRING): Name of the process

  • State (INT): Status of the process

  • CreatorId (STRING): ID of the process creator

  • CreationTime (INT): Creation time of the process

  • ProcessResponsible (INT): 1 = the requesting user is the process responsible for this process; 0 = otherwise