Inbound Service Interface (public)

Description	Query Jobs
Name	OrganisationalManagementJobQueryIn
Namespace	http://sap.com/xi/AP/FO/MOM/Global
Process Component Description	Organisational Management
Process Component Name	OrganisationalManagement
Process Component Namespace	http://sap.com/xi/AP/FO/MOM/Global
Deployment Unit Description	Foundation
Endpoint Activation	By Scoping of Process Component
Operations	Find jobs

Definition

An interface to query jobs.

Business Context and Use

The web service interface Job Query In enables you to connect external applications to your SAP Business ByDesign system and to query jobs in your system.

This web service interface is relevant if external parties or systems want to access job data from external applications.

The web service interface Job Query In offers the operation Find By Elements.

Prerequisites

Existence of referenced business documents:

The following business documents are only queried and will not be created by the service operations:

They must already exist in the system when the web service is called.

Example

The following request would query a Job with the following information:

*LowerBoundaryJobID as UUUUU1

Request

<n0:JobQueryRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <Job>
  <SelectionByJobIdentifier>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryJobID>UUUUU1</LowerBoundaryJobID>
  </SelectionByJobIdentifier>
 </Job>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:JobQueryRequest>

Response would contain the result of the above operation.

In case of successful execution, the response would contain the Job UUID,Identifier,Validity Period, Name and Name Validity Period.

The following is the response for successful execution of the above request.

Response

<nm:JobQueryResponseMessage xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TASE84B5065292F90625060:804">
 <Job>
  <UUID>00163e02-8660-1ed2-86b4-d3d387d63d03</UUID>
  <Ientifier>UUUUU1</Ientifier>
  <ValidityPeriod>
   <StartDate>2012-10-12</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">uuuu1</Name>
   <NameValidityPeriod>
    <StartDate>2012-10-12</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <ProcessingConditions>
  <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>
  <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
  <LastReturnedObjectID>00163E0286601ED286B4D3D387D63D03</LastReturnedObjectID>
 </ProcessingConditions>
</nm:JobQueryResponseMessage>

In case of failed execution, the response would contain error message(s).

Constraints and Integrity Conditions

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation.

Scenarios

The following example scenarios can be carried out using the job query service.

Master Data Integration with External Applications

The following example request returns maximum of 10 jobs with IDs beginning with BSRP.

Request

<n0:JobQueryRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <Job>
  <SelectionByJobIdentifier>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryJobID>BSRP*</LowerBoundaryJobID>
   <UpperBoundaryJobID/>
  </SelectionByJobIdentifier>
 </Job>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:JobQueryRequest>

Response would contain the result of the above operation.

The following is the response for successful execution of the above request.

Response

<nm:JobQueryResponseMessage xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TASE84B5065292F90625060:804">
 <Job>
  <UUID>00000000-0001-02dc-98b6-ee2d7bf5c717</UUID>
  <Ientifier>BSRPMJOB01</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">RPM Consultant</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-ee34fab5c720</UUID>
  <Ientifier>BSRPMJOB02</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">RPM Developer</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-ee3648f68729</UUID>
  <Ientifier>BSRPMJOB03</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">RPM Manager</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f0d60fa7c110</UUID>
  <Ientifier>BSRP100</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP100</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f11b6a16cca3</UUID>
  <Ientifier>BSRP101</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP101</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f14434d7ccb1</UUID>
  <Ientifier>BSRP102</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP102</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f17939a2ccbf</UUID>
  <Ientifier>BSRP103</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP103</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f1c0494bcccd</UUID>
  <Ientifier>BSRP104</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP104</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f27ec3780e4a</UUID>
  <Ientifier>BSRP105</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP105</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f2b057c60e58</UUID>
  <Ientifier>BSRP106</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP106</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <ProcessingConditions>
  <ReturnedQueryHitsNumberValue>10</ReturnedQueryHitsNumberValue>
  <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator>
  <LastReturnedObjectID>00000000000102DC98B6F2B057C60E58</LastReturnedObjectID>
 </ProcessingConditions>
</nm:JobQueryResponseMessage>

The following example request returns maximum of 10 jobs with Job Ids between BSRP101 and BSRP103.

Request

<n0:JobQueryRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <Job>
  <SelectionByJobIdentifier>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode>
   <LowerBoundaryJobID>BSRP101</LowerBoundaryJobID>
   <UpperBoundaryJobID>BSRP103</UpperBoundaryJobID>
  </SelectionByJobIdentifier>
 </Job>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:JobQueryRequest>

Response would contain the result of the above operation.

The following is the response for successful execution of the above request.

Response

<nm:JobQueryResponseMessage xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TASE84B5065292F90625060:804">
 <Job>
  <UUID>00000000-0001-02dc-98b6-f11b6a16cca3</UUID>
  <Ientifier>BSRP101</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP101</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f14434d7ccb1</UUID>
  <Ientifier>BSRP102</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP102</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f17939a2ccbf</UUID>
  <Ientifier>BSRP103</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP103</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <ProcessingConditions>
  <ReturnedQueryHitsNumberValue>3</ReturnedQueryHitsNumberValue>
  <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
  <LastReturnedObjectID>00000000000102DC98B6F17939A2CCBF</LastReturnedObjectID>
 </ProcessingConditions>
</nm:JobQueryResponseMessage>

The following example request returns maximum of 10 jobs.

Request

<n0:JobQueryRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <Job>
  <SelectionByJobIdentifier>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryJobID>*</LowerBoundaryJobID>
  </SelectionByJobIdentifier>
 </Job>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
  <LastReturnedObjectID/>
 </ProcessingConditions>
</n0:JobQueryRequest>

Response would contain the result of the above operation.

The following is the response for successful execution of the above request.

Response

<nm:JobQueryResponseMessage xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QP9:/1SAI/TASE84B5065292F90625060:804">
 <Job>
  <UUID>00000000-0001-02dc-92b6-0bdb3bfc011b</UUID>
  <Ientifier>QAUT_CRM</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">Technical User CRM</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-95d8-a0bce8ee0da1</UUID>
  <Ientifier>MC3530</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">Purchasing Manager</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-95d8-a249e5fe0e02</UUID>
  <Ientifier>MDEC3530</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">Purchasing Manager</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-ee2d7bf5c717</UUID>
  <Ientifier>BSRPMJOB01</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">RPM Consultant</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-ee34fab5c720</UUID>
  <Ientifier>BSRPMJOB02</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">RPM Developer</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-ee3648f68729</UUID>
  <Ientifier>BSRPMJOB03</Ientifier>
  <ValidityPeriod>
   <StartDate>2005-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">RPM Manager</Name>
   <NameValidityPeriod>
    <StartDate>2005-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f0d60fa7c110</UUID>
  <Ientifier>BSRP100</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP100</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f11b6a16cca3</UUID>
  <Ientifier>BSRP101</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP101</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f14434d7ccb1</UUID>
  <Ientifier>BSRP102</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP102</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <Job>
  <UUID>00000000-0001-02dc-98b6-f17939a2ccbf</UUID>
  <Ientifier>BSRP103</Ientifier>
  <ValidityPeriod>
   <StartDate>1800-01-01</StartDate>
   <EndDate>9999-12-31</EndDate>
  </ValidityPeriod>
  <Name>
   <Name languageCode="EN">BSRP103</Name>
   <NameValidityPeriod>
    <StartDate>1800-01-01</StartDate>
    <EndDate>9999-12-31</EndDate>
   </NameValidityPeriod>
  </Name>
 </Job>
 <ProcessingConditions>
  <ReturnedQueryHitsNumberValue>10</ReturnedQueryHitsNumberValue>
  <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator>
  <LastReturnedObjectID>00000000000102DC98B6F17939A2CCBF</LastReturnedObjectID>
 </ProcessingConditions>
</nm:JobQueryResponseMessage>

Note: The messages in the log vary from system to system based on the configuration.

Support for extensibility:

Querying data based on extended fields, is not possible. However the extended fields (if any) will be queried and these fields can be found in response.

Selection Parameter	Remark
SelectionByJobIdentifier	Selection by a job ID
ValidityStartDate	Selection by validity start date
ValidityEndDate	Selection by validity end date

Inbound Service OrganisationalManagementJobQueryIn

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Prerequisites

Constraints and Integrity Conditions

More Information

General Information

Scenarios

Support for extensibility:

Operation Find By Elements

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Structure

Request

Job Selection By Elements

Response

Job