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 30 Next »

Overview


This structure represents the unique key fields associated with identifying a Resource. Resourcess 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
    • ResourceId: Int32
    • ResourceReferenceSystemId: String
    • ResourceUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ResourceDisplayName

String



The Resource Display Name is a unique identifier for a Resource.

John Smith

ResourceId

Int32



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

177898

ResourceReferenceSystemId

String



The Resource Reference System ID / Employee ID is a unique identifier for a Client.

E1234

ResourceUid

Int64



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