EnumerateOp

This operation returns an enumeration context, which you can then use with the PullOp operation to get batches of incidents from the service. You can specify a filter, so that the enumeration context contains only specific incidents.

Input

SOAP Body

Element Enumerate of type wsen:Enumerate. This element can contain the following subelements:

• Optional element wsen:Expires of type wsen:ExpirationType.

  Contains a duration, for which the client requires the enumeration context. If you omit this subelement, the service uses the value of the EnumerationExpiration parameter on the management server. If you specify a duration that exceeds the value of the EnumerationExpirationMaximum parameter, the service uses the value of SubscriptionExpirationMaximum instead. (See Service Configuration.)

• Optional element wsen:Filter of type wsen:FilterType or wsman:Filter of type wsman:dialectableMixedDataType. For compatibility with different toolkits, the service supports a filter of either type, but you must specify only one of them.

  Filter attribute Dialect must have the following value:

  http://schemas.hp.com/opr/ws/ServiceOperation/IncidentManagement/1/IncidentFilter

  Filter must contain the subelement incFil:IncidentEnumerationFilter of type incFil:IncidentEnumerationFilter. IncidentEnumerationFilter can contain any of the following subelements:

  • Optional element incFil:Severity of type inc:Severity_OpenType
  • Optional element incFil:EmittingNode of type incFil:EmittingNode
  • Optional element incFil:Category of type xs:string
  • Optional element incFil:Application of type xs:string
  • Optional element incFil:Object of type xs:string
  • Optional element incFil:EmittingCI of type incFil:EmittingCI
  • Optional element incFil:CorrelationKey of type xs:string
  • Optional element incFil:EscalationStatus of type xs:string
  • Optional element incFil:ConditionMatched of type xs:boolean
  • Optional element incFil:ReceivedTime of type incFil:TimeFilter
  • Optional element incFil:Title of type incFil:KeywordFilter
  • Optional element incFil:CustomAttributes of type incFil:CustomAttributes

    The service enumerates incidents that match the contents of the incFil:IncidentEnumerationFilter subelements that you specify. For more details on incident attributes, see Incident to Message Mappings.

    If you omit Filter, the service enumerates all incidents that have the status open or work in progress.

SOAP Header

• Element wsa:Action of type wsa:ActionType that contains the following string:

  http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerate

• Element wsman:ResourceURI of type wsman:AttributableURI

  Contains a string that identifies the resource type. You can use the element wsa:ReferenceParameters/wsman:ResourceURI from an element of type wsa:EndPointReferenceType.

  Alternatively, create a wsman:ResourceURI element that contains the following string:

  http://schemas.hp.com/ism/ServiceOperation/IncidentManagement/1/Incident

• Optional element wsman:OperationTimeout of type wsman:AttributableDuration

  Contains a maximum duration within which you expect the service to respond. On an HPOM for UNIX management server, the service returns a TimedOut fault if it cannot respond in time.

For an example, see Enumerate Request SOAP Envelope Example.

Output

The SOAP body contains an element wsen:EnumerateResponse (of anonymous type), which contains the following subelements:

• Element wsen:Expires of type wsen:ExpirationType.

  Contains a duration, for which the enumeration context is valid. You can use the ReleaseOp operation to cancel the enumeration context early. (See ReleaseOp.)

• Element wsen:EnumerationContext of type wsen:EnumerationContextType.

  Contains a string that identifies the enumeration context. Use wsen:EnumerationContext with the PullOp operation to get batches of incidents from the service. (See PullOp.)

For an example, see Enumerate Response SOAP Envelope Example.

Fault

If it cannot return the enumeration context, the service returns a fault according to the WS-Management standard.