# CaseType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Supertype: AssignmentHolderType
TODO

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property PolyStringType | [0,1] | Human-readable, mutable name of the object.
description | property string | [0,1] | Free-form textual description of the object.
documentation | property string | [0,1] | AsciiDoc-formatted technical documentation of the object.
subtype | property string | [0,-1] | Type of the object.
fetchResult | property OperationResultType | [0,1] | Result of the operation that fetched this instance of the object.
extension | container ExtensionType | [0,1] | Extension container that provides generic extensibility mechanism.
parentOrgRef | reference ObjectReferenceType | [0,-1] | Set of the orgs (organizational units, projects, teams) that the object relates to.
trigger | container TriggerType | [0,-1] | Triggers for this object.
metadata | container MetadataType | [0,1] | Meta-data about object creation, modification, etc.
tenantRef | reference ObjectReferenceType | [0,1] | Reference to the tenant to which this object belongs.
lifecycleState | property string | [0,1] | Lifecycle state of the object.
operationExecution | container OperationExecutionType | [0,-1] | Description of recent operations executed on this object (or related objects in special cases).
lensContext | container LensContextType | [0,1] | Model context describing executed operation
policySituation | property anyURI | [0,-1] | The policy situation(s) of this object.
triggeredPolicyRule | property EvaluatedPolicyRuleType | [0,-1] | Triggered policy rules for this object.
policyException | container PolicyExceptionType | [0,-1] | Recorded exception from a policy rule.
diagnosticInformation | property DiagnosticInformationType | [0,-1] | Diagnostic information attached to this object.
indestructible | property boolean | [0,1] | Protection against accidental deletion.
effectiveMarkRef | reference ObjectReferenceType | [0,-1] | Object marks assigned to the shadow.
policyStatement | container PolicyStatementType | [0,-1] | Policy statements to manually add or exclude effective marks of shadow.
effectiveOperationPolicy | container ObjectOperationPolicyType | [0,1] | Effective provisioning policy derived from Shadow marks and resource configuration.
assignment | container AssignmentType | [0,-1] | Set of object's assignments.
iteration | property int | [0,1] | Iteration number.
iterationToken | property string | [0,1] | Iteration token.
archetypeRef | reference ObjectReferenceType | [0,-1] | References to all applicable archetypes, including "indirect" archetypes such as archetype supertypes.
roleMembershipRef | reference ObjectReferenceType | [0,-1] | References to abstract roles (roles, orgs, services) that this focus currently belongs to - directly or indirectly.
delegatedRef | reference ObjectReferenceType | [0,-1] | References to objects (abstract roles as well as users) obtained via delegation.
roleInfluenceRef | reference ObjectReferenceType | [0,-1] | References to abstract roles (roles and orgs) that this focus may directly belong to.
parentRef | reference ObjectReferenceType | [0,1] | Parent case, if any.
objectRef | reference ObjectReferenceType | [0,1] | Object that the case is associated with.
targetRef | reference ObjectReferenceType | [0,1] | Target that the case is associated with.
requestorRef | reference ObjectReferenceType | [0,1] | User who requested the respective operation was carried out.
state | property anyURI | [0,1] | State of this case.
outcome | property anyURI | [0,1] | Outcome of the case.
closeTimestamp | property dateTime | [0,1] | When was this case closed? (Note that the creation timestamp is present in the object metadata.
event | container CaseEventType | [0,-1] | Events that occurred during lifetime of this process instance.
workItem | container CaseWorkItemType | [0,-1] | TODO
approvalContext | container ApprovalContextType | [0,1] | Approval context for approval cases.
manualProvisioningContext | container ManualProvisioningContextType | [0,1] | Information related to manual resource provisioning request that is to be executed.
correlationContext | container CaseCorrelationContextType | [0,1] | Information related to correlation request that is to be resolved.
taskRef | reference ObjectReferenceType | [0,1] | Reference to the task holding workflow context for wf-related cases.
stageNumber | property int | [0,1] | Stage number - if process can be conceptually divided into stages.
prerequisiteRef | reference ObjectReferenceType | [0,-1] | Cases that must be completed before this one can be.
modelContext | container LensContextType | [0,1] | Model context describing the operation that is related to this case.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Human-readable, mutable name of the object. It may also be an identifier (login name, group name). It is usually unique in the respective context of interpretation. E.g. the name of the UserType subtype is usually unique in the whole system. The name of the ShadowType subtype is usually unique in the scope of resource (target system) that it belongs to.

    The name may not be human-readable in a sense to display to a common end-user. It is intended to be displayed to IDM system administrator. Therefore it may contain quite a "ugly" structures such as LDAP DN or URL.

    Name is mutable. It is considered to be ordinary property of the object. Therefore it can be changed by invoking usual modifyObject operations. However, change of the name may have side effects (rename process).

    Although name is specified as optional by this schema, it is in fact mandatory for most object types. The reason for specifying the name as optional is that the name may be generated by the system instead of supplied by the clients. However, all objects stored in the repository must have a name.

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Free-form textual description of the object. This is meant to be displayed in the user interface.

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    AsciiDoc-formatted technical documentation of the object.

  - #### subtype

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Type of the object. It is used to distinguish what a specific object represents. Whether it is a different kind of organizational unit, project, team, or different kind of user, etc.

  - #### fetchResult

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Result of the operation that fetched this instance of the object. It is mostly used to indicate that the object is not complete or there is some problem with the object. This is used instead of exception if the object is part of larger structures (lists as in list/search operations or composite objects). If not present then the "SUCCESS" state is assumed.

    This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

  - #### extension

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Extension container that provides generic extensibility mechanism. Almost any extension property can be placed in this container. This mechanism is used to extend objects with new properties. The extension is treated exactly the same as other object properties by the code (storage, modifications, etc), except that the system may not be able to understand their meaning.

  - #### parentOrgRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    Set of the orgs (organizational units, projects, teams) that the object relates to. This usually means that the object belongs to them but it may have other meanings as well (e.g. user manages an organizational unit).

  - #### trigger

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Triggers for this object. They drive invocations of corresponding trigger handlers at specified time.

  - #### metadata

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Meta-data about object creation, modification, etc.

  - #### tenantRef

    Flags: RAM,oper

    Multiplicity: [0,1]

    Reference to the tenant to which this object belongs. It is a computed value set automatically by midPoint. It is determined from the organizational structure. Even though this value is computed it is also stored in the repository due to performance reasons.

  - #### lifecycleState

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Lifecycle state of the object. This property defines whether the object represents a draft, proposed definition, whether it is active, deprecated, archived, and so on. See "Object Lifecycle" in the documentation.

  - #### operationExecution

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Description of recent operations executed on this object (or related objects in special cases). The number of operations to be kept here is configurable.

  - #### lensContext

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Model context describing executed operation

  - #### policySituation

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    The policy situation(s) of this object. The situations are result of evaluation of the policy rules. This property is recorded for each object and can be used for reporting, diagnostics, target selection in certification campaigns, etc.

  - #### triggeredPolicyRule

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Triggered policy rules for this object. (Not necessarily complete; subject to specified storage strategy.) This is EXPERIMENTAL functionality. It is possibly to change in the near future.

  - #### policyException

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Recorded exception from a policy rule. The exceptions that are approved are recoded here to avoid re-evaluating and re-approving them all the time. This is EXPERIMENTAL functionality. It is likely to change in the near future.

  - #### diagnosticInformation

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Diagnostic information attached to this object.

  - #### indestructible

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Protection against accidental deletion. If set to true then this object cannot be deleted. If the object needs to be deleted then it has to be modified first to reset this flag.

  - #### effectiveMarkRef

    Flags: RAM

    Multiplicity: [0,-1]

    Object marks assigned to the shadow.

  - #### policyStatement

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Policy statements to manually add or exclude effective marks of shadow.

  - #### effectiveOperationPolicy

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Effective provisioning policy derived from Shadow marks and resource configuration.

  - #### assignment

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Set of object's assignments. Assignments define the privileges and "features" that this object should have, that this object is entitled to. Typical assignment will point to a role or define a construction of an account.

    Assignments represent what the object SHOULD HAVE. The assignments represent a policy, a desired state of things (cf. linkRef, roleMembershipRef).

  - #### iteration

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Iteration number. Starts with 0. It is used to iteratively find unique identifier for the object.

  - #### iterationToken

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Iteration token. String value that is usually a suffix to the identifier based on iteration number. E.g. ".007". It is used to iteratively find unique identifier for the object.

  - #### archetypeRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    References to all applicable archetypes, including "indirect" archetypes such as archetype supertypes. Contains references to active archetypes only.

    Note: the value of this reference is only updated when object is recomputed. Therefore if a role definition changes then all the affected objects must be recomputed for this reference to be consistent.

    This is an operational property. It is set and managed by the system. It is used for efficient use of archetypes.

  - #### roleMembershipRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    References to abstract roles (roles, orgs, services) that this focus currently belongs to - directly or indirectly. This reference points to all the roles in the role hierarchy. It only points to the roles that were evaluated as active during last recompute (conditions were true, validity constraints not violated).

    Note: the value of this reference is only updated when a focal object is recomputed. Therefore if a role definition changes then all the affected focal objects must be recomputed for this reference to be consistent.

    Roles mentioned here are those that are NOT obtained via delegation, i.e. "deputy" relations. Relations acquired by delegation are listed in delegatedRef item.

    This is an operational property. It is set and managed by the system. It is used for efficient search of all current role members, e.g. for the purpose of displaying this information in the GUI.

    Note: roleMembershipRef will be probably renamed to something like linkRef or outboundLinkRef. We need to generalize it to contain information on generic links between objects (e.g. between child and its parents).

  - #### delegatedRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    References to objects (abstract roles as well as users) obtained via delegation. If A1 is a deputy of A, its delegatedRef contains a union of A, A.roleMembershipRef and A.delegatedRef.

    This is an operational property. It is set and managed by the system. It is used for efficient search of all current role members, e.g. for the purpose of displaying this information in the GUI.

  - #### roleInfluenceRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    References to abstract roles (roles and orgs) that this focus may directly belong to. This reference only points to the next role in the hierarchy. However, it is backed by a "closure" index in the repository subsystem. Therefore it can efficiently support tree-like queries. This reference points to the roles for whose the condition is not true. Therefore it does not reliably show who actually has a role. It shows potential role members - all the object that are possibly influenced when a role definition changes.

    This is an operational property. It is set and managed by the system. It is used for efficient search of all possible role members, e.g. for the purpose of recomputing all role members after the role definition is changed.

    TODO. NOT IMPLEMENTED YET. EXPERIMENTAL. UNSTABLE.

  - #### parentRef

    Flags: RAM

    Multiplicity: [0,1]

    Parent case, if any.

  - #### objectRef

    Flags: RAM,composite

    Multiplicity: [0,1]

    Object that the case is associated with. For approval cases this is usually the object whose modification (or addition, or deletion) is being approved. For manual provisioning cases this might be the resource on which an account is to be created. For correlation cases this is the (full) shadow that is being correlated. EXPERIMENTAL. May change in future.

  - #### targetRef

    Flags: RAM,composite

    Multiplicity: [0,1]

    Target that the case is associated with. For approval cases related to assignments this may be the assignment target. For approval cases related to associations this may be the associated shadow (e.g. the entitlement). For manual provisioning cases this might be the shadow, if the case deals with the creation of an account on the resource. For correlation cases this is the resource from which the shadow to be correlated originates. EXPERIMENTAL. May change in future.

  - #### requestorRef

    Flags: RAM

    Multiplicity: [0,1]

    User who requested the respective operation was carried out.

  - #### state

    Flags: RAM,runtime

    Multiplicity: [0,1]

    State of this case. Built-in states are:

    - created: The case was created but it is not yet open. E.g. there should be no work items.
    - open: The case is open - work items are created, completed, delegated, etc. Associated work is being carried out.
    - closing: All human interaction regarding the case is over. But there might be some actions pending, e.g. submitting change execution task, waiting for subtasks to be closed, and so on.
    - executing: The case now proceeds by means of automated execution of defined actions (e.g. approved changes); or waiting for the execution to start.
    - closed: The case is closed. No further actions nor changes are expected.
    Not all states are relevant for all cases. For example, manual resource cases do not use "executing" state. URIs can be qualified or unqualified.

  - #### outcome

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Outcome of the case. For approval cases, typical outcomes are approve, reject, skip (qualified with namespace of "http://midpoint.evolveum.com/xml/ns/public/model/approval/outcome" or unqualified). For manual resource cases, possible outcomes are - in addition to the above - OperationResultStatusType string representations: success, fatal_error, not_applicable, and so on. These values are always not qualified. This will be probably reconsidered in the future.

  - #### closeTimestamp

    Flags: RAM,runtime

    Multiplicity: [0,1]

    When was this case closed? (Note that the creation timestamp is present in the object metadata.)

  - #### event

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Events that occurred during lifetime of this process instance.

  - #### workItem

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    TODO

  - #### approvalContext

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Approval context for approval cases.

  - #### manualProvisioningContext

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Information related to manual resource provisioning request that is to be executed.

  - #### correlationContext

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Information related to correlation request that is to be resolved.

  - #### taskRef

    Flags: RAM

    Multiplicity: [0,1]

    Reference to the task holding workflow context for wf-related cases. DEPRECATED. Not used any more. The relation is defined the other way: task.objectRef points to this case.

  - #### stageNumber

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Stage number - if process can be conceptually divided into stages. Starts at 1. Null if not applicable. Zero if the first stage hasn't been opened.

  - #### prerequisiteRef

    Flags: RAM

    Multiplicity: [0,-1]

    Cases that must be completed before this one can be. For example, if case A requests object creation and case B its modification, then A is a prerequisite for B.

  - #### modelContext

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Model context describing the operation that is related to this case. (E.g. for approvals it is the operation that should continue after approval is made.)