Inbound Service Interface (public)

Description	Read Equipment Resources
Name	ReadEquipmentResourceIn
Namespace	http://sap.com/xi/A1S/Global
Process Component Description	Resource Data Management
Process Component Name	ResourceDataManagement
Process Component Namespace	http://sap.com/xi/AP/PC/ResourceDataManagement/Global
Deployment Unit Description	Foundation
Endpoint Activation	By Scoping of Process Component
Operations	Read equipment resources

Definition

An interface to query equipment resources data.

Business Context and Use

The web service interface Read Equipment Resource In offers the operation FindSimpleByElements that is used to query for one or more instances of the equipment resources, based on the query filter parameters passed.

Here is an example of a simple web service request:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-001</LowerBoundaryID>
  </SelectionByID>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.

Scenarios

Here is an example of a web service request that requests for an Equipment Resource based on Resource ID:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-001</LowerBoundaryID>
  </SelectionByID>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Here is an example of a web service request that requests for multiple Equipment Resource based on Resource ID:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-001</LowerBoundaryID>
  </SelectionByID>
    <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-003</LowerBoundaryID>
  </SelectionByID>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Here is an example of a web service request that requests for multiple Equipment Resources based on Resource Status:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByStatus>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>2</LowerBoundaryID>
  </SelectionByStatus>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Here is an example of a response for a request based on an Equipment Resource ID:

<?xml version="1.0"?>
<n0:EquipmentResourceReadByElementsResponse_sync xmlns:prx="urn:sap.com:proxy:QCH:/1SAI/TAS4D2D47699CA06359D7C4:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<EquipmentResource>
<ID>MC-HEATER-001</ID>
<UUID>00000000-0001-02dc-95bb-366cb3ed4cac</UUID>
<Description languageCode="EN">MC-HEATER-001</Description>
<SiteID>MC64000</SiteID>
</EquipmentResource>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
<LastReturnedObjectID>00000000000102DC95BB366CB3ED4CAC</LastReturnedObjectID>
</ProcessingConditions>
</n0:EquipmentResourceReadByElementsResponse_sync>

Description	Read equipment resources
Name	FindSimpleByElements
Synchronous	yes

Definition

An operation to query equipment resources data.

Business Context and Use

The operation FindSimpleByElements is used to query for one or more instances of the equipment resources based on the query filter parameters passed.

Here is an example of a simple web service request:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<EquipmentResourceSelectionByElements>
<SelectionByID>
<InclusionExclusionCode>I</InclusionExclusionCode>
<IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
<LowerBoundaryID>MC-HEATER-001</LowerBoundaryID>
</SelectionByID>
</EquipmentResourceSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
<LastReturnedObjectID/>
</ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Example

Here is an example of a web service request that requests for an Equipment Resource based on the Resource ID:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-001</LowerBoundaryID>
  </SelectionByID>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Here is an example of a web service request that requests for multiple Equipment Resources based on the Resource ID:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-001</LowerBoundaryID>
  </SelectionByID>
    <SelectionByID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>MC-HEATER-003</LowerBoundaryID>
  </SelectionByID>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Here is an example of a web service request that requests for multiple Equipment Resources based on the Resource Status:

<n0:EquipmentResourceSimpleByElementsRead_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <EquipmentResourceSelectionByElements>
  <SelectionByStatus>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryID>2</LowerBoundaryID>
  </SelectionByStatus>
 </EquipmentResourceSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>-1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:EquipmentResourceSimpleByElementsRead_sync>

Here is an example of a response for a request based on an Equipment Resource ID:

<?xml version="1.0"?>
<n0:EquipmentResourceReadByElementsResponse_sync xmlns:prx="urn:sap.com:proxy:QCH:/1SAI/TAS4D2D47699CA06359D7C4:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<EquipmentResource>
<ID>MC-HEATER-001</ID>
<UUID>00000000-0001-02dc-95bb-366cb3ed4cac</UUID>
<Description languageCode="EN">MC-HEATER-001</Description>
<SiteID>MC64000</SiteID>
</EquipmentResource>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
<LastReturnedObjectID>00000000000102DC95BB366CB3ED4CAC</LastReturnedObjectID>
</ProcessingConditions>
</n0:EquipmentResourceReadByElementsResponse_sync>

Inbound Service ReadEquipmentResourceIn

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

More Information

General Information

Scenarios

Operation Read Equipment Resource In Find Simple By Elements

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Example