@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultDocumentManagementService") public class DefaultDocumentManagementService extends Object implements DocumentManagementService
The service contains header data of the document info record (DIR), description, object link information for BOM, product, and change record, classification details for class and characteristics, and value help for document status as nodes. All the information can be sent as part of the request payload, which is then used to maintain the DIR, including appropriate checks for restricted values and authorizations. The data associated to the document info record is sent in the response. If there are any issues in the request such as wrong values or insufficient information, the system displays error messages in the response. .
Reference: SAP API Business Hub
OData Service: | API_DMS_PROCESS_SRV |
API Version: | 1 |
Communication Scenario: | Product Lifecycle Management - Master Data Integration (SAP_COM_0105) |
Scope Items: | Engineering Bill of Material - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3), Change Manufacturing Bill of Material for Production (3LO), Mass Change Manufacturing Bill of Material for Production (3LP), Make-to-Order Production - Finished Goods Sales and Final Assembly (BJE) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | DocumentInfoRecord |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultDocumentManagementService()
Creates a service using
DocumentManagementService.DEFAULT_SERVICE_PATH to send the requests. |
public DefaultDocumentManagementService()
DocumentManagementService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultDocumentManagementService withServicePath(@Nonnull String servicePath)
DocumentManagementService
withServicePath
in interface DocumentManagementService
servicePath
- Service path that will override the default.@Nonnull public DefaultDocumentManagementServiceBatch batch()
batch
in interface BatchService<DocumentManagementServiceBatch>
@Nonnull public DocInfoRecdObjLinkBOMFluentHelper getAllDocInfoRecdObjLinkBOM()
DocumentManagementService
DocInfoRecdObjLinkBOM
entities.getAllDocInfoRecdObjLinkBOM
in interface DocumentManagementService
DocInfoRecdObjLinkBOM
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkBOMByKeyFluentHelper getDocInfoRecdObjLinkBOMByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
DocumentManagementService
DocInfoRecdObjLinkBOM
entity using key fields.getDocInfoRecdObjLinkBOMByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
linkedSAPObject
- Database table of the master record that is linked to the document.
Constraints: Not nullable, Maximum length: 10
linkedSAPObjectKey
- Number which identifies the master record of an object that is allocated to a document.
Constraints: Not nullable, Maximum length: 90
docObjectLinkCounter
- Counter key
Constraints: Not nullable, Maximum length: 4
DocInfoRecdObjLinkBOM
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkChgRecdFluentHelper getAllDocInfoRecdObjLinkChgRecd()
DocumentManagementService
DocInfoRecdObjLinkChgRecd
entities.getAllDocInfoRecdObjLinkChgRecd
in interface DocumentManagementService
DocInfoRecdObjLinkChgRecd
entities. This fluent helper allows methods which modify the underlying query
to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkChgRecdByKeyFluentHelper getDocInfoRecdObjLinkChgRecdByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
DocumentManagementService
DocInfoRecdObjLinkChgRecd
entity using key fields.getDocInfoRecdObjLinkChgRecdByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
linkedSAPObject
- Database table of the master record that is linked to the document.
Constraints: Not nullable, Maximum length: 10
linkedSAPObjectKey
- Number which identifies the master record of an object that is allocated to a document.
Constraints: Not nullable, Maximum length: 90
docObjectLinkCounter
- Counter key
Constraints: Not nullable, Maximum length: 4
DocInfoRecdObjLinkChgRecd
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkProductFluentHelper getAllDocInfoRecdObjLinkProduct()
DocumentManagementService
DocInfoRecdObjLinkProduct
entities.getAllDocInfoRecdObjLinkProduct
in interface DocumentManagementService
DocInfoRecdObjLinkProduct
entities. This fluent helper allows methods which modify the underlying query
to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkProductByKeyFluentHelper getDocInfoRecdObjLinkProductByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
DocumentManagementService
DocInfoRecdObjLinkProduct
entity using key fields.getDocInfoRecdObjLinkProductByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
linkedSAPObject
- Database table of the master record that is linked to the document.
Constraints: Not nullable, Maximum length: 10
linkedSAPObjectKey
- Number which identifies the master record of an object that is allocated to a document.
Constraints: Not nullable, Maximum length: 90
docObjectLinkCounter
- Counter key
Constraints: Not nullable, Maximum length: 4
DocInfoRecdObjLinkProduct
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkProductCreateFluentHelper createDocInfoRecdObjLinkProduct(@Nonnull DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)
DocumentManagementService
DocInfoRecdObjLinkProduct
entity and save it to the S/4HANA system.createDocInfoRecdObjLinkProduct
in interface DocumentManagementService
docInfoRecdObjLinkProduct
- DocInfoRecdObjLinkProduct
entity object that will be created in the S/4HANA system.DocInfoRecdObjLinkProduct
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocInfoRecdObjLinkProductDeleteFluentHelper deleteDocInfoRecdObjLinkProduct(@Nonnull DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)
DocumentManagementService
DocInfoRecdObjLinkProduct
entity in the S/4HANA system.deleteDocInfoRecdObjLinkProduct
in interface DocumentManagementService
docInfoRecdObjLinkProduct
- DocInfoRecdObjLinkProduct
entity object that will be deleted in the S/4HANA system.DocInfoRecdObjLinkProduct
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordFluentHelper getAllDocumentInfoRecord()
DocumentManagementService
DocumentInfoRecord
entities.getAllDocumentInfoRecord
in interface DocumentManagementService
DocumentInfoRecord
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordByKeyFluentHelper getDocumentInfoRecordByKey(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String documentInfoRecordDocNumber, String documentInfoRecordDocPart)
DocumentManagementService
DocumentInfoRecord
entity using key fields.getDocumentInfoRecordByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
DocumentInfoRecord
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordCreateFluentHelper createDocumentInfoRecord(@Nonnull DocumentInfoRecord documentInfoRecord)
DocumentManagementService
DocumentInfoRecord
entity and save it to the S/4HANA system.createDocumentInfoRecord
in interface DocumentManagementService
documentInfoRecord
- DocumentInfoRecord
entity object that will be created in the S/4HANA system.DocumentInfoRecord
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordUpdateFluentHelper updateDocumentInfoRecord(@Nonnull DocumentInfoRecord documentInfoRecord)
DocumentManagementService
DocumentInfoRecord
entity and save it to the S/4HANA system.updateDocumentInfoRecord
in interface DocumentManagementService
documentInfoRecord
- DocumentInfoRecord
entity object that will be updated in the S/4HANA system.DocumentInfoRecord
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordCharcFluentHelper getAllDocumentInfoRecordCharc()
DocumentManagementService
DocumentInfoRecordCharc
entities.getAllDocumentInfoRecordCharc
in interface DocumentManagementService
DocumentInfoRecordCharc
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordCharcByKeyFluentHelper getDocumentInfoRecordCharcByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String charcInternalID, String classType)
DocumentManagementService
DocumentInfoRecordCharc
entity using key fields.getDocumentInfoRecordCharcByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
classType
- Uniquely identifies the class type
Constraints: Not nullable, Maximum length: 3
DocumentInfoRecordCharc
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordCharcValueFluentHelper getAllDocumentInfoRecordCharcValue()
DocumentManagementService
DocumentInfoRecordCharcValue
entities.getAllDocumentInfoRecordCharcValue
in interface DocumentManagementService
DocumentInfoRecordCharcValue
entities. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordCharcValueByKeyFluentHelper getDocumentInfoRecordCharcValueByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classType, String charcInternalID, String charcValuePositionNumber)
DocumentManagementService
DocumentInfoRecordCharcValue
entity using key fields.getDocumentInfoRecordCharcValueByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
classType
- Uniquely identifies the class type
Constraints: Not nullable, Maximum length: 3
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
charcValuePositionNumber
- Characteristic value counter
Constraints: Not nullable, Maximum length: 3
DocumentInfoRecordCharcValue
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordClassFluentHelper getAllDocumentInfoRecordClass()
DocumentManagementService
DocumentInfoRecordClass
entities.getAllDocumentInfoRecordClass
in interface DocumentManagementService
DocumentInfoRecordClass
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordClassByKeyFluentHelper getDocumentInfoRecordClassByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID)
DocumentManagementService
DocumentInfoRecordClass
entity using key fields.getDocumentInfoRecordClassByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
classInternalID
- Internal Class Number
Constraints: Not nullable, Maximum length: 10
DocumentInfoRecordClass
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordClassCharcFluentHelper getAllDocumentInfoRecordClassCharc()
DocumentManagementService
DocumentInfoRecordClassCharc
entities.getAllDocumentInfoRecordClassCharc
in interface DocumentManagementService
DocumentInfoRecordClassCharc
entities. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordClassCharcByKeyFluentHelper getDocumentInfoRecordClassCharcByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID, String charcInternalID)
DocumentManagementService
DocumentInfoRecordClassCharc
entity using key fields.getDocumentInfoRecordClassCharcByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
classInternalID
- Internal Class Number
Constraints: Not nullable, Maximum length: 10
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
DocumentInfoRecordClassCharc
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDescFluentHelper getAllDocumentInfoRecordDesc()
DocumentManagementService
DocumentInfoRecordDesc
entities.getAllDocumentInfoRecordDesc
in interface DocumentManagementService
DocumentInfoRecordDesc
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDescByKeyFluentHelper getDocumentInfoRecordDescByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String language)
DocumentManagementService
DocumentInfoRecordDesc
entity using key fields.getDocumentInfoRecordDescByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocVersion
- Number which identifies the version of a document.
Constraints: Not nullable, Maximum length: 2
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.
Constraints: Not nullable, Maximum length: 3
language
- Key for the language in which you want to maintain the text.
Constraints: Not nullable, Maximum length: 2
DocumentInfoRecordDesc
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDescCreateFluentHelper createDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
DocumentManagementService
DocumentInfoRecordDesc
entity and save it to the S/4HANA system.createDocumentInfoRecordDesc
in interface DocumentManagementService
documentInfoRecordDesc
- DocumentInfoRecordDesc
entity object that will be created in the S/4HANA system.DocumentInfoRecordDesc
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDescUpdateFluentHelper updateDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
DocumentManagementService
DocumentInfoRecordDesc
entity and save it to the S/4HANA system.updateDocumentInfoRecordDesc
in interface DocumentManagementService
documentInfoRecordDesc
- DocumentInfoRecordDesc
entity object that will be updated in the S/4HANA system.DocumentInfoRecordDesc
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDescDeleteFluentHelper deleteDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
DocumentManagementService
DocumentInfoRecordDesc
entity in the S/4HANA system.deleteDocumentInfoRecordDesc
in interface DocumentManagementService
documentInfoRecordDesc
- DocumentInfoRecordDesc
entity object that will be deleted in the S/4HANA system.DocumentInfoRecordDesc
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDocStsVHFluentHelper getAllDocumentInfoRecordDocStsVH()
DocumentManagementService
DocumentInfoRecordDocStsVH
entities.getAllDocumentInfoRecordDocStsVH
in interface DocumentManagementService
DocumentInfoRecordDocStsVH
entities. This fluent helper allows methods which modify the underlying query
to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public DocumentInfoRecordDocStsVHByKeyFluentHelper getDocumentInfoRecordDocStsVHByKey(String documentInfoRecordDocType, String language, String externalDocumentStatus)
DocumentManagementService
DocumentInfoRecordDocStsVH
entity using key fields.getDocumentInfoRecordDocStsVHByKey
in interface DocumentManagementService
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.
Constraints: Not nullable, Maximum length: 3
language
- Key for the language in which you want to maintain the text.
Constraints: Not nullable, Maximum length: 2
externalDocumentStatus
- This key shows the document status.
Constraints: Not nullable, Maximum length: 2
DocumentInfoRecordDocStsVH
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.