GetData: Task and system types

This page documents the data types available in GetData for tasks, system information, configuration, messages, licenses, and functions.

\{internal.function.%%}

\{internal.function.%%}

This will return data against a specific function in the system. Additional data is required for these functions.

\{internal.function.getorganizationid}

This type will return an id of an organization in the system.

CertificateSerialNumber: Example:
\{internal.function.getorganizationid(data=certificateserialnumb er|350000000D697428E75206FB4E00000000000D)}
CertificateThumbprint: Returns the organization id based on a certificate thumbprint (hash/digest). Example:
\{internal.function.getorganizationid(data=certificatethumbprint |6CD3E4663BAC16CF24FE6B3CB7E49C60FACD0AF3)}
TokenSerialNumber: Returns the organization id based on a token serial number. Example:
\{internal.function.getorganizationid(data=tokenserialnumber|112 23344)} TokenSequenceNumber1 Returns the organization id based on the first sequence number of a token. Example:
\{internal.function.getorganizationid(data=tokensequencenumber1| 12345)}
TokenSequenceNumber2: Returns the organization id based on the secondary sequence number of a token. Example:
\{internal.function.getorganizationid(data=tokensequencenumber2| 67890)}
UserSerialNumber: Returns the organization id based on a serial number of a user. Example:
` \{internal.function.getorganizationid(data=userserialnumber|1981 03029999)}`
UserUniqueName: Returns the organization id based on a unique name of a user. Example:
\{internal.function.getorganizationid(data=useruniquename|johdoe @contoso.com)}

\{internal.function.getuserid}

This type will return an id of a user in the system. Additional data is required for these functions.
Example:
{internal.function.getuserid(data=uniquename|johdoe@contoso.com)}
Example:
Example:
{internal.function.getuserid(data=email|john.doe@contoso.com)}
Example:
{internal.function.getuserid(data=AdditionalIdentityUserPrincipalName| johdoe@contoso.com)}

\{internal.license.%%}

\{internal.license.%%}

This will return attributes and types from current license file of the system.

\{internal.license.name}: Returns the name of the license.
\{internal.license.amount}: Returns the current amount of used items of the license.
\{internal.license.amountmax}: Returns the maximum of items available in the license.
\{internal.license.validity}: Returns the validity date when the license will be expired. string if available.
\{internal.license.email}: Returns the email address of the person of the license.

\{internal.system.%%}

\{internal.system.%%}

This will return attributes and types from the system. Note that this types are non-encrypted and can be called outside an login session.

\{internal.system.applicationimage}: Returns a default image of the application as a base64-encoded string if available.
\{internal.system.currentcputype}: Returns the type of CPU running the current process (e.g. x32 or x64).
\{internal.system.cputype}: Returns the type of CPU running the operating system (e.g. x32 or x64).
\{internal.system.date}: Returns current date of the server as ISO 8601 encoded date string.
\{internal.system.time}: Returns current time of the server as ISO 8601 encoded time string.
\{internal.system.timeutc}: Returns the current UTC-time of the server as ISO 8601 encoded time string.
\{internal.system.datetime}: Returns current date and time of the server as ISO 8601 encoded date time string.
\{internal.system.datetimeutc}: Returns current date and UTC-time of the server as ISO 8601 encoded date time string.
\{internal.system.dotnetversion}: Returns current version of the .NET Framework on the server.
\{internal.system.language}: Returns current language of the server.
\{internal.system.osversion}: Returns the version of the operating system. Example: 10.0 (Windows Server 2019 Standard 1809)
\{internal.system.pinpolicy}: Returns a generic configured PIN-policy as XML-encoded string. Usually used for PKI-clients.

\{internal.systemconfiguration.%%}

\{internal.systemconfiguration.%%}

This will return data from the generic configuration of the system.

\{internal.systemconfiguration.genericdata}: This type will return the data specified as generic data in the configuration. Example: {internal.systemconfiguration.genericdata(data=MyData)}

\{internal.systemmessage.%%}

\{internal.systemmessage.%%}

This will return attributes and types from system message items in the data.

\{internal. systemmessage.id}: Returns the unique id of the system message.
{internal. systemmessage.name}: Returns the name of the system message.

\{internal.task.%%}

\{internal.task.%%}

This will return attributes and types from a task. Additional identifier for the task is required for these functions. Example:
{internal.task.organizationid(identifier=1)}

\{internal.task.id}

Returns the unique id of the task.

\{internal.task.organizationid}

Returns the organization id of the task.

\{internal.task.typeid}

Returns the id of task type.

\{internal.task.typename}

Returns the name of the task type.

\{internal.task.typeadditional}

Returns the additional task type if available.

\{internal.task.requestorid}

Returns the id of the requestor of the task.

\{internal.task.processorid}

Returns the id of the processor of the task.

\{internal.task.entityid}

Returns the id of the entity of the task.

\{internal.task.entitytypeid}

Returns the id of the entity type.

\{internal.task.entitytypename}

Returns the name of the entity type. Available types: User, Token, EndEntity and Admin.

\{internal.task.entitydescription}

Returns the description of the entity.

\{internal.task.validfrom}

Returns date and time when the task was created in the system.

\{internal.task.validto}

Returns date and time when the task will be expired.

\{internal.task.processdatetime}

Returns date and time when the task latest was processed.

\{internal.task.processvalidto}

Returns date and time when task process will be expired.

\{internal.task.delegationflags}

Returns the flags for delegation if available.

\{internal.task.statusid}

Returns the id of the status of the task.

\{internal.task.statusname}

Returns the name of the status of the task. Available types:

Ready
Initialized
Processing
Delegated
WaitForExternalProcess
Completed
ViewCompleted
Skipped
Cancelled
Failed
Expired
Rejected

\{internal.task.userid}

Returns the user id of the task.

\{internal.task.additionalinfo}

Returns additional information of the task if available.

\{internal.task.%%}

Except the static types above, all other types will get a field in a task. Example:
{internal.task.tokenserialnumber(identifier=1)}

\{internal.text.%%}

\{internal.text.%%}

This will return attributes and types from the text structure of the system. An identifier of the text is required for loading these data.

\{internal.text.id}: Returns the unique id of the text.
\{internal.text.organizationid}: Returns the organization id of the text.
\{internal.text.language}: Returns the language of the text (e.g. en-US).
\{internal.text.data}: Returns the entire text-blob in XML format.
\{internal.text.additionalinfo}: Returns additional information of the text if available.