Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 34 Next »

Overview


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 one or all three fields the ResourceDisplayName, ResourceReferenceSystemId and/or ResourceUid. However, if you do specify all three, they must 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


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

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ResourceDisplayName

String (30)

On Insert: Yes

On Update: Yes (if ResourceReferenceSystemId or ResourceUid is not supplied)


The resource display name is a unique identifier for a resource

John Smith

ResourceId

Int32

On Insert: No

On Update: No


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

177898

ResourceReferenceSystemId

String (20)

On Insert: No

On Update: Yes (if ResourceDisplayName or ResourceUid is not supplied)


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

E1234

ResourceUid

Int64

On Insert: No

On Update: Yes (if ResourceDisplayName or ResourceReferenceSystemId is not supplied)


The resource Uid is a unique and immutable identifier for a resource

1152921504607024874

Usage Example(s)


Example 01 
                           <ResourceIdentityValue>
                              <ResourceDisplayName>John Smith</ResourceDisplayName>
                              <ResourceId>177898</ResourceId>
                              <ResourceReferenceSystemId>Employee 01</ResourceReferenceSystemId>
                              <ResourceUid>1152921504607024874</ResourceUid>
                           </ResourceIdentityValue>
  • No labels