public interface DocumentManagementService extends BatchService<DocumentManagementServiceBatch>
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 with 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: | OP_API_DMS_PROCESS_SRV_0001 |
API Version: | 1 |
Minimum ERP Version: | 2020 |
Authentication Methods: | Basic, x509 |
Business Object: | Document Info Record |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SERVICE_PATH
If no other path was provided via the
withServicePath(String) method, this is the default service path
used to access the endpoint. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull DocumentManagementService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull DocInfoRecdObjLinkBOMFluentHelper getAllDocInfoRecdObjLinkBOM()
DocInfoRecdObjLinkBOM
entities.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 DocInfoRecdObjLinkBOMByKeyFluentHelper getDocInfoRecdObjLinkBOMByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
DocInfoRecdObjLinkBOM
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
linkedSAPObjectKey
- Document Management Object Key
Constraints: Not nullable, Maximum length: 90
docObjectLinkCounter
- Counter key
Constraints: Not nullable, Maximum length: 4
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
linkedSAPObject
- Linked SAP Object
Constraints: Not nullable, Maximum length: 10
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 DocInfoRecdObjLinkChgRecdFluentHelper getAllDocInfoRecdObjLinkChgRecd()
DocInfoRecdObjLinkChgRecd
entities.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 DocInfoRecdObjLinkChgRecdByKeyFluentHelper getDocInfoRecdObjLinkChgRecdByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
DocInfoRecdObjLinkChgRecd
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
linkedSAPObjectKey
- Document Management Object Key
Constraints: Not nullable, Maximum length: 90
docObjectLinkCounter
- Counter key
Constraints: Not nullable, Maximum length: 4
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
linkedSAPObject
- Linked SAP Object
Constraints: Not nullable, Maximum length: 10
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 DocInfoRecdObjLinkProductFluentHelper getAllDocInfoRecdObjLinkProduct()
DocInfoRecdObjLinkProduct
entities.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 DocInfoRecdObjLinkProductByKeyFluentHelper getDocInfoRecdObjLinkProductByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter)
DocInfoRecdObjLinkProduct
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
linkedSAPObjectKey
- Document Management Object Key
Constraints: Not nullable, Maximum length: 90
docObjectLinkCounter
- Counter key
Constraints: Not nullable, Maximum length: 4
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
linkedSAPObject
- Linked SAP Object
Constraints: Not nullable, Maximum length: 10
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 DocInfoRecdObjLinkProductCreateFluentHelper createDocInfoRecdObjLinkProduct(@Nonnull DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)
DocInfoRecdObjLinkProduct
entity and save it to the S/4HANA system.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 DocInfoRecdObjLinkProductDeleteFluentHelper deleteDocInfoRecdObjLinkProduct(@Nonnull DocInfoRecdObjLinkProduct docInfoRecdObjLinkProduct)
DocInfoRecdObjLinkProduct
entity in the S/4HANA system.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 DocumentInfoRecordFluentHelper getAllDocumentInfoRecord()
DocumentInfoRecord
entities.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 DocumentInfoRecordByKeyFluentHelper getDocumentInfoRecordByKey(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String documentInfoRecordDocNumber, String documentInfoRecordDocPart)
DocumentInfoRecord
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
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 DocumentInfoRecordCreateFluentHelper createDocumentInfoRecord(@Nonnull DocumentInfoRecord documentInfoRecord)
DocumentInfoRecord
entity and save it to the S/4HANA system.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 DocumentInfoRecordUpdateFluentHelper updateDocumentInfoRecord(@Nonnull DocumentInfoRecord documentInfoRecord)
DocumentInfoRecord
entity and save it to the S/4HANA system.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 DocumentInfoRecordCharcFluentHelper getAllDocumentInfoRecordCharc()
DocumentInfoRecordCharc
entities.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 DocumentInfoRecordCharcByKeyFluentHelper getDocumentInfoRecordCharcByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String charcInternalID, String classType)
DocumentInfoRecordCharc
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
classType
- 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 DocumentInfoRecordCharcValueFluentHelper getAllDocumentInfoRecordCharcValue()
DocumentInfoRecordCharcValue
entities.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 DocumentInfoRecordCharcValueByKeyFluentHelper getDocumentInfoRecordCharcValueByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classType, String charcInternalID, String charcValuePositionNumber)
DocumentInfoRecordCharcValue
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
charcValuePositionNumber
- Characteristic value counter
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
classType
- Class Type
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 DocumentInfoRecordClassFluentHelper getAllDocumentInfoRecordClass()
DocumentInfoRecordClass
entities.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 DocumentInfoRecordClassByKeyFluentHelper getDocumentInfoRecordClassByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID)
DocumentInfoRecordClass
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
classInternalID
- Internal Class Number
Constraints: Not nullable, Maximum length: 10
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
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 DocumentInfoRecordClassCharcFluentHelper getAllDocumentInfoRecordClassCharc()
DocumentInfoRecordClassCharc
entities.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 DocumentInfoRecordClassCharcByKeyFluentHelper getDocumentInfoRecordClassCharcByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID, String charcInternalID)
DocumentInfoRecordClassCharc
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
charcInternalID
- Characteristic Internal ID
Constraints: Not nullable, Maximum length: 10
classInternalID
- Internal Class Number
Constraints: Not nullable, Maximum length: 10
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
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 DocumentInfoRecordDescFluentHelper getAllDocumentInfoRecordDesc()
DocumentInfoRecordDesc
entities.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 DocumentInfoRecordDescByKeyFluentHelper getDocumentInfoRecordDescByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String language)
DocumentInfoRecordDesc
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocNumber
- Document number
Constraints: Not nullable, Maximum length: 25
documentInfoRecordDocPart
- Document Part
Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Document Version
Constraints: Not nullable, Maximum length: 2
language
- Language
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 DocumentInfoRecordDescCreateFluentHelper createDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
DocumentInfoRecordDesc
entity and save it to the S/4HANA system.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 DocumentInfoRecordDescUpdateFluentHelper updateDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
DocumentInfoRecordDesc
entity and save it to the S/4HANA system.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 DocumentInfoRecordDescDeleteFluentHelper deleteDocumentInfoRecordDesc(@Nonnull DocumentInfoRecordDesc documentInfoRecordDesc)
DocumentInfoRecordDesc
entity in the S/4HANA system.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 DocumentInfoRecordDocStsVHFluentHelper getAllDocumentInfoRecordDocStsVH()
DocumentInfoRecordDocStsVH
entities.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 DocumentInfoRecordDocStsVHByKeyFluentHelper getDocumentInfoRecordDocStsVHByKey(String documentInfoRecordDocType, String language, String externalDocumentStatus)
DocumentInfoRecordDocStsVH
entity using key fields.documentInfoRecordDocType
- Document Type
Constraints: Not nullable, Maximum length: 3
externalDocumentStatus
- Status of a document (language-dependent)
Constraints: Not nullable, Maximum length: 2
language
- Language
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.