public interface AttachmentService
With this service, you can read, create, rename, and delete attachments.
Reference: SAP API Business Hub
OData Service: | API_CV_ATTACHMENT_SRV |
API Version: | 1 |
Communication Scenario: | Distributed Manufacturing Integration (SAP_COM_0077), Product Lifecycle Management - Master Data Integration (SAP_COM_0105) |
Scope Items: | 3D Printing On-Demand-Manufacturing Collaboration on HCP (1NX), Change Record based Product Data Management (1NF), Engineering Bill of Material Versions Management (1NR), Engineering Bill of Material Change Master Management (1R3) |
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. |
Modifier and Type | Method and Description |
---|---|
AttachmentContentCreateFluentHelper |
createAttachmentContent(AttachmentContent attachmentContent)
Create a new
AttachmentContent entity and save it to the S/4HANA system. |
CreateUrlAsAttachmentFluentHelper |
createUrlAsAttachment(String semanticObject,
String linkedSAPObjectKey,
String businessObjectTypeName,
String url,
String urlDescription,
String mIMEType)
Create URL as attachment
|
AttachmentContentDeleteFluentHelper |
deleteAttachmentContent(AttachmentContent attachmentContent)
Deletes an existing
AttachmentContent entity in the S/4HANA system. |
DocumentInfoRecordAttchFluentHelper |
getAllDocumentInfoRecordAttch()
Fetch multiple
DocumentInfoRecordAttch entities. |
GetAllOriginalsFluentHelper |
getAllOriginals(String linkedSAPObjectKey,
String businessObjectTypeName,
String semanticObject)
Returns All Originals Related to a Parent Object
|
GetAttachmentCountFluentHelper |
getAttachmentCount(String businessObjectTypeName,
String linkedSAPObjectKey,
String semanticObject)
Returns the Count of Attachments
|
DocumentInfoRecordAttchByKeyFluentHelper |
getDocumentInfoRecordAttchByKey(String documentInfoRecordDocType,
String documentInfoRecordDocNumber,
String documentInfoRecordDocVersion,
String documentInfoRecordDocPart)
Fetch a single
DocumentInfoRecordAttch entity using key fields. |
RenameAttachmentFluentHelper |
renameAttachment(String documentInfoRecordDocType,
String documentInfoRecordDocVersion,
String logicalDocument,
String archiveDocumentID,
String businessObjectTypeName,
String linkedSAPObjectKey,
String semanticObject,
String fileName,
String documentInfoRecordDocNumber,
String documentInfoRecordDocPart)
Rename Attachment
|
AttachmentService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path used to access the endpoint.AttachmentService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull AttachmentContentCreateFluentHelper createAttachmentContent(@Nonnull AttachmentContent attachmentContent)
AttachmentContent
entity and save it to the S/4HANA system.attachmentContent
- AttachmentContent
entity object that will be created in the S/4HANA system.AttachmentContent
entity. To perform execution, call the execute
method on the fluent helper object.@Nonnull AttachmentContentDeleteFluentHelper deleteAttachmentContent(@Nonnull AttachmentContent attachmentContent)
AttachmentContent
entity in the S/4HANA system.attachmentContent
- AttachmentContent
entity object that will be deleted in the S/4HANA system.AttachmentContent
entity. To perform execution, call the execute
method on the fluent helper object.@Nonnull DocumentInfoRecordAttchFluentHelper getAllDocumentInfoRecordAttch()
DocumentInfoRecordAttch
entities.DocumentInfoRecordAttch
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 DocumentInfoRecordAttchByKeyFluentHelper getDocumentInfoRecordAttchByKey(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart)
DocumentInfoRecordAttch
entity using key fields.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
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.Constraints: Not nullable, Maximum length: 3
documentInfoRecordDocVersion
- Number which identifies the version of a document.Constraints: Not nullable, Maximum length: 2
DocumentInfoRecordAttch
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 GetAllOriginalsFluentHelper getAllOriginals(String linkedSAPObjectKey, String businessObjectTypeName, String semanticObject)
Creates a fluent helper for the GetAllOriginals OData function import.
linkedSAPObjectKey
- LinkedSAPObjectKeyConstraints: Not nullable, Maximum length: 90
Original parameter name from the Odata EDM: LinkedSAPObjectKey
businessObjectTypeName
- BusinessObjectTypeNameConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: BusinessObjectTypeName
semanticObject
- SemanticObjectConstraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: SemanticObject
execute
method on the fluent helper object.@Nonnull GetAttachmentCountFluentHelper getAttachmentCount(String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject)
Creates a fluent helper for the GetAttachmentCount OData function import.
linkedSAPObjectKey
- LinkedSAPObjectKeyConstraints: Not nullable, Maximum length: 90
Original parameter name from the Odata EDM: LinkedSAPObjectKey
businessObjectTypeName
- BusinessObjectTypeNameConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: BusinessObjectTypeName
semanticObject
- SemanticObjectConstraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: SemanticObject
execute
method on the fluent helper object.@Nonnull RenameAttachmentFluentHelper renameAttachment(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String logicalDocument, String archiveDocumentID, String businessObjectTypeName, String linkedSAPObjectKey, String semanticObject, String fileName, String documentInfoRecordDocNumber, String documentInfoRecordDocPart)
Creates a fluent helper for the RenameAttachment OData function import.
documentInfoRecordDocType
- DocumentInfoRecordDocTypeConstraints: Nullable, Maximum length: 3
Original parameter name from the Odata EDM: DocumentInfoRecordDocType
fileName
- FileNameConstraints: Not nullable, Maximum length: 255
Original parameter name from the Odata EDM: FileName
documentInfoRecordDocNumber
- DocumentInfoRecordDocNumberConstraints: Nullable, Maximum length: 25
Original parameter name from the Odata EDM: DocumentInfoRecordDocNumber
documentInfoRecordDocPart
- DocumentInfoRecordDocPartConstraints: Nullable, Maximum length: 3
Original parameter name from the Odata EDM: DocumentInfoRecordDocPart
archiveDocumentID
- ArchiveDocumentIDConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: ArchiveDocumentID
linkedSAPObjectKey
- LinkedSAPObjectKeyConstraints: Not nullable, Maximum length: 90
Original parameter name from the Odata EDM: LinkedSAPObjectKey
businessObjectTypeName
- BusinessObjectTypeNameConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: BusinessObjectTypeName
documentInfoRecordDocVersion
- DocumentInfoRecordDocVersionConstraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: DocumentInfoRecordDocVersion
semanticObject
- SemanticObjectConstraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: SemanticObject
logicalDocument
- LogicalDocumentConstraints: Not nullable, Maximum length: 32
Original parameter name from the Odata EDM: LogicalDocument
execute
method on the fluent helper object.@Nonnull CreateUrlAsAttachmentFluentHelper createUrlAsAttachment(String semanticObject, String linkedSAPObjectKey, String businessObjectTypeName, String url, String urlDescription, String mIMEType)
Creates a fluent helper for the CreateUrlAsAttachment OData function import.
linkedSAPObjectKey
- LinkedSAPObjectKeyConstraints: Not nullable, Maximum length: 90
Original parameter name from the Odata EDM: LinkedSAPObjectKey
businessObjectTypeName
- BusinessObjectTypeNameConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: BusinessObjectTypeName
urlDescription
- UrlDescriptionConstraints: Not nullable, Maximum length: 255
Original parameter name from the Odata EDM: UrlDescription
semanticObject
- SemanticObjectConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: SemanticObject
url
- UrlConstraints: Not nullable, Maximum length: 255
Original parameter name from the Odata EDM: Url
mIMEType
- MIMETypeConstraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: MIMEType
execute
method on the fluent helper object.Copyright © 2018 SAP SE. All rights reserved.