| Description | Query Product Design Versions |
| Name | QueryProductDesignIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Product | SAP Business ByDesign |
| Process component | Product Engineering |
| Process component namespace | http://sap.com/xi/AP/PC/ProductEngineeringFoundation/Global |
| Deployment unit | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Query Product Design Versions |
| General web service documentation | A2X Web Services (SOAP) |
An interface to execute a query on product design.
The web service interface Query Product Design In enables you to connect external applications to your SAP Business ByDesign system and to query and read information about product design in your system.
The web service interface Query Product Design In offers the operation Query By Elements.
Creation and maintenance of query:
Before a query is executed on product design, instance of product design has to be created and maintained first.
Query operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service (external application) is responsible for ensuring reasonable sizes for mass operations.
The query processing conditions specify how to process a query with respect to the maximum number of hits that will be returned.
A query request message provides the following elements:
Query hits maximum number value (element name QueryHitsMaximumNumberValue): Maximum number of hits to be returned by an inquiry.
Query hits unlimited indicator (element name QueryHitsUnlimitedIndicator): Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by a previous inquiry.
Note: If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be filled.
A query response message provides the following elements:
Returned query hits number value (element name ReturnedQueryHitsNumberValue): The number of hits returned by an inquiry.
More hits available indicator (element name MoreHitsAvailableIndicator): Indicates whether there are more than ReturnedQueryHitsNumberValue hits matching the selection criteria or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by this inquiry.
Note: Processing conditions can be used for the paging of query results. However, it is crucial not to change the query selection parameters from request to request,to prevent the query result from changing.
Query selection parameters are mainly exposed as select options or ranges, with an inclusion/exclusion code, interval boundary type code, lower boundary value, and upper boundary value.
The inclusion/exclusion code (element name InclusionExclusionCode) specifies the inclusion or exclusion of a set in a result set.
| Inclusion Exclusion Code | Description |
|---|---|
| E | Excluding |
| I | Including |
The interval boundary type code (element name IntervalBoundaryTypeCode) is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.
| Interval Boundary Type Code | Name | Description | Logical Operator |
|---|---|---|---|
| 1 | Equal to | Single Value | =X |
| 2 | Between(Excluding upper boundary) | Interval with closed lower and open upper boundary | [X, Y) |
| 3 | Between | Interval with open lower and open upper boundary | (X, Y) |
| 4 | Between (excluding both boundaries) | Interval with open lower and open upper boundary | (X, Y) |
| 5 | Between (excluding lower boundary) | Interval with open lower and closed upper boundary | (X, Y] |
| 6 | Less than | Interval with unlimited lower and open upper boundary | < X |
| 7 | Less than or Equal to | Interval with unlimited lower and closed upper boundary | <= X |
| 8 | Greater than | Interval with open lower and unlimited upper boundary | > X |
| 9 | Greater than or Equal to | Interval with closed lower and unlimited upper boundary | = X |
Requested elements (element name RequestedElements) enable a web service consumer to reduce the size of query response messages,therefore reducing transmission and response times and avoiding timeouts.
Requested elements contain transmission request codes to control the transmission of corresponding query response node elements.
The transmission request codes are modeled as xml attributes following the syntax: <element name>TransmissionRequestCode.
The prefix <element name> is equivalent to the name of the node element in the response message to which the transmission request code applies.
| Transmission Request Code | Name | Description |
|---|---|---|
| 1 | Complete Structure | The node element and all its elements, its child node elements and all their elements will be returned. |
| 2 | Complete Node | The node element and all its elements will be returned. |
| 3 | Node with Key Elements | The node element and its key elements will be returned.(Note: This is not supported by all web service interfaces) |
| 4 | Excluded Node | The node element and its child node elements will not be returned. |
The transmission request code is optional. If no transmission request code is modeled or provided by the service consumer, the following rules apply:
If the transmission request code is not provided, then the response message contains all data.
If the transmission request code of the parent node element is 1, its sub-node elements for which no transmission request code is specified are defaulted to 1.
If the transmission request code of the parent node element is 2 or 3, its sub-node elements for which no transmission request code is specified are defaulted to 4.
If the transmission request code of the parent node element is 4, its sub-node elements are not returned.
The structure of the query response message consists of three parts:
A business document-specific part that contains the returned business documents.
Processing conditions.
Log items that contain system messages including errors, warnings, and information messages raised by the system while processing the web service request.
Example of Request message when the query is based on Product Design ID:
<n0:ProductDesignVersionSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductDesignVersionSimpleSelectionByElements> <SelectionByKeyProductDesignID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryProductDesignID schemeID="Token 3" schemeVersionID="Token 4" schemeAgencyID="Token 5">YC_COMP_E2E</LowerBoundaryProductDesignID> </SelectionByKeyProductDesignID> </ProductDesignVersionSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID schemeID="Token 530" schemeVersionID="Token 531" schemeAgencyID="Token 532" schemeAgencySchemeID="Token 533" schemeAgencySchemeAgencyID="Tok"></LastReturnedObjectID> </ProcessingConditions> </n0:ProductDesignVersionSimpleByElementsQuery_sync>
Example of Response message when the query is based on Product Design ID:
- <nm:ProductDesignVersionSimpleByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TASD5D529C361A3DF4A2645:804"> - <ProductDesignVersion> <ProductDesignUUID>00163e02-518d-1ed1-91e6-0aca45858faa</ProductDesignUUID> <UUID>00163e02-518d-1ed1-91e6-0aca4585afaa</UUID> <ID>1</ID> <Name>A</Name> - <EngineeringDesignVersionIdentification> <EngineeringDesignVersionID>A</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>A</EngineeringDesignVersionInternalID> </EngineeringDesignVersionIdentification> <AssemblyIndicator>true</AssemblyIndicator> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <EngineeringDesignVersionStatusName>Released by Engineering</EngineeringDesignVersionStatusName> <ApplicationLogUUID>00163e02-518d-1ed1-91e6-0aca4586cfaa</ApplicationLogUUID> <EngineeringDesignVersionCreationDateTime>2009-12-01T08:37:40Z</EngineeringDesignVersionCreationDateTime> <EngineeringDesignVersionLastChangeDateTime>2009-12-01T08:37:40Z</EngineeringDesignVersionLastChangeDateTime> - <SystemAdministrativeData> <CreationDateTime>2012-01-25T08:41:13.601296Z</CreationDateTime> <CreationIdentityUUID>00163e02-25d5-1ee1-87a3-8f1850cf5a5b</CreationIdentityUUID> <LastChangeDateTime>2012-02-06T08:21:49.934779Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-25d5-1ee1-81c3-6b9b2cf07f12</LastChangeIdentityUUID> </SystemAdministrativeData> </ProductDesignVersion> - <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E02518D1ED191E60ACA45858FAA</LastReturnedObjectID> </ProcessingConditions> <Log /> </nm:ProductDesignVersionSimpleByElementsResponse_sync>
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.
Example of Request message when the query is based on Product Design Description:
<n0:ProductDesignVersionSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductDesignVersionSimpleSelectionByElements> <SelectionByDescription> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryDescription languageCode="EN">This is an English description</LowerBoundaryDescription> </SelectionByDescription> </ProductDesignVersionSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>529</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID schemeID="Token 530" schemeVersionID="Token 531" schemeAgencyID="Token 532" schemeAgencySchemeID="Token 533" schemeAgencySchemeAgencyID="Tok"></LastReturnedObjectID> </ProcessingConditions> </n0:ProductDesignVersionSimpleByElementsQuery_sync>
Example of Response message when the query is based on Product Design Description:
-<nm:ProductDesignVersionSimpleByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TASD5D529C361A3DF4A2645:804"> -<ProductDesignVersion> <ProductDesignUUID>00163e02-5191-1ee1-91bb-f28f9e6fc29f</ProductDesignUUID> <ProductDesignID>RV_PD_6</ProductDesignID> <UUID>00163e02-5191-1ee1-91bb-f28f9e70029f</UUID> <ID>1</ID> <Name>VersA</Name> -<EngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA_IntID</EngineeringDesignVersionInternalID> </EngineeringDesignVersionIdentification> <AssemblyIndicator>true</AssemblyIndicator> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName>each</BaseQuantityTypeName> <ProposedProcurementMethodCode>1</ProposedProcurementMethodCode> <ProposedProcurementMethodName>In-house Production</ProposedProcurementMethodName> <EngineeringDesignVersionStatusName>In process by Engineering department</EngineeringDesignVersionStatusName> <EngineeringDesignVersionReleaseDate>2008-08-28</EngineeringDesignVersionReleaseDate> <EngineeringDesignVersionResponsibleEngineerPersonGivenName>Hans</EngineeringDesignVersionResponsibleEngineerPersonGivenName> <EngineeringDesignVersionResponsibleEngineerPersonFamilyName>Mueller</EngineeringDesignVersionResponsibleEngineerPersonFamilyName> <EngineeringDesignVersionPrimaryViewableCreationDateTime>2008-08-28T15:00:07Z</EngineeringDesignVersionPrimaryViewableCreationDateTime> <EngineeringDesignChangeOrderID>CO 0815-3</EngineeringDesignChangeOrderID> <ApplicationLogUUID>00163e02-5191-1ee1-91bb-f2a54bef029f</ApplicationLogUUID> <EngineeringDesignVersionCreationDateTime>2008-03-16T12:33:00Z</EngineeringDesignVersionCreationDateTime> <EngineeringDesignVersionLastChangeDateTime>2008-05-28T17:12:44Z</EngineeringDesignVersionLastChangeDateTime> -<SystemAdministrativeData> <CreationDateTime>2012-01-23T16:30:38.196086Z</CreationDateTime> <CreationIdentityUUID>00163e02-25d5-1ee1-87a3-8f1850cf5a5b</CreationIdentityUUID> <LastChangeDateTime>2012-01-23T16:30:38.196086Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-25d5-1ee1-87a3-8f1850cf5a5b</LastChangeIdentityUUID> </SystemAdministrativeData> -<Status> <LifeCycleStatusCode>1</LifeCycleStatusCode> <LifeCycleStatusName>In Preparation</LifeCycleStatusName> <ObsolescenceStatusCode>1</ObsolescenceStatusCode> <ObsolescenceStatusName>Not Obsolete</ObsolescenceStatusName> <BlockingStatusCode>1</BlockingStatusCode> <BlockingStatusName>Not Blocked</BlockingStatusName> <ReviewProcessingStatusCode>1</ReviewProcessingStatusCode> <ReviewProcessingStatusName>Not Started</ReviewProcessingStatusName> <ActivationStatusCode>2</ActivationStatusCode> <ActivationStatusName>Inactive</ActivationStatusName> <EngineeringDesignVersionReleaseStatusCode>3</EngineeringDesignVersionReleaseStatusCode> <EngineeringDesignVersionReleaseStatusName>Released</EngineeringDesignVersionReleaseStatusName> <ConsistencyStatusCode>2</ConsistencyStatusCode> <ConsistencyStatusName>Inconsistent</ConsistencyStatusName> <ExecutionUsageBlockingStatusCode>1</ExecutionUsageBlockingStatusCode> <ExecutionUsageBlockingStatusName>Not Blocked</ExecutionUsageBlockingStatusName> </Status> </ProductDesignVersion> -<ProductDesignVersion> <ProductDesignUUID>00163e02-86fa-1ed1-b790-ae68c2a06bd6</ProductDesignUUID> <ProductDesignID>CADPDN_00163E0286FA1ED1B790AE01DC66EBD6</ProductDesignID> <UUID>00163e02-86fa-1ed1-b790-ae68c2a0abd6</UUID> <ID>1</ID> <Name>VersA</Name> -<EngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA_IntID</EngineeringDesignVersionInternalID> </EngineeringDesignVersionIdentification> <AssemblyIndicator>true</AssemblyIndicator> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName>each</BaseQuantityTypeName> <ProposedProcurementMethodCode>1</ProposedProcurementMethodCode> <ProposedProcurementMethodName>In-house Production</ProposedProcurementMethodName> <EngineeringDesignVersionStatusName>In process by Engineering department</EngineeringDesignVersionStatusName> <EngineeringDesignVersionReleaseDate>2008-08-28</EngineeringDesignVersionReleaseDate> <EngineeringDesignVersionResponsibleEngineerPersonGivenName>Hans</EngineeringDesignVersionResponsibleEngineerPersonGivenName> <EngineeringDesignVersionResponsibleEngineerPersonFamilyName>Mueller</EngineeringDesignVersionResponsibleEngineerPersonFamilyName> <EngineeringDesignVersionPrimaryViewableCreationDateTime>2008-08-28T15:00:07Z</EngineeringDesignVersionPrimaryViewableCreationDateTime> <EngineeringDesignChangeOrderID>CO 0815-3</EngineeringDesignChangeOrderID> <ApplicationLogUUID>00163e02-86fa-1ed1-b790-ae68c2a30bd6</ApplicationLogUUID> <EngineeringDesignVersionCreationDateTime>2012-08-02T09:35:46Z</EngineeringDesignVersionCreationDateTime> <EngineeringDesignVersionLastChangeDateTime>2012-08-02T09:35:46Z</EngineeringDesignVersionLastChangeDateTime> -<SystemAdministrativeData> <CreationDateTime>2012-08-02T09:35:52.722928Z</CreationDateTime> <CreationIdentityUUID>00000000-0001-1ed1-8ada-aeec348e347c</CreationIdentityUUID> <LastChangeDateTime>2012-08-02T09:35:52.722928Z</LastChangeDateTime> <LastChangeIdentityUUID>00000000-0001-1ed1-8ada-aeec348e347c</LastChangeIdentityUUID> </SystemAdministrativeData> -<Status> <LifeCycleStatusCode>1</LifeCycleStatusCode> <LifeCycleStatusName>In Preparation</LifeCycleStatusName> <ObsolescenceStatusCode>1</ObsolescenceStatusCode> <ObsolescenceStatusName>Not Obsolete</ObsolescenceStatusName> <BlockingStatusCode>1</BlockingStatusCode> <BlockingStatusName>Not Blocked</BlockingStatusName> <ReviewProcessingStatusCode>1</ReviewProcessingStatusCode> <ReviewProcessingStatusName>Not Started</ReviewProcessingStatusName> <ActivationStatusCode>2</ActivationStatusCode> <ActivationStatusName>Inactive</ActivationStatusName> <EngineeringDesignVersionReleaseStatusCode>3</EngineeringDesignVersionReleaseStatusCode> <EngineeringDesignVersionReleaseStatusName>Released</EngineeringDesignVersionReleaseStatusName> <ConsistencyStatusCode>2</ConsistencyStatusCode> <ConsistencyStatusName>Inconsistent</ConsistencyStatusName> <ExecutionUsageBlockingStatusCode>1</ExecutionUsageBlockingStatusCode> <ExecutionUsageBlockingStatusName>Not Blocked</ExecutionUsageBlockingStatusName> </Status> </ProductDesignVersion> -<ProductDesignVersion> <ProductDesignUUID>00163e02-870c-1ee1-b889-f70cc07b902f</ProductDesignUUID> <ProductDesignID>CADPDN_00163E02870C1EE1B889F6B90CDEB02F</ProductDesignID> <UUID>00163e02-870c-1ee1-b889-f70cc07bd02f</UUID> <ID>1</ID> <Name>VersA</Name> -<EngineeringDesignVersionIdentification> <EngineeringDesignVersionID>VersA</EngineeringDesignVersionID> <EngineeringDesignVersionInternalID>VersA_IntID</EngineeringDesignVersionInternalID> </EngineeringDesignVersionIdentification> <AssemblyIndicator>true</AssemblyIndicator> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName>each</BaseQuantityTypeName> <ProposedProcurementMethodCode>1</ProposedProcurementMethodCode> <ProposedProcurementMethodName>In-house Production</ProposedProcurementMethodName> <EngineeringDesignVersionStatusName>In process by Engineering department</EngineeringDesignVersionStatusName> <EngineeringDesignVersionReleaseDate>2008-08-28</EngineeringDesignVersionReleaseDate> <EngineeringDesignVersionResponsibleEngineerPersonGivenName>Hans</EngineeringDesignVersionResponsibleEngineerPersonGivenName> <EngineeringDesignVersionResponsibleEngineerPersonFamilyName>Mueller</EngineeringDesignVersionResponsibleEngineerPersonFamilyName> <EngineeringDesignVersionPrimaryViewableCreationDateTime>2008-08-28T15:00:07Z</EngineeringDesignVersionPrimaryViewableCreationDateTime> <EngineeringDesignChangeOrderID>CO 0815-3</EngineeringDesignChangeOrderID> <ApplicationLogUUID>00163e02-870c-1ee1-b889-f722e3d4902f</ApplicationLogUUID> <EngineeringDesignVersionCreationDateTime>2012-08-07T05:21:15Z</EngineeringDesignVersionCreationDateTime> <EngineeringDesignVersionLastChangeDateTime>2012-08-07T05:21:15Z</EngineeringDesignVersionLastChangeDateTime> -<SystemAdministrativeData> <CreationDateTime>2012-08-07T05:21:21.412535Z</CreationDateTime> <CreationIdentityUUID>00000000-0001-1ed1-8ada-aeec348e347c</CreationIdentityUUID> <LastChangeDateTime>2012-08-07T05:21:21.412535Z</LastChangeDateTime> <LastChangeIdentityUUID>00000000-0001-1ed1-8ada-aeec348e347c</LastChangeIdentityUUID> </SystemAdministrativeData> -<Status> <LifeCycleStatusCode>1</LifeCycleStatusCode> <LifeCycleStatusName>In Preparation</LifeCycleStatusName> <ObsolescenceStatusCode>1</ObsolescenceStatusCode> <ObsolescenceStatusName>Not Obsolete</ObsolescenceStatusName> <BlockingStatusCode>1</BlockingStatusCode> <BlockingStatusName>Not Blocked</BlockingStatusName> <ReviewProcessingStatusCode>1</ReviewProcessingStatusCode> <ReviewProcessingStatusName>Not Started</ReviewProcessingStatusName> <ActivationStatusCode>2</ActivationStatusCode> <ActivationStatusName>Inactive</ActivationStatusName> <EngineeringDesignVersionReleaseStatusCode>3</EngineeringDesignVersionReleaseStatusCode> <EngineeringDesignVersionReleaseStatusName>Released</EngineeringDesignVersionReleaseStatusName> <ConsistencyStatusCode>2</ConsistencyStatusCode> <ConsistencyStatusName>Inconsistent</ConsistencyStatusName> <ExecutionUsageBlockingStatusCode>1</ExecutionUsageBlockingStatusCode> <ExecutionUsageBlockingStatusName>Not Blocked</ExecutionUsageBlockingStatusName> </Status> </ProductDesignVersion> -<ProcessingConditions> <ReturnedQueryHitsNumberValue>3</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> </ProcessingConditions> -<Log> <MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode> -<Item> <TypeID>009(/CSG_RUNTIME/)</TypeID> <SeverityCode>1</SeverityCode> <Note>Query returned 3 records</Note> </Item> </Log> </nm:ProductDesignVersionSimpleByElementsResponse_sync>
| Description | Find product design versions |
| Name | FindVersionSimpleByElements |
| Synchronous | yes |
| Release Status | Released |
To find product design data by element.
The request message of the operation QueryByElements contains the Body node that groups all possible selection parameters. It executes a query on the business object Product_Design on the basis of some given constraints.
The following table shows the list of attributes under the node BODY for the request message types that can be used for executing the query:
| Selection Parameters | Remarks |
|---|---|
| SelectionByKeyProductDesignID | Selection by the ID of the Product Design |
| SelectionByKeyProductDesignVersionID | Selection by the ID of the Version of the Product Design |
| SelectionByDescription | Selection by the Description of the Product Design |
| SelectionByProductDesignDescription | Selection by the Description of the Product Design |
| SelectionByName | Selection by the Name of the Product Design |
| SelectionByLifeCycleStatusCode | Selection by the Life Cycle Status Code:1-In Preparation,2-In Review,3-Review Finished,4-Active,5-Blocked,6-Obsolete |
| SelectionByExecutionUsageBlockingStatusCode | Selection by the Blocking Status Code:1-Not Blocked,3-Blocked |
| SelectionByEngineeringDesignVersionReleaseStatusCode | Selection by the Version Release Status Code:1-Not Released,2-Released,3-Release Discarded,4-Release Cancelled |
| SelectionByConsistencyStatusCode | Selection by the Consistency Status Code:1-Check Pending,2-Inconsistent,3-Consistent |
| SelectionByManuallyCreatedIndicator | Selection of all the designs created manually |
| SelectionByAssemblyIndicator | Selection of all the designs for which the product is assembly |
| SelectionByMostRecentlyCreatedIndicator | Selection of all the designs created recently |
| SelectionByValidityStartDate | Selection of all the designs whose validity starts from the specified date |
| SelectionByActivationDate | Selection of all the designs which are activated on the specified date |
| SelectionByProductDesignResponsibleEmployeeID | Selection of all the designs created by specified Employee ID |
| SelectionByProductDesignResponsibleEmployeePersonGivenName | Selection by the given name of the responsible person |
| SelectionByProductDesignResponsibleEmployeePersonFamilyName | Selection by the given name of the responsible person |
| SelectionBySystemAdministrativeDataCreationDateTime | Selection of all Product Designs that were created since the specified date |
| SelectionBySystemAdministrativeDataCreationIdentityUUID | Selection of the Product Designs created by specified UUID |
| SelectionBySystemAdministrativeDataCreationIdentityID | Selection of the Product Designs created by specified ID |
| SelectionBySystemAdministrativeDataCreationIdentityBusinessPartnerInternalID | Selection of the Product Designs created by specified Business Partner Internal ID |
| SelectionBySystemAdministrativeDataCreationIdentityBusinessPartnerPersonFamilyName | Selection of the Product Designs created by specified Business Partner Family Name |
| SelectionBySystemAdministrativeDataCreationIdentityBusinessPartnerPersonGivenName | Selection of the Product Designs created by specified Business Partner Given Name |
| SelectionBySystemAdministrativeDataCreationIdentityEmployeeID | Selection of the Product Designs created by specified Employee ID |
| SelectionBySystemAdministrativeDataLastChangeDateTime | Selection of the Product Designs last changed on specified Date |
| SelectionBySystemAdministrativeDataLastChangeIdentityUUID | Selection of the Product Designs last changed by specified UUID |
| SelectionBySystemAdministrativeDataLastChangeIdentityID | Selection of the Product Designs last changed by specified ID |
| SelectionBySystemAdministrativeDataLastChangeIdentityBusinessPartnerInternalID | Selection of the Product Designs last changed by specified Business Partner Internal ID |
| SelectionBySystemAdministrativeDataLastChangeIdentityBusinessPartnerPersonFamilyName | Selection of the Product Designs last changed by specified Business Partner Family Name |
| SelectionBySystemAdministrativeDataLastChangeIdentityBusinessPartnerPersonGivenName | Selection of the Product Designs last changed by specified Business Partner Given Name |
| SelectionBySystemAdministrativeDataLastChangeIdentityEmployeeID | Selection of the Product Designs last changed by specified Employee ID |
| SelectionByProductDesignVersionComponentProductDesignVersionKeyProductDesignID | Selection by Product Design Version Component Product Design Version Key Product Design ID |
| SelectionByProductDesignVersionComponentProductDesignVersionKeyProductDesignVersionID | Selection by Product Design Version Component Product Design Version Key Product Design Version ID |
| SelectionByProductKeyProductTypeCode | Selection by Product Type Code |
| SelectionByProductKeyProductIdentifierTypeCode | Selection by Product Identifier Type Code |
| SelectionByProductKeyProductID | Selection by Product ID |
| SelectionByProductDescription | Selection by Product Description |
| SelectionByProductDesignEngineeringDesignBusinessSystemID | Selection by Engineering Design Business System ID |
| SelectionByProductDesignEngineeringDesignBusinessSystemName | Selection By Engineering Design Business System Name |
| SelectionByProductDesignEngineeringDesignID | Selection By Engineering Design ID |
| SelectionByProductDesignEngineeringDesignInternalID | Selection By Engineering Design Internal ID |
| SelectionByEngineeringDesignVersionID | Selection By Engineering Design Version ID |
| SelectionByEngineeringDesignVersionInternalID | Selection By Engineering Design Version Internal ID |
| SelectionByEngineeringDesignVersionStatusName | Selection By Engineering Design Version Status Name |
| SelectionByEngineeringDesignVersionReplicationCancelledIndicator | Selection By Engineering Design Version Replication Cancelled Indicator |
| SelectionByEngineeringDesignVersionResponsibleEngineerPersonFamilyName | Selection By Engineering Design Version Responsible Engineer Person Family Name |
| SelectionByEngineeringDesignVersionResponsibleEngineerPersonGivenName | Selection By Engineering Design Version Responsible Engineer Person Family Name |
| SelectionByEngineeringDesignChangeOrderID | Selection By Engineering Design Change Order ID |
| SelectionByProductionBillOfMaterialVariantKeyBillOfMaterialVariantID | Selection By Product BoM Variant Key BoM Variant ID |
| SelectionByProductionBillOfMaterialVariantKeyBillOfMaterialID | Selection By Product BoM Variant Key BoM ID |
| SelectionBySearchText | Basic Search |
The following table shows the list of attributes under the node PROCESSING_CONDITIONS for the request message types that can be used for executing the query:
| Attributes | Remarks |
|---|---|
| QueryHitsMaximumNumberValue | Maximum number of hits to be returned by query |
| QueryHitsUnlimitedIndicator | Indicator to be set true if unlimited hits is expected |
| LastReturnedObjectID | Returns the ID of the last object |
The response contains the list of found product designs, log items, and processing conditions.
The following table shows the list of attributes of the node BODY of the product designs that the query returns:
| Selection Parameters | Remarks |
|---|---|
| ProductDesignUUID | UUID of the Product Design |
| ProductDesignID | ID of the Product Design |
| UUID | UUID of the Version of the Product Design |
| ID | ID of the Version of the Product Design |
| Name | Name of the Product Design |
| EngineeringDesignVersionIdentification | Engineering Design Version Identification |
| ManuallyCreatedIndicator | Indicator for Product Design created manually |
| AssemblyIndicator | Assembly Indicator |
| PredecessorVersionUUID | UUID of the Predecessor Version of the Product Design |
| PredecessorVersionEngineeringDesignVersionIdentification | Engineering Design Version ID of the Predecessor |
| BaseQuantity | Base Quantity of the Product Design Version |
| BaseQuantityTypeCode | Type Code of the Base Quantity |
| BaseQuantityTypeName | Type code name of the Base Quantity |
| ProposedProcurementMethodCode | Method Code for the Proposed Procurement |
| ProposedProcurementMethodName | Method Name for the Proposed Procurement |
| ValidityStartDate | Validity Start Date of the Product Design Version |
| ActivationDate | Activation Date for the Product Design Version |
| ActivationTime | Activation time for the Product Design Version |
| EngineeringDesignVersionStatusName | Engineering Design Version Status Name |
| EngineeringDesignVersionReleaseDate | Engineering Design Version Release Date |
| EngineeringDesignVersionResponsibleEngineerPersonGivenName | Given Name of the responsible person for Engineering Design Version |
| EngineeringDesignVersionResponsibleEngineerPersonFamilyName | Family Name of the responsible person for Engineering Design Version |
| EngineeringDesignVersionReplicationCancelledIndicator | Replication Canceled Indicator for the Engineering Design Version |
| EngineeringDesignVersionPrimaryViewableCreationDateTime | Primary Viewable Creation Date Time of the Engineering Design Version |
| EngineeringDesignChangeOrderID | Change Order ID of the Engineering Design |
| ApplicationLogUUID | UUID of the Application Log |
| EngineeringDesignVersionCreationDateTime | Creation Date Time of the Engineering Design Version |
| EngineeringDesignVersionLastChangeDateTime | Last Change Date Time of the Engineering Design Version |
| SystemAdministrativeData | System Administrative Data |
| Status | Response Status of the Product Design Version |
The following table shows the list of attributes of the node PROCESSING_CONDITIONS of the product designs that the query returns:
| Attributes | Remarks |
|---|---|
| RETURNED_QUERY_HITS_NUMBER_VAL | Total Number of Hits returned by the Query |
| MORE_HITS_AVAILABLE_INDICATOR | Indicator if there are more Hits available apart from what has been shown |
| LAST_RETURNED_OBJECT_ID | ID of the Last Returned Object |
The Product Design can be created or updated by the asynchronous service Product Design Replication Request. In most cases, there will be a corresponding object in the engineering system. In the service definition and in this document, the corresponding object of the engineering system is called Engineering Design. In concrete systems, this object would be called differently, for example, Engineering BOM, Assembly, Part, or Item.
The logical communication takes place between the objects Engineering Design and Product Design. In SAP Business ByDesign, materials can be assigned to Product Designs, and Product Designs can be converted into Production Bills of Material Variants. Production Bills of Material Variants are not created directly using the inbound interface, but require additional steps on the SAP Business ByDesign side.
An Engineering Design cannot be assigned to more than one Product Design. In addition, one Product Design can refer to only one Engineering Design.
If an Engineering Design is not assigned to a Product Design, this means that the Engineering Design has not been replicated in SAP Business ByDesign. The second Engineering Design is assigned to a Product Design in SAP Business ByDesign. This assignment cannot be changed later, and the Engineering Design cannot be assigned to another Product Design. The last Product Design has no reference to an Engineering Design, which means that this Product Design has been created manually in SAP Business ByDesign.
Besides the mapping between an Engineering Design and a Product Design, there is also the mapping between an Engineering Design Version and a Product Design Version. In existing engineering systems Engineering Design Version may represent a version, a revision or another entity. Once a Product Design Version has been assigned to an Engineering Design Version via the CAD-integration interface, the assignment cannot be changed any longer.
Each Product Design must have at least one version in order to be displayed in the UI. Similar to the mapping between Engineering Design and Product Design, a version of an Engineering Design can be assigned at maximum to one version of a Product Design and vice versa.
Not all versions of an Engineering Design need to be replicated in SAP Business ByDesign. On the other hand, it is possible to manually create a version for a Product Design that refers to an Engineering Design.
Example xml of the Request message when the query is based on Status:
<n0:ProductDesignVersionSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ProductDesignVersionSimpleSelectionByElements> <SelectionByLifeCycleStatusCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLifeCycleStatusCode>4</LowerBoundaryLifeCycleStatusCode> </SelectionByLifeCycleStatusCode> </ProductDesignVersionSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>529</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID schemeID="Token 530" schemeVersionID="Token 531" schemeAgencyID="Token 532" schemeAgencySchemeID="Token 533" schemeAgencySchemeAgencyID="Tok"></LastReturnedObjectID> </ProcessingConditions> </n0:ProductDesignVersionSimpleByElementsQuery_sync>
Response message:
- <nm:ProductDesignVersionSimpleByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TASD5D529C361A3DF4A2645:804"> - <ProductDesignVersion> <ProductDesignUUID>00163e02-86fa-1ee1-b2ca-3612c91e179e</ProductDesignUUID> <ProductDesignID>RTRHYH</ProductDesignID> <UUID>00163e02-86fa-1ee1-b2ca-37229fe7579e</UUID> <ID>1</ID> <Name>5tgt</Name> - <EngineeringDesignVersionIdentification> <EngineeringDesignVersionID>5th55t</EngineeringDesignVersionID> </EngineeringDesignVersionIdentification> <ManuallyCreatedIndicator>true</ManuallyCreatedIndicator> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> <BaseQuantityTypeName>each</BaseQuantityTypeName> <ValidityStartDate>2012-07-10</ValidityStartDate> <ActivationDate>2012-07-10</ActivationDate> <ActivationTime>05:41:18</ActivationTime> - <SystemAdministrativeData> <CreationDateTime>2012-07-10T05:40:35.565443Z</CreationDateTime> <CreationIdentityUUID>00163e02-870c-1ee1-9ce8-486c317665e6</CreationIdentityUUID> <LastChangeDateTime>2012-07-10T05:41:18.929731Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-870c-1ee1-9ce8-486c317665e6</LastChangeIdentityUUID> </SystemAdministrativeData> - <Status> <LifeCycleStatusCode>4</LifeCycleStatusCode> <LifeCycleStatusName>Active</LifeCycleStatusName> <ObsolescenceStatusCode>1</ObsolescenceStatusCode> <ObsolescenceStatusName>Not Obsolete</ObsolescenceStatusName> <BlockingStatusCode>1</BlockingStatusCode> <BlockingStatusName>Not Blocked</BlockingStatusName> <ReviewProcessingStatusCode>1</ReviewProcessingStatusCode> <ReviewProcessingStatusName>Not Started</ReviewProcessingStatusName> <ActivationStatusCode>1</ActivationStatusCode> <ActivationStatusName>Active</ActivationStatusName> <ConsistencyStatusCode>3</ConsistencyStatusCode> <ConsistencyStatusName>Consistent</ConsistencyStatusName> <ExecutionUsageBlockingStatusCode>1</ExecutionUsageBlockingStatusCode> <ExecutionUsageBlockingStatusName>Not Blocked</ExecutionUsageBlockingStatusName> </Status> </ProductDesignVersion> - <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> </ProcessingConditions> - <Log> <MaximumLogItemSeverityCode>1</MaximumLogItemSeverityCode> - <Item> <TypeID>009(/CSG_RUNTIME/)</TypeID> <SeverityCode>1</SeverityCode> <Note>Query returned 1 records</Note> </Item> </Log> </nm:ProductDesignVersionSimpleByElementsResponse_sync>
Show full documentation
Show full documentation