Show TOC

Substitution CollectionLocate this document in the navigation structure

This is an addressable collection. It reflects all the current user's substitutions, that is, users that are authorized to execute tasks on behalf or instead of the current user. The Substitution entity contains the following properties:

Table 1: Properties Table

Property Name

Description

User

User name of the substitute.

BeginDate

Start date of the substitution.

EndDate

End date of the substitution.

FullName

Full name of the substitute.

IsActive

This flag indicates that the substitution active.

Mode

In BPM, there are substitution modes for Receiver and Replacer. In BWF, all substitutes are Receivers.

All CRUD operations are allowed in this collection.

  • GET — To retrieve the Substitution collection, perform a GET operation on the relevant URL.

    To obtain the URL:

    1. On the SAP Gateway system, go to transaction SPRO and choose SAP Reference IMG.

    2. Navigate to Start of the navigation path SAP NetWeaver Next navigation step SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Activate and Maintain Services End of the navigation path.

    3. Select the Task Gateway service.

    4. Choose Call Browser.

    5. Navigate to SubstitutionCollection.

  • POST — To create a Substitution, perform a POST operation on the relevant URL.

    To obtain the URL:

    1. On the SAP Gateway system, go to transaction SPRO and choose SAP Reference IMG.

    2. Navigate to Start of the navigation path SAP NetWeaver Next navigation step SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Activate and Maintain Services End of the navigation path.

    3. Select the Task Gateway service.

    4. Choose Call Browser.

    5. Navigate to SubstitutionCollection.

    Fill the request body as follows:

    >atom:entry xmlns:atom="http://www.w3.org/2005/Atom">
    >atom:content type="application/xml">
    >m:properties xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices">
      >d:User>FISHMANROY>/d:User>
      >d:FullName>Roy FISHMAN>/d:FullName>
      >d:IsActive>true>/d:IsActive>
      >d:BeginDate>2012-05-08T00:00:00>/d:BeginDate>
      >d:EndDate>9999-12-31T00:00:00>/d:EndDate>
      >d:Mode>RECEIVE_TASKS>/d:Mode>
    >/m:properties>
    >/atom:content>
    >/atom:entry>
     
  • PUT – To update the status of the substitution (activate or deactivate), perform a PUT operation on the relevant URL.

To obtain the URL:

  1. On the SAP Gateway system, go to transaction SPRO and choose SAP Reference IMG.

  2. Navigate to Start of the navigation path SAP NetWeaver Next navigation step SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Activate and Maintain Services End of the navigation path.

  3. Select the Task Gateway service.

  4. Choose Call Browser.

  5. Navigate to SubstitutionCollection.

  6. Navigate to the collection on the specific user ID – SubstitutionCollection(User=>user>,BeginDate=>BeginDate>,EndDate=> EndDate>).

Fill the request body as follows:

>atom:entry xmlns:atom="http://www.w3.org/2005/Atom">
>atom:content type="application/xml">
>m:properties xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices">
  >d:User>FISHMANROY>/d:User>
  >d:FullName>Roy FISHMAN>/d:FullName>
  >d:IsActive>true>/d:IsActive>
  >d:BeginDate>2012-05-08T00:00:00>/d:BeginDate>
  >d:EndDate>9999-12-31T00:00:00>/d:EndDate>
  >d:Mode>RECEIVE_TASKS>/d:Mode>
>/m:properties>
>/atom:content>
>/atom:entry>
 

To activate the substitution, set the IsActive field to true.

To deactivate the substitution, set the IsActive field to false.

  • DELETE – To delete a Substitution, perform a DELETE operation on the relevant URL.

    To obtain the URL:

    1. On the SAP Gateway system, go to transaction SPRO and choose SAP Reference IMG.

    2. Navigate to Start of the navigation path SAP NetWeaver Next navigation step SAP Gateway Next navigation step OData Channel Next navigation step Administration Next navigation step General Settings Next navigation step Activate and Maintain Services End of the navigation path.

    3. Select the Task Gateway service.

    4. Choose Call Browser.

    5. Navigate to SubstitutionCollection.

    6. Navigate to the collection on the specific user ID – SubstitutionCollection(User=>user>,BeginDate=>BeginDate>,EndDate=> EndDate>).

    7. Select Delete.