Operation: Read Status | X4Documentation

The operation Read Status generates a list of all process IDs or PUIDs and their respective status values that have been updated since a given date. With this, the status of multiple processes can be checked at once, and it is shown which processes have been updated recently. The operation Read Status expects a PID or PUID as input from a process with the operation Log Status. The attribute Status can be used to filter for specific status values.

Input

The adapter expects the following XML structure as input:

XML

<Element>
      <TimestampStart>2023-01-25T08:17:29</TimestampStart>
      <TimestampEnd>2023-01-25T08:17:30</TimestampEnd>
      <PID>1674630745730279865</PID>
      <PUID></PUID>
	  <Status>active</Status>
<Element>

The following elements can be included in the input:

Attribute	Description
`TimestampStart`	Timestamp for process start; set in defined format: `YYYY-MM-DDThh:mm:ss` If only `TimestampStart` is set, all status values from this time are retrieved
`TimestampEnd`	Timestamp for process end; set in defined format: `YYYY-MM-DDThh:mm:ss` If only `TimestampEnd` is set, all status values to this time are retrieved
`PID`	ID of the process for which the status is retrieved
`PUID`	PUID of the process for which the status is retrieved
`Status`	The attribute `Status` attribute filters the result of the `Read Status` operation by a specific status value. If the `Status` attribute is empty, no filter is applied. Possible value: Any string (case-insensitive).

Output

The adapter generates an XML file as output:

XML

<Data>
   <OperationReadStatus>
      <ID>1674630745730279865-0</ID>
      <PID>1674630745730279865</PID>
      <PUID>45F94979-F896-4866-A925-8664F2561E9B</PUID>
      <Timestamp>2023-01-25 08:17:29.280</Timestamp>
      <Status>active</Status>
   </OperationReadStatus>
   <OperationReadStatus>
      <ID>1674630745730279865-1</ID>
      <PID>1674630745730279865</PID>
      <PUID>45F94979-F896-4866-A925-8664F2561E9B</PUID>
      <Timestamp>2023-01-25 08:17:29.437</Timestamp>
      <Status>active</Status>
   </OperationReadStatus>
   <OperationReadStatus>
      <ID>1674630745730279865-2</ID>
      <PID>1674630745730279865</PID>
      <PUID>45F94979-F896-4866-A925-8664F2561E9B</PUID>
      <Timestamp>2023-01-25 08:17:29.513</Timestamp>
      <Status>active</Status>
   </OperationReadStatus>
   <OperationReadStatus>
      <ID>1674630745730279865-3</ID>
      <PID>1674630745730279865</PID>
      <PUID>45F94979-F896-4866-A925-8664F2561E9B</PUID>
      <Timestamp>2023-01-25 08:17:29.580</Timestamp>
      <Status>active</Status>
   </OperationReadStatus>
</Data>

The following elements can be included in the output:

Attribute	Description
`ID`	Status ID
`PID`	ID of the process for which the status is retrieved
`PUID`	PUID of the process for which the status is retrieved
`Timestamp`	Timestamp of status
`Status`	Status related to the process (in the example filtered by the status value active)