com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface AttachmentService

All Superinterfaces:

BatchService<AttachmentServiceBatch>

All Known Implementing Classes:

DefaultAttachmentService

public interface AttachmentService
extends BatchService<AttachmentServiceBatch>

This service enables you to manage Document Management (DMS), and Generic Object Services (GOS) based attachments, such as creating, reading, renaming, and deleting attachments. You can also read an existing document info record (DIR), and add attachments to it..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CV_ATTACHMENT_SRV
API Version:	1
Communication Scenario:	Purchase Requisition Integration (SAP_COM_0102), Distributed Manufacturing Integration (SAP_COM_0077), Product Lifecycle Management - Master Data Integration (SAP_COM_0105), Supplier Invoice Integration (SAP_COM_0057), Defect Processing Integration (SAP_COM_0153), Finance - Posting Integration (SAP_COM_0002), SAP S/4HANA Procurement Hub - Ariba GB - Hub to Ariba GB Integration (SAP_COM_0292), Legal Document Integration (SAP_COM_0178)
Scope Items:	Requisitioning (18J), Procure-to-Pay with SAP Ariba Buying and Invoicing (1ZM), Guided Buying Capability with SAP Ariba Buying (2NV), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45), Physical Inventory - Inventory Count and Adjustment (OML), Collaborative Manufacturing with SAP Digital Manufacturing Cloud (1NX), Engineering Bill of Material - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3), Procurement of Direct Materials (O45), Quality Management in Discrete Manufacturing (1E1), Quality Management in Procurement (1FM), Quality Management in Sales (1MP), Quality Management in Stock Handling (1MR), Nonconformance Management (2QN), Accounting and Financial Close (J58), Accounting and Financial Close (O58), SAP S/4HANA for Enterprise Contract Management (1XV)
Authentication Methods:	Basic, x509

Field Summary

Fields

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.

Method Summary

Modifier and Type	Method and Description
AttachmentContentCreateFluentHelper	createAttachmentContent(AttachmentContent attachmentContent) Create a new AttachmentContent entity and save it to the S/4HANA system.
DocumentInfoRecordAttchCreateFluentHelper	createDocumentInfoRecordAttch(DocumentInfoRecordAttch documentInfoRecordAttch) Create a new DocumentInfoRecordAttch 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.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final 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.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
AttachmentService withServicePath(@Nonnull
                                           String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

createAttachmentContent

@Nonnull
AttachmentContentCreateFluentHelper createAttachmentContent(@Nonnull
                                                                     AttachmentContent attachmentContent)

Create a new AttachmentContent entity and save it to the S/4HANA system.

Parameters:

attachmentContent - AttachmentContent entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new AttachmentContent entity. To perform execution, call the execute method on the fluent helper object.

deleteAttachmentContent

@Nonnull
AttachmentContentDeleteFluentHelper deleteAttachmentContent(@Nonnull
                                                                     AttachmentContent attachmentContent)

Deletes an existing AttachmentContent entity in the S/4HANA system.

Parameters:

attachmentContent - AttachmentContent entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing AttachmentContent entity. To perform execution, call the execute method on the fluent helper object.

getAllDocumentInfoRecordAttch

@Nonnull
DocumentInfoRecordAttchFluentHelper getAllDocumentInfoRecordAttch()

Fetch multiple DocumentInfoRecordAttch entities.

Returns:

A fluent helper to fetch multiple 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.

getDocumentInfoRecordAttchByKey

@Nonnull
DocumentInfoRecordAttchByKeyFluentHelper getDocumentInfoRecordAttchByKey(String documentInfoRecordDocType,
                                                                                  String documentInfoRecordDocNumber,
                                                                                  String documentInfoRecordDocVersion,
                                                                                  String documentInfoRecordDocPart)

Fetch a single DocumentInfoRecordAttch entity using key fields.

Parameters:

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

Returns:

A fluent helper to fetch a single 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.

createDocumentInfoRecordAttch

@Nonnull
DocumentInfoRecordAttchCreateFluentHelper createDocumentInfoRecordAttch(@Nonnull
                                                                                 DocumentInfoRecordAttch documentInfoRecordAttch)

Create a new DocumentInfoRecordAttch entity and save it to the S/4HANA system.

Parameters:

documentInfoRecordAttch - DocumentInfoRecordAttch entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new DocumentInfoRecordAttch entity. To perform execution, call the execute method on the fluent helper object.

getAllOriginals

@Nonnull
GetAllOriginalsFluentHelper getAllOriginals(String linkedSAPObjectKey,
                                                     String businessObjectTypeName,
                                                     String semanticObject)

Returns All Originals Related to a Parent Object

Creates a fluent helper for the GetAllOriginals OData function import.

Parameters:

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

businessObjectTypeName - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

Returns:

A fluent helper object that will execute the GetAllOriginals OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

getAttachmentCount

@Nonnull
GetAttachmentCountFluentHelper getAttachmentCount(String businessObjectTypeName,
                                                           String linkedSAPObjectKey,
                                                           String semanticObject)

Returns the Count of Attachments

Creates a fluent helper for the GetAttachmentCount OData function import.

Parameters:

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

businessObjectTypeName - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

Returns:

A fluent helper object that will execute the GetAttachmentCount OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

renameAttachment

@Nonnull
RenameAttachmentFluentHelper renameAttachment(String documentInfoRecordDocType,
                                                       String documentInfoRecordDocVersion,
                                                       String logicalDocument,
                                                       String archiveDocumentID,
                                                       String businessObjectTypeName,
                                                       String linkedSAPObjectKey,
                                                       String semanticObject,
                                                       String fileName,
                                                       String documentInfoRecordDocNumber,
                                                       String documentInfoRecordDocPart)

Rename Attachment

Creates a fluent helper for the RenameAttachment OData function import.

Parameters:

documentInfoRecordDocType - DocumentInfoRecordDocType

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: DocumentInfoRecordDocType

fileName - FileName

Constraints: Not nullable, Maximum length: 255

Original parameter name from the Odata EDM: FileName

documentInfoRecordDocNumber - DocumentInfoRecordDocNumber

Constraints: Nullable, Maximum length: 25

Original parameter name from the Odata EDM: DocumentInfoRecordDocNumber

documentInfoRecordDocPart - DocumentInfoRecordDocPart

Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: DocumentInfoRecordDocPart

archiveDocumentID - ArchiveDocumentID

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: ArchiveDocumentID

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

businessObjectTypeName - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

documentInfoRecordDocVersion - DocumentInfoRecordDocVersion

Constraints: Nullable, Maximum length: 2

Original parameter name from the Odata EDM: DocumentInfoRecordDocVersion

semanticObject - SemanticObject

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

logicalDocument - LogicalDocument

Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: LogicalDocument

Returns:

A fluent helper object that will execute the RenameAttachment OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

createUrlAsAttachment

@Nonnull
CreateUrlAsAttachmentFluentHelper createUrlAsAttachment(String semanticObject,
                                                                 String linkedSAPObjectKey,
                                                                 String businessObjectTypeName,
                                                                 String url,
                                                                 String urlDescription,
                                                                 String mIMEType)

Create URL as attachment

Creates a fluent helper for the CreateUrlAsAttachment OData function import.

Parameters:

linkedSAPObjectKey - LinkedSAPObjectKey

Constraints: Not nullable, Maximum length: 90

Original parameter name from the Odata EDM: LinkedSAPObjectKey

businessObjectTypeName - BusinessObjectTypeName

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BusinessObjectTypeName

urlDescription - UrlDescription

Constraints: Not nullable, Maximum length: 255

Original parameter name from the Odata EDM: UrlDescription

semanticObject - SemanticObject

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: SemanticObject

url - Url

Constraints: Not nullable, Maximum length: 255

Original parameter name from the Odata EDM: Url

mIMEType - MIMEType

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: MIMEType

Returns:

A fluent helper object that will execute the CreateUrlAsAttachment OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.