pp108 : GetTaskIdentifiers

GetTaskIdentifiers

  


This API fetches task identifiers based on criteria. This method can fetch task identifiers across delivery models in the current organization. This method retrieves all task identifiers in the current organization when criteria was not specified. GetTaskIdentifiers is part of the the Method Set WS Human Task Identifiers Runtime 2.0 in the application package Cordys Notification.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP:Body>
		<GetTaskIdentifiers xmlns="http://schemas.cordys.com/notification/ws-humantask/taskIdentifiers/runtime/2.0">
			<Criteria>
				<Query>
					<Parameters>
						<Parameter>
							<Name>DeliveryModel</Name>
							<Values>
								<Value>002481EC-3647-11E1-F511-D894DE94796F</Value>
							</Values>
						</Parameter>
					</Parameters>
				</Query>
			</Criteria>
			<FetchDuplicateIdentifiers>false</FetchDuplicateIdentifiers>
		</GetTaskIdentifiers>
	</SOAP:Body>
</SOAP:Envelope>

Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

Parameter\NAME

Type of the artifact.

Yes

DeliveryModel

Parameter\Values

It contains the set of values used to search task identifiers.

 Yes  

Parameter\Values\Value

Value element contains the ID of the delivery model.

Yes

 GUID

FetchDuplicateIdentifiers (optional)

To fetch the duplicate task identifiers (if they exist) while searching multiple delivery models.

No
  • true - returns the duplicate task identifiers.
  • false(default) - returns only one task identifier instead of all the duplicate task identifiers.

Sample SOAP Request with criteria

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetTaskIdentifiers xmlns="http://schemas.cordys.com/notification/ws-humantask/taskIdentifiers/runtime/2.0">
            <Criteria>
                <Query>
                    <Parameters>
                        <Parameter>
                            <Name>DeliveryModel</Name>
                            <Values>
                                <Value>002481EC-3647-11E1-F511-D894DE94796F</Value>
                                <Value>005056C0-0008-71DF-A33C-1149ECC68CFB</Value>
                            </Values>
                        </Parameter>
                    </Parameters>
                </Query>
            </Criteria>
            <FetchDuplicateIdentifiers>false</FetchDuplicateIdentifiers>
        </GetTaskIdentifiers>
    </SOAP:Body>
</SOAP:Envelope>

SOAP Response

<GetTaskIdentifiersResponse
    xmlns="http://schemas.cordys.com/notification/ws-humantask/taskIdentifiers/runtime/2.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:emp</XPath>
        <Name>Employee Name</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:salary</XPath>
        <Name>Salary</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:age</XPath>
        <Name>Age</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:bgCheck</XPath>
        <Name>BGCheck</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:joinDate</XPath>
        <Name>JoinDate</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
</GetTaskIdentifiersResponse>

Sample SOAP Request without criteria

<GetTaskIdentifiers xmlns="http://schemas.cordys.com/notification/ws-humantask/taskIdentifiers/runtime/2.0">
    <FetchDuplicateIdentifiers>false</FetchDuplicateIdentifiers>
</GetTaskIdentifiers>

SOAP Response

<GetTaskIdentifiersResponse xmlns="http://schemas.cordys.com/notification/ws-humantask/taskIdentifiers/runtime/2.0">
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:CustomerName</XPath>
        <Name>Customer Name</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:joinDate</XPath>
        <Name>JoinDate</Name>
        <DataType>DATE</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:emp</XPath>
        <Name>Employee Name</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:salary</XPath>
        <Name>Salary</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:age</XPath>
        <Name>Age</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:bgCheck</XPath>
        <Name>BGCheck</Name>
        <DataType>BOOLEAN</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:bgCheck</XPath>
        <Name>BGCheck</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:age</XPath>
        <Name>Age</Name>
        <DataType>INTEGER</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:IncidentId</XPath>
        <Name>IncidentId</Name>
        <DataType>INTEGER</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:salary</XPath>
        <Name>Salary</Name>
        <DataType>FLOAT</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
    <TaskIdentifier>
        <XPath>//proc:forminputdata/proc:freeformcontrols/proc:joinDate</XPath>
        <Name>JoinDate</Name>
        <DataType>STRING</DataType>
        <Namespaces>
            <Namespace>
                <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
                <NamespacePrefix>proc</NamespacePrefix>
            </Namespace>
        </Namespaces>
    </TaskIdentifier>
</GetTaskIdentifiersResponse>

Response Parameters

Parameter

Description

XPath

XPath of the Task Identifier.

Name

Name of the Task Identifier.

DataType

Datatype of the associated Task Identifier. This field contains one of the following values:

  • STRING
  • INTEGER
  • FLOAT
  • DATETIME
  • BOOLEAN

Namespaces

Contains the mapping of the Namespace to namespace prefix of the associated Task Identifier XPath. This element contains multiple Namespace nodes. Each node contains the NamespaceURI and the associated NamespacePrefix as shown below:

<Namespace>
    <NamespaceURI>http://schemas.cordys.com/1.0/xforms/processapi</NamespaceURI>
    <NamespacePrefix>proc</NamespacePrefix>
</Namespace>