StateIdentifier

Description

The StateIdentifier type holds the identification information for a state. The StateIdentifier type parameters are listed below.

Parameters

Name	Type	Description
identifier	Extension. See Identifier.	Generic identification extension base. Holds the displayName, id, and uuid for a state.
internalName	string	Holds the unique internal name of the state. This value is set by SBM Composer and cannot be changed once it has been set and published.
isClosed	boolean	Boolean value to indicate if the state is active or inactive.

Usage

The StateIdentifier is the identifier that can be used in Web service methods to uniquely identify a state. The StateIdentifier contains generic information about a state (including the display name, ID, and UUID), the unique internal name of the state, and the state's active or inactive status.

Note: You can send any one of the elements in the identifier—you do not need to provide values for every element. You only need to provide more than one element in the event that the first element does not uniquely identify the object.

XML

The following XML shows StateIdentifier as seen in a typical call.

<urn:state>
    <urn:displayName>Evaluating Issue</urn:displayName>
    <urn:id>1</urn:id>
    <urn:uuid>985caf28-7a1c-4038-b6e2-c11703b214cd</urn:uuid>
    <urn:internalName>SOFTWARE_ISSUES.EVALUATING_ISSUE</urn:internalName>
    <urn:isClosed>false</urn:isClosed>
</urn:state>