Versions Compared

Version Old Version 22 New Version Current
Changes made by

Bettina Borces

Luke Wright

Saved on

Key

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

...

This structure represents the unique key fields associated with identifying a resource. Resources can be identified by ResourceDisplayName, ResourceReferenceSystemId or ResourceUid. When specifying a PwsResourceRef as an input to a web service, you may specify any combination of the three fields. However, if you do specify more than one, they must all refer to the same resource or the 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 resource.

Format


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

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ResourceDisplayName

String

 

 

Resource Display Name

John

(30)

One of ResourceDisplayName, ResourceReferenceSystemID or ResourceUid is required

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

John Smith

ResourceId

Int32

 

 

Resource ID

No

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

177898

ResourceReferenceSystemId

String (20)

 

 

Resource Reference System ID / Employee ID

E1234

See ResourceDisplayName

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

Employee 01

ResourceUid

Int64

 

 

Resource Unique Id, a

see ResourceDisplayName

A unique and immutable identifier for a

Resource

resource.

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>