Documentation Center

User 2.5 RetrieveMetaDataByIshUserRefs

This function retrieves the requested metadata for the users matching the filter criteria


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
palUserRefsLongArrayInLong array with the unique identifiers of the users
peActivityFilterActivity FilterInThe enumeration which can be used to limit the result to only the active or inactive objects
psXMLMetaDataFilterStringInMetadataFilter XML structure with additional filter on metadata to limit the objects on which metadata has to be returned
psXMLRequestedMetaDataStringInRequested Metadata XML structure indicating which metadata has to be retrieved for a given object.
psOutXMLObjListStringOutThe User ObjectList XML Structure containing the metadata of the users

Note that:
  • An administrator can use all fields except the PASSWORD field for retrieval and filtering
  • An user without the 'Administrator' role can not use security fields like :
    • FUSERGROUP
    • FISHUSERROLES
    • FISHUSERTYPE
    • FISHOBJECTACTIVE
    • FISHUSERDISABLED
    • ...
  • The order of the returned objects in psOutXMLObjList is random.
For example, we are interested in the properties 'usergroups', 'userroles' of users with reference '4484'.
  1. The metadata filter XML looks like:
    <ishfields>
      <ishfield name='FISHUSERROLES' level='none' ishvaluetype='element' ishoperator='equal'>VUSERROLEADMINISTRATOR</ishfield>
    </ishfields>
  2. The requested metadata XML looks like:
    <ishfields>
      <ishfield name="USERNAME" level="none"/>
      <ishfield name="FISHUSERDISPLAYNAME" level="none"/>
      <ishfield name="FISHEMAIL" level="none"/>
      <ishfield name="FUSERGROUP" level="none"/>
      <ishfield name="FISHUSERROLES" level="none"/>
      <ishfield name="FISHEXTERNALID" level="none"/>
    </ishfields>
  3. The result will look like:
    <ishobjects>
      <ishobject ishref="VUSERELEFEVER" ishtype="ISHUser" ishuserref="4484">
        <ishfields>
          <ishfield name="USERNAME" level="none">elefever</ishfield>
          <ishfield name="FISHUSERDISPLAYNAME" level="none">Erwin Lefever (elefever)</ishfield>
          <ishfield name="FISHEMAIL" level="none">elefever@sdl.com</ishfield>
          <ishfield name="FUSERGROUP" level="none">Default Department, Project team, Sales Marketing, System management</ishfield>
          <ishfield name="FISHUSERROLES" level="none">Administrator</ishfield>
          <ishfield name="FISHEXTERNALID" level="none>GLOBAL\elefever, TRIBE\erwinl</ishfield>
        </ishfields>
      </ishobject>
    </ishobjects>