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 8
Next »
Overview
This structure contains the complete set of information about a resource. The structure is used both to retrieve detailed resource information and to pass information about a resource back to the server to get updated.
- PwsResourceDetail
- ResourceDisplayName: String (30)
- ResourceId: Int32
- ResourceReferenceSystemId: String (20)
- ResourceUid: Int64
- EmailAddress: String (100)
- FirstName: String (20)
- LastName: String (20)
- MiddleName: String (20)
- InactiveFlag: Boolean
- ExpenseApprovalUserIdentity: PwsUserRef
- ExpenseEntryDelegateUserIdentity: PwsUserRef
- Initials: String (10)
- LatestHistoryRecord: PwsResourceHistoryRecord
- LatestHistoryRecordBeginDate: DateTime
- ManagerUserIdentity: PwsUserRef
- RequestedTimeOffApprovalUserIdentity: PwsUserRef
- SkillApprovalUserIdentity: PwsUserRef
- TimeEntryDelegateUserIdentity: PwsUserRef
- TimecardApprovalFlag: Boolean
- TimecardApprovalUserIdentity: PwsUserRef
- UserDefinedFields: PwsUserDefinedFieldDetail[]
- UserIdentity: PwsUserRef
- VendorReferenceSystemId: String (50)
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| ResourceDisplayName | String (30) | On Insert: Yes On Update: One of ResourceDisplayName, ResourceReferenceSystemId or ResourceUid is required |
| The resource's display name is a unique identifier for a resource. | Web Services |
| ResourceId | Int32 | No |
| The resource id is a unique identifier for a resource. For internal use only. |
|
| ResourceReferenceSystemId | String (20) | On Insert: Yes On Update: See ResourceDisplayName |
| The resource's reference system id is a unique identifier for a resource. Note this service cannot update the resource reference system id. Use PwsSaveUser to update the user reference system id, and the resource reference system id will be updated as well. When updating an existing resource, if you specify a non-null value for this field that does not match the existing value, the request will fail. | WS01 |
| ResourceUid | Int64 | On Insert: Yes On Update: See ResourceDisplayName |
| A unique and immutable Id for a resource | 1152921504607131538 |
EmailAddress | String (100) | On Insert: Yes On Update: No |
| The resource's email address. | webservices@revcorp.bb |
FirstName | String (20) | On Insert: Yes On Update: No |
| The resource's first name. | Web |
LastName | String (20) | On Insert: Yes On Update: No |
| The resource's last name. | Services |
MiddleName | String (20) | On Insert: No On Update: No |
| The resource's middle name. |
|
InactiveFlag | Boolean | No | false | If set to 'true', this resource has been defined as inactive. | false |
ExpenseApprovalUserIdentity | PwsUserRef | No |
| The identity of the user who approves this resource's expenses. |
|
ExpenseEntryDelegateUserIdentity | PwsUserRef | No |
| The identity of the user who can enter expenses on behalf of this resource. |
|
Initials | String (10) | No |
| The resource's initials. | WS |
LatestHistoryRecord | PwsResourceHistoryRecord | No |
| The resource's latest history record. |
|
LatestHistoryRecordBeginDate | DateTime | No |
| The begin date of the resource's latest history record. | 2018-10-01T00:00:00Z |
ManagerUserIdentity | PwsUserRef | On Insert: Yes On Update: No |
| The identity of the resource's manager. |
|
RequestedTimeOffApprovalUserIdentity | PwsUserRef | No |
| The identity of the user who approves this resource's requested time off. |
|
SkillApprovalUserIdentity | PwsUserRef | No |
| The identity of the user who approves this resource's skill levels. |
|
TimeEntryDelegateUserIdentity | PwsUserRef | No |
| The identity of the user who can enter time on behalf of this resource. |
|
TimecardApprovalFlag | Boolean | No |
| If set to 'true', this resource is allowed to approve his/her own time. | true |
TimecardApprovalUserIdentity | PwsUserRef | No |
| The identity of the user who approves this resource's time. |
|
UserDefinedFields | PwsUserDefinedFieldDetail[] | No |
| The user defined fields associated with this resource record. |
|
UserIdentity | PwsUserRef | On Insert: Yes On Update: No |
| The user identity associated with this resource record. |
|
VendorReferenceSystemId | String | On Insert: Yes On Update: No |
| The vendor reference system id of the vendor associated with this resource record. | Web Services |
Usage Example(s)
<b:ResourceDetail>
<b:ResourceDisplayName>Web Services</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>WS01</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607131538</b:ResourceUid>
<b:EmailAddress>webservices@revcorp.bb</b:EmailAddress>
<b:FirstName>Web</b:FirstName>
<b:LastName>Services</b:LastName>
<b:MiddleName i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ExpenseApprovalUserIdentity>
<b:UserDisplayName>IT Manager</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
<b:UserUid>1152921504607134366</b:UserUid>
</b:ExpenseApprovalUserIdentity>
<b:ExpenseEntryDelegateUserIdentity i:nil="true"/>
<b:Initials>WS</b:Initials>
<b:LatestHistoryRecord>
<b:ActualHolidaysFlag>true</b:ActualHolidaysFlag>
<b:AllowApproveOwnTimecardsFlag>true</b:AllowApproveOwnTimecardsFlag>
<b:BillableFlag>true</b:BillableFlag>
<b:CostCenterIdentity>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>Executive Team (USA)</b:CostCenterName>
<b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
<b:CostCenterUid>1152921504606867363</b:CostCenterUid>
</b:CostCenterIdentity>
<b:ExpenseReportVendorIdentity i:nil="true"/>
<b:InactiveFlag>false</b:InactiveFlag>
<b:LocationIdentity>
<b:LocationId i:nil="true"/>
<b:LocationName>USA</b:LocationName>
<b:LocationUid>1152921504606855985</b:LocationUid>
</b:LocationIdentity>
<b:MissingTimeEmailFlag>true</b:MissingTimeEmailFlag>
<b:PayCategory>S</b:PayCategory>
<b:RdcException>
<b:CurrencyIdentity>
<b:CurrencyCode>USD</b:CurrencyCode>
<b:CurrencyId i:nil="true"/>
<b:CurrencyUid>1152921504606851838</b:CurrencyUid>
</b:CurrencyIdentity>
<b:HourlyRate>50</b:HourlyRate>
</b:RdcException>
<b:ResourceTypeIdentity>
<b:ResourceTypeCode>FTE</b:ResourceTypeCode>
<b:ResourceTypeId i:nil="true"/>
<b:ResourceTypeName>Full Time Employee</b:ResourceTypeName>
<b:ResourceTypeUid>1152921504606847348</b:ResourceTypeUid>
</b:ResourceTypeIdentity>
<b:ScheduledHolidaysFlag>true</b:ScheduledHolidaysFlag>
<b:SubcontractorInvoiceVendorIdentity i:nil="true"/>
<b:TemporaryWorkerFlag>false</b:TemporaryWorkerFlag>
<b:TimeAndCostGlccOverride i:nil="true"/>
<b:TitleIdentity>
<b:DepartmentIdentity>
<b:DepartmentId i:nil="true"/>
<b:DepartmentName>Executive Team</b:DepartmentName>
<b:DepartmentUid>1152921504606854181</b:DepartmentUid>
</b:DepartmentIdentity>
<b:TitleId i:nil="true"/>
<b:TitleName>Level 1</b:TitleName>
<b:TitleUid>1152921504606875471</b:TitleUid>
</b:TitleIdentity>
<b:TrackMissingTimeFlag>true</b:TrackMissingTimeFlag>
<b:WorkingScheduleOverrides>
<b:PwsResourceWorkingScheduleDay>
<b:DayOfWeek>Monday</b:DayOfWeek>
<b:StartTimeMinutesSinceMidnight>540</b:StartTimeMinutesSinceMidnight>
<b:WorkingMinutes>240</b:WorkingMinutes>
</b:PwsResourceWorkingScheduleDay>
<b:PwsResourceWorkingScheduleDay>
<b:DayOfWeek>Wednesday</b:DayOfWeek>
<b:StartTimeMinutesSinceMidnight>540</b:StartTimeMinutesSinceMidnight>
<b:WorkingMinutes>240</b:WorkingMinutes>
</b:PwsResourceWorkingScheduleDay>
<b:PwsResourceWorkingScheduleDay>
<b:DayOfWeek>Friday</b:DayOfWeek>
<b:StartTimeMinutesSinceMidnight>540</b:StartTimeMinutesSinceMidnight>
<b:WorkingMinutes>240</b:WorkingMinutes>
</b:PwsResourceWorkingScheduleDay>
</b:WorkingScheduleOverrides>
</b:LatestHistoryRecord>
<b:LatestHistoryRecordBeginDate>2018-10-01T00:00:00Z</b:LatestHistoryRecordBeginDate>
<b:ManagerUserIdentity>
<b:UserDisplayName>IT Manager</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
<b:UserUid>1152921504607134366</b:UserUid>
</b:ManagerUserIdentity>
<b:RequestedTimeOffApprovalUserIdentity>
<b:UserDisplayName>IT Manager</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
<b:UserUid>1152921504607134366</b:UserUid>
</b:RequestedTimeOffApprovalUserIdentity>
<b:SkillApprovalUserIdentity>
<b:UserDisplayName>IT Manager</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
<b:UserUid>1152921504607134366</b:UserUid>
</b:SkillApprovalUserIdentity>
<b:TimeEntryDelegateUserIdentity i:nil="true"/>
<b:TimecardApprovalFlag>true</b:TimecardApprovalFlag>
<b:TimecardApprovalUserIdentity>
<b:UserDisplayName>IT Manager</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>IM01</b:UserReferenceSystemId>
<b:UserUid>1152921504607134366</b:UserUid>
</b:TimecardApprovalUserIdentity>
<b:UserDefinedFields>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Date</b:UdfName>
<b:UdfUid>1152921504606856824</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>D</b:DataType>
<b:DateValue>2018-10-17T00:00:00Z</b:DateValue>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue i:nil="true"/>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Integer</b:UdfName>
<b:UdfUid>1152921504606856825</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>I</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue>1</b:IntegerValue>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue i:nil="true"/>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue>1</b:NumericValue>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Resource</b:UdfName>
<b:UdfUid>1152921504606856826</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>R</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue>
<b:ResourceDisplayName>Web Services</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>WS01</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607131538</b:ResourceUid>
</b:ResourceIdentityValue>
<b:TextValue i:nil="true"/>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Text</b:UdfName>
<b:UdfUid>1152921504606856827</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>T</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue>Web Services Resource</b:TextValue>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Text List</b:UdfName>
<b:UdfUid>1152921504606856828</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>L</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue>Grade A</b:TextValue>
<b:UdfTreatment>R</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Boolean</b:UdfName>
<b:UdfUid>1152921504606856829</b:UdfUid>
<b:BooleanValue>true</b:BooleanValue>
<b:DataType>Y</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue i:nil="true"/>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Stoplight</b:UdfName>
<b:UdfUid>1152921504606856830</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>S</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue i:nil="true"/>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues>
<b:PwsStoplightValue>
<b:AsOfDate>2018-10-17T00:00:00Z</b:AsOfDate>
<b:SortOrder>2</b:SortOrder>
</b:PwsStoplightValue>
</b:StoplightValues>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
<b:PwsUserDefinedFieldDetail>
<b:UdfId i:nil="true"/>
<b:UdfName>RS-Multiline</b:UdfName>
<b:UdfUid>1152921504606858519</b:UdfUid>
<b:BooleanValue i:nil="true"/>
<b:DataType>T</b:DataType>
<b:DateValue i:nil="true"/>
<b:IntegerValue i:nil="true"/>
<b:ResourceIdentityValue i:nil="true"/>
<b:TextValue>Web Services Resource - utilized for testing</b:TextValue>
<b:UdfTreatment>A</b:UdfTreatment>
<b:StoplightValues/>
<b:NumericValue i:nil="true"/>
<b:RelationValue i:nil="true"/>
</b:PwsUserDefinedFieldDetail>
</b:UserDefinedFields>
<b:UserIdentity>
<b:UserDisplayName>Web Services</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>WS01</b:UserReferenceSystemId>
<b:UserUid>1152921504607067736</b:UserUid>
</b:UserIdentity>
<b:VendorReferenceSystemId>Web Services</b:VendorReferenceSystemId>
</b:ResourceDetail>