Share via


Approval

Represents a FIM approval.

Schema

<?xml version="1.0"?><xs:schema xmlns:rm="https://schemas.microsoft.com/2006/11/ResourceManagement" targetNamespace="https://schemas.microsoft.com/2006/11/ResourceManagement" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="Approval">
    <xs:sequence>
      <xs:element minOccurs="0" name="ObjectID" type="rm:ReferenceType" />
      <xs:element minOccurs="1" name="ObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="CreatedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Creator" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="MVObjectID">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DeletedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Description">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DetectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="DisplayName">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ExpectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="ExpirationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Locale">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ResourceTime" type="xs:dateTime" />
      <xs:element minOccurs="1" name="ApprovalDuration" type="xs:dateTime" />
      <xs:element minOccurs="1" name="ApprovalStatus">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="^(Pending|Approved|Rejected|Expired)$" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ApprovalResponse" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="1" name="ApprovalThreshold" type="xs:integer" />
      <xs:element minOccurs="0" name="Approver" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="ComputedActor" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="EndpointAddress" type="rm:StringCollectionType" />
      <xs:element minOccurs="0" name="Request" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="Requestor" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="WorkflowInstance" type="rm:ReferenceType" />
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Properties

The following table lists the properties of the Approval object:

Property Description

ApprovalDuration

Optional DateTime property. Indicates the duration of the workflow. When the time in duration is reached after being submitted, the approval is escalated. The second time the duration is reached the approval will timeout and be set to denied. If there is no escalation defined in the approval, the approval will timeout after duration is reached the first time.

ApprovalResponse

Optional multi-valued Reference property that represents a list of references to each ApprovalResponse resource that is associated with this approval.

ApprovalStatus

Optional property. String that represents status of the approval. See ApprovalStatus Property table for a list of valid values. The maximum length of the string is 448 characters.

ApprovalThreshold

Optional Integer property. Indicates how many approvals are required before the approval object is complete.

Approver

Optional multi-valued Reference property that defines valid approvers. The reference will be resolved by the approval activity to only reference Person resources.

ComputedActor

Optional multi-valued reference property that is populated by the FIM Service. This property is used to set up permissions.

EndpointAddress

Optional multi-valued string property. Each instance of this element indicates an endpoint addresses that the workflow instance is listening to.

Request

Optional property. Reference to the Request associated with the given Approval.

Requestor

Optional property. Reference to the creator of the Request associated with the Approval.

WorkflowInstance

Optional property. Reference to a WorkflowInstance that started the approval workflow that created this approval object.

ApprovalStatus Property

Value Description

Pending

Indicates the approval is still pending because some approvers have not yet responded.

Approved

Indicates that the Approval is complete. If the “Threshold” property is set to an integer value X, this means that at least X approvals have been received.

Rejected

Indicates that one or more approvers rejected the approval.

Expired

Indicates that the necessary approvals were not received by the time specified by the “ApprovalDuration” value.

Parent Elements

None

Remarks

All of the resource types in FIM have the same attribute bindings as the Resource type by default. For more information, see Forefront Identity Manager Schema.

See Also

Reference

ApprovalActivity

Concepts

How to: Retrieve the FIM Service Schema Using WS-MetadataExchange
Schema Data Types

Other Resources

Forefront Identity Manager Schema