Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This structure represents the unique key fields associated with identifying a Resourceresource. Resourcess Resources can be identified by ResourceDisplayName, ResourceReferenceSystemId or ResourceUid. When specifying a PwsResourceRef as an input to a web service, you may specify one or all any combination of the three fields the ResourceDisplayName, ResourceReferenceSystemId and/or ResourceUid. However, if you do specify all threemore than one, they must all refer to the same Resource resource or the Resource resource reference will not be considered valid. When a PwsResourceRef is returned in the response to a web service, the ResourceDisplayName, ResourceReferenceSystemId or ResourceUid will be populated, and guaranteed to refer to a single Resourceresource.

Format


Panel
titlePwsResourceRef
  • PwsResourceRef
    • ResourceDisplayName: String (30)
    • ResourceId: Int32
    • ResourceReferenceSystemId: String (20)
    • ResourceUid: Int64

Elements

...

John E1234

Element

Data Type

Required?Default

Description

Sample Data

ResourceDisplayName

String

Resource Display Name

(30)

One of ResourceDisplayName, ResourceReferenceSystemID or ResourceUid is required

The resource display name is a unique identifier for a resource.

John Smith

ResourceId

Int32Resource ID

No

The resource Id is a unique identifier for a resource. For internal use only.

177898

ResourceReferenceSystemId

String

Resource Reference System ID / Employee ID

(20)

See ResourceDisplayName

The resource reference system Id / employee Id is a unique identifier for a resource.

Employee 01

ResourceUid

Int64

see ResourceDisplayName

A unique and immutable Id identifier for a Resourceresource.

1152921504607024874

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                           <ResourceIdentityValue>
                              <ResourceDisplayName>John Smith</ResourceDisplayName>
                              <ResourceId>177898</ResourceId>
                              <ResourceReferenceSystemId>Employee 01</ResourceReferenceSystemId>
                              <ResourceUid>1152921504607024874</ResourceUid>
                           </ResourceIdentityValue>