| Description | Manage Product Requirement Specifications |
| Name | ManagePRSIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Product Requirement Specification |
| Process Component Name | ProductRequirementSpecificationProcessing |
| Process Component Namespace | http://sap.com/xi/AP/FO/ProductRequirementSpecification/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to manage product requirement specifications.
This web service is used to create or modify existing product requirement specifications.
It has the MaintainBundle, CheckMaintainBundle and ReadPRS operations.
The MaintainBundle operation is used to create or update one or more instances of the product requirement specification.
The CheckMaintainBundle operation is used to check if the one or more instances of the product requirement specification can be maintained.
The ReadPRS operation is used to read instances of the product requirement specifications.
Create product requirement specifications
The MaintainBundle operation is used to create product requirement specifications.
Update product requirement specifications
The MaintainBundle operation is used to update existing product requirement specifications.
Here is an example of a web service request to create two product requirement specifications:
Request:
Show full documentation
Show full documentation
<n0:PRSBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BusinessDocumentBasicMessageHeader />
<ProductRequirementSpecification ActionCode="01">
<ObjectNodeSenderTechnicalID>9999_A</ObjectNodeSenderTechnicalID>
<ChangeStateID></ChangeStateID>
<ID>TEST_1234</ID>
<RequirementObject ActionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<RequirementObjectMaterial ActionCode="01">
<RequirementObjectMaterialKey>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-0001-CFG01</ProductID>
</RequirementObjectMaterialKey>
</RequirementObjectMaterial>
</RequirementObject>
<Description ActionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<Description languageCode="EN">ProductRequirementSpecification_001</Description>
</Description>
</ProductRequirementSpecification>
<ProductRequirementSpecification ActionCode="01">
<ObjectNodeSenderTechnicalID>9999_B</ObjectNodeSenderTechnicalID>
<ChangeStateID></ChangeStateID>
<ID>TEST-5678</ID>
<RequirementObject ActionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<RequirementObjectMaterial ActionCode="01">
<RequirementObjectMaterialKey>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-0001-CFG01</ProductID>
</RequirementObjectMaterialKey>
</RequirementObjectMaterial>
</RequirementObject>
<Description ActionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<Description languageCode="EN">ProductRequirementSpecification_002</Description>
</Description>
</ProductRequirementSpecification>
</n0:PRSBundleMaintainRequest_sync>
Response:
<nm:PRSBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS1AB3E417BDC17EB948A6:804"> <ProductRequirementSpecification> <ChangeStateID>20120727081954.4463440</ChangeStateID> <ID>TEST_1234</ID> <VersionUUID>00163e02-870c-1ee1-b5f8-7af791a883a6</VersionUUID> </ProductRequirementSpecification> <ProductRequirementSpecification> <ChangeStateID>20120727081954.4463440</ChangeStateID> <ID>TEST-5678</ID> <VersionUUID>00163e02-870c-1ee1-b5f8-7af791a863a6</VersionUUID> </ProductRequirementSpecification> <Log /> </nm:PRSBundleMaintainConfirmation_sync>
Here is an example of a web service request to create product requirement specification having properties:
Request:
<n0:PRSBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BusinessDocumentBasicMessageHeader/>
<ProductRequirementSpecification ActionCode="01">
<ID>SPEC_SN_TEST1</ID>
<SpecificationFolder ActionCode="01">
<Specification ActionCode="01"> </Specification>
<ProductPropertyValuationList ActionCode="01">
<HostObjectNodeReference>
<ObjectTypeCode>357</ObjectTypeCode>
<ObjectNodeTypeCode>18388</ObjectNodeTypeCode>
</HostObjectNodeReference>
<BasePropertyListReference>
<ObjectTypeCode>730</ObjectTypeCode>
<ObjectNodeTypeCode>24699</ObjectNodeTypeCode>
</BasePropertyListReference>
<PropertyValuation ActionCode="01">
<PropertyLibraryPropertyVersionKey>
<PropertyLibraryPropertyID>MCP-0007-MTO</PropertyLibraryPropertyID>
<PropertyLibraryUUID>00145EF5-3F0C-1DED-98EC-FB3F9A710573</PropertyLibraryUUID>
</PropertyLibraryPropertyVersionKey>
<PropertyValuationPropertyValue ActionCode="01">
<LowerBoundaryObjectPropertyValue>
<Code>SIL</Code>
</LowerBoundaryObjectPropertyValue>
<UpperBoundaryObjectPropertyValue/>
</PropertyValuationPropertyValue>
</PropertyValuation>
<PropertyValuation ActionCode="01">
<PropertyLibraryPropertyVersionKey>
<PropertyLibraryPropertyID>MCP-0004-MTO</PropertyLibraryPropertyID>
<PropertyLibraryUUID>00145EF5-3F0C-1DED-98EC-FB3F9A710573</PropertyLibraryUUID>
</PropertyLibraryPropertyVersionKey>
<PropertyValuationPropertyValue ActionCode="01">
<LowerBoundaryObjectPropertyValue>
<Code>02</Code>
</LowerBoundaryObjectPropertyValue>
<UpperBoundaryObjectPropertyValue/>
</PropertyValuationPropertyValue>
</PropertyValuation>
</ProductPropertyValuationList>
</SpecificationFolder>
<RequirementObject ActionCode="01">
<RequirementObjectMaterial ActionCode="01">
<RequirementObjectMaterialKey>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MJF-0001</ProductID>
</RequirementObjectMaterialKey>
</RequirementObjectMaterial>
</RequirementObject>
<Description ActionCode="01">
<Description languageCode="EN">test prs</Description>
</Description>
</ProductRequirementSpecification>
</n0:PRSBundleMaintainRequest_sync>
Response:
<n0:PRSBundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:H32:/1SAI/TAE1AB3E417BDC17EB948A6:804"> <ProductRequirementSpecification> <ChangeStateID> 20181116075102.1189670</ChangeStateID> <ID>SPEC_SN_TEST1</ID> <VersionUUID>00163e61-3685-1ee8-baae-8b8343ce327e</VersionUUID> </ProductRequirementSpecification> </n0:PRSBundleMaintainConfirmation_sync>
Here is an example of a web service request to update the existing product requirement specification:
Request:
<n0:PRSBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BusinessDocumentBasicMessageHeader />
<ProductRequirementSpecification ActionCode="02">
<ObjectNodeSenderTechnicalID>9999_C</ObjectNodeSenderTechnicalID>
<ChangeStateID />
<ID>TEST-1234</ID>
<VersionUUID>00163e02-870c-1ee1-b5f8-7af791a883a6</VersionUUID>
<Name>CHANGE_TEST_NAME1</Name>
</ProductRequirementSpecification>
<ProductRequirementSpecification>
<ObjectNodeSenderTechnicalID />
<ChangeStateID />
<ID>TEST-5678</ID>
<VersionUUID>00163e02-870c-1ee1-b5f8-7af791a863a6</VersionUUID>
<RequirementObject ActionCode="03">
<ObjectNodeSenderTechnicalID />
<RequirementObjectUUID>00163e02-870c-1ee1-b5f8-7af791a8a3a6</RequirementObjectUUID>
</RequirementObject>
</ProductRequirementSpecification>
</n0:PRSBundleMaintainRequest_sync>
Response:
<nm:PRSBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS1AB3E417BDC17EB948A6:804"> <ProductRequirementSpecification> <ChangeStateID>20120727083422.5641030</ChangeStateID> <ID>TEST_1234</ID> <VersionUUID>00163e02-870c-1ee1-b5f8-7af791a883a6</VersionUUID> </ProductRequirementSpecification> <ProductRequirementSpecification> <ChangeStateID>20120727083422.5641030</ChangeStateID> <ID>TEST-5678</ID> <VersionUUID>00163e02-870c-1ee1-b5f8-7af791a863a6</VersionUUID> </ProductRequirementSpecification> <Log /> </nm:PRSBundleMaintainConfirmation_sync>
Here is an example of a web service request to read an existing product requirement specification:
Request:
<n0:ProductRequirementSpecificationByVersionUUIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductRequirementSpecificationByVersionUUID> <VersionUUID>00000000-0001-02DC-9BA8-F7D780FA8156</VersionUUID> </ProductRequirementSpecificationByVersionUUID> </n0:ProductRequirementSpecificationByVersionUUIDQuery_sync>
The following business documents are only referenced and will not be created by the service operations. They must exist in the system at the time the web service is called:
Product
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Check maintain product requirement specifications |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To check if product requirement specifications can be created, updated, or deleted without errors.
The web service request and response message types for the CheckMaintainBundle operation is same as those of the MaintainBundle operation.
| Description | Maintain product requirement specifications |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To create, update, or delete product requirement specifications.
The MaintainBundle operation is used to maintain one or more product requirement specification using imported structured data.
The request message of the MaintainBundle operation contains a BasicMessageHeader node element as well as a ProductRequirementSpecification node element that contains the product requirement specification data to be created or updated. The detailed structure of the ProductRequirementSpecification node will be explained in the following sub-chapters. The ProductRequirementSpecification node can occur multiple times in the request message. This means that multiple product requirement specifications can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a product requirement specification-specific node with ObjectNodePartyTechnicalID, ChangeStateID, as well as ProductRequirementSpecificationID and VersionUUID.
The ProductRequirementSpecification node contains all general information such as ID, VersionUUID, Name and other identifications.
The following are the attributes and elements of this node.
| Elements | Description |
|---|---|
| ID | The identifier for a specific product requirement specification |
| VersionUUID | Universally unique identifier (mandatory during modifications of an existing product requirement specification) |
| Name | Name of the product requirement specification. If not explicitly mentioned, defaulted to the value of ID field during creation of the specification. |
| setObsoleteActionIndicator | Marking this indicator as 'true' sets product requirement specification status to 'Obsolete'. |
| setReleasedActionIndicator | Marking this indicator as 'true' sets product requirement specification status to 'Released'. |
The SpecificationFolder node is a collection of all specifications that define the fulfillment of the requirements of a business entity. It covers the information that is relevant for all subsequent single specifications.
| Element | Description |
|---|---|
| ResponsibleEmployeeID | Unique identifier for the employee responsible for the specification document |
Child Node - Specification
The SpecificationFolder specification node is the precise definition of one or many features and the way they fulfill one or many requirements of the business entity.
| Element | Description |
|---|---|
| ID | Unique identifier of the specification document |
| TextCollection | Used for text data storage |
| AttachmentFolder | Used for attachments storage |
Text
The Text node element can be used to maintain account notes, financial data notes, and internal and external sales notes.
Data for this node element can be found as Notes on the account UI. Possible text type codes include the following:
| Type code | Description |
|---|---|
| 10034 | Account note |
| 10039 | Financial data note |
| 10065 | Internal sales note |
| 10066 | External sales note |
If an update operation on the Text node is to be performed, the TextListCompleteTransmissionIndicator must be set to true, and the complete list must be transmitted. Notes in accounts can be changed by the creator only.
Note: If a web service call is performed using a communication user, created texts cannot be changed later through the UI, because it is not possible to log on with the communication user.
Attachment Folder
The AttachmentFolder node element can be used to add and remove account attachments.
Data for this node can be found on the account UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| CategoryCode | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The different types of attachments are differentiated by the TypeCode:
| TypeCode | Description |
|---|---|
| 10001 | Standard attachment |
| 10016 | Business partner image |
| 10017 | Business card |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | <none> |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <Comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | <none> |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <Comment> |
Child Node - Product Property Valuation List
The ProductPropertyValuationList node is a collection of values for the properties of a predefined property list, whose content is related to the specification folder under examination.
| Element | Description |
|---|---|
| TypeCode | Property valuation list type code |
| UUID | Universally unique identifier |
Type Code
| Code | Description |
|---|---|
| 1 | Property list based |
| 2 | Unrestricted |
Under ProductPropertyValuationList, actual property valuations are stored in the form of lower and upper boundaries.
The basic information is the type of the required business object, for example, a material.
Child Node - Requirement Object Material
The RequirementObjectMaterial node is a material that is supposed to fulfill the requirement specification.
| Element | Description |
|---|---|
| RequirementObjectMaterialKey | Stores the ProductIdentifierTypeCode and ProductID information |
The Description node is a language dependent detailed description of the product requirement specification.
| Element | Description |
|---|---|
| Description | Data element to store the description in text format |
The response displays the following root information of the created and/or modified product requirement specification:
| Element | Description |
|---|---|
| ID | The identifier for a specific product requirement specification |
| VersionUUID | Universally unique identifier (mandatory during modifications of an existing product requirement specification) |
In addition, a log is also provided, which gives the details of errors encountered during the modifications, if any.
This operation does not support extensibility.
Here is an example of a web service request to create a product requirement specification with product data information and description:
Request
<n0:PRSBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BusinessDocumentBasicMessageHeader>
</BusinessDocumentBasicMessageHeader>
<ProductRequirementSpecification ActionCode="01" >
<ObjectNodeSenderTechnicalID>9999_A</ObjectNodeSenderTechnicalID>
<ChangeStateID></ChangeStateID>
<ID>TEST-1234</ID>
<RequirementObject ActionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<RequirementObjectMaterial ActionCode="01">
<RequirementObjectMaterialKey>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-0001-CFG01</ProductID>
</RequirementObjectMaterialKey>
</RequirementObjectMaterial>
</RequirementObject>
<Description ActionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<Description languageCode="EN">ProductRequirementSpecification_001 </Description>
</Description>
</ProductRequirementSpecification>
</n0:PRSBundleMaintainRequest_sync>
Response
<nm:PRSBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS1AB3E417BDC17EB948A6:804"> <ProductRequirementSpecification> <ChangeStateID>20120727103033.4454790</ChangeStateID> <ID>TEST-1234</ID> <VersionUUID>00163e02-86fa-1ed1-b5fa-c30c0d1d2c8e</VersionUUID> </ProductRequirementSpecification> <Log /> </nm:PRSBundleMaintainConfirmation_sync>
Here is an example of a web service request to update product requirement specification status as 'Obsolete':
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global">
<soapenv:Header/>
<soapenv:Body>
<glob:PRSBundleMaintainRequest_sync>
<BusinessDocumentBasicMessageHeader/>
<ProductRequirementSpecification ActionCode="04">
<VersionUUID>00000000-0001-02DC-9BA8-F6B8738B40AA</VersionUUID>
<setObsoleteActionIndicator>true</setObsoleteActionIndicator>
</ProductRequirementSpecification>
</glob:PRSBundleMaintainRequest_sync>
</soapenv:Body>
</soapenv:Envelope>
Here is an example of a web service request to update product requirement specification status as 'Released':
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global">
<soapenv:Header/>
<soapenv:Body>
<glob:PRSBundleMaintainRequest_sync>
<BusinessDocumentBasicMessageHeader/>
<ProductRequirementSpecification ActionCode="04">
<VersionUUID>00000000-0001-02DC-9BA8-F6B8738B40AA</VersionUUID>
<setReleasedActionIndicator>true</setReleasedActionIndicator>
</ProductRequirementSpecification>
</glob:PRSBundleMaintainRequest_sync>
</soapenv:Body>
</soapenv:Envelope>
| Description | Read product requirement specifications |
| Name | ReadPRS |
| Synchronous | yes |
| Release Status | Released |
To read product requirement specifications.
The ReadPRS operation reads the data of one or more product requirement specifications.
The ProductRequirementSpecification node contains all general information such as ID, VersionUUID, Name and other identification.
The following are the attributes and elements of this node.
| Elements | Description |
|---|---|
| ID | Identifier for a specific product requirement specification |
| Status | Product requirement specification status |
| Name | Name of the product requirement specification |
Product Requirement Specification Status
This is a coded representation of product requirement specification status.
| Code Value | Description |
|---|---|
| 1 | In Process |
| 2 | Evaluation in Process |
| 3 | Released |
| 4 | Obsolete |
The SpecificationFolder node is a collection of all specifications that define the fulfillment of the requirements of a business entity. It covers the information that is relevant for all subsequent single specifications.
| Element | Description |
|---|---|
| ResponsibleEmployeeID | Unique identifier for the employee responsible for the specification document |
Child Node - Specification
A SpecificationFolderSpecification is the precise definition of one or many features and the way they fulfill one or many requirements of the business entity.
| Element | Description |
|---|---|
| ID | Unique identifier of the specification document |
| TextCollection | Used for text data storage |
| AttachmentFolder | Used for attachments storage |
Text
The Text node element can be used to maintain account notes, financial data notes, and internal and external sales notes.
Data for this node element can be found as Notes on the account UI. Possible text type codes include the following:
| Type code | Description |
|---|---|
| 10034 | Account note |
| 10039 | Financial data note |
| 10065 | Internal sales note |
| 10066 | External sales note |
If an update operation on the Text node is to be performed, the TextListCompleteTransmissionIndicator must be set to true, and the complete list must be transmitted. Notes in accounts can be changed by the creator only.
Note: If a web service call is performed using a communication user, created texts cannot be changed afterwards through the UI, because it is not possible to log on with the communication user.
Attachment Folder
The AttachmentFolder node element can be used to add and remove account attachments.
Data for this node can be found on the account UI as Attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| CategoryCode | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The different types of attachments are differentiated by the TypeCode:
| TypeCode | Description |
|---|---|
| 10001 | Standard attachment |
| 10016 | Business partner image |
| 10017 | Business card |
Child Node - Product Property Valuation List
The ProductPropertyValuationList node is a collection of values for the properties of a predefined property list, whose content is related to the specification folder under examination.
| Element | Description |
|---|---|
| TypeCode | Property valuation list type code |
| UUID | Universally unique identifier |
Type Code
| Code | Description |
|---|---|
| 1 | Property list based |
| 2 | Unrestricted |
Under ProductPropertyValuationList, actual property valuations are stored in the form of lower and upper boundaries.
The basic information is the type of the required business object, for example, a material.
Child Node - Requirement Object Material
The RequirementObjectMaterial node is a material that is supposed to fulfill the requirement specification.
| Element | Description |
|---|---|
| RequirementObjectMaterialKey | Stores the ProductIdentifierTypeCode and ProductID information |
The Description node is a language-dependent detailed description of the product requirement specification.
| Element | Description |
|---|---|
| Description | Data element to store the description in text format |
This operation does not support extensibility.
Here is an example of a web service request to read an existing product requirement specification:
Request:
<n0:ProductRequirementSpecificationByVersionUUIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductRequirementSpecificationByVersionUUID> <VersionUUID>00000000-0001-02DC-9BA8-F7D780FA8156</VersionUUID> </ProductRequirementSpecificationByVersionUUID> </n0:ProductRequirementSpecificationByVersionUUIDQuery_sync>