vdm/attachment-service | SAP Cloud SDK for JavaScript / TypeScript

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ReadAttachmentServiceRequestBuilder

ReadAttachmentServiceRequestBuilder: GetAllRequestBuilderV2<AttachmentContentSet> | GetAllRequestBuilderV2<SapObjectDocumentTypeSet> | GetAllRequestBuilderV2<AttachmentHarmonizedOperationSet> | GetAllRequestBuilderV2<DocumentInfoRecordAttch> | GetByKeyRequestBuilderV2<AttachmentContentSet> | GetByKeyRequestBuilderV2<SapObjectDocumentTypeSet> | GetByKeyRequestBuilderV2<AttachmentHarmonizedOperationSet> | GetByKeyRequestBuilderV2<DocumentInfoRecordAttch>

WriteAttachmentServiceRequestBuilder

WriteAttachmentServiceRequestBuilder: CreateRequestBuilderV2<AttachmentContentSet> | UpdateRequestBuilderV2<AttachmentContentSet> | DeleteRequestBuilderV2<AttachmentContentSet> | CreateRequestBuilderV2<SapObjectDocumentTypeSet> | UpdateRequestBuilderV2<SapObjectDocumentTypeSet> | DeleteRequestBuilderV2<SapObjectDocumentTypeSet> | CreateRequestBuilderV2<AttachmentHarmonizedOperationSet> | UpdateRequestBuilderV2<AttachmentHarmonizedOperationSet> | DeleteRequestBuilderV2<AttachmentHarmonizedOperationSet> | CreateRequestBuilderV2<DocumentInfoRecordAttch> | UpdateRequestBuilderV2<DocumentInfoRecordAttch> | DeleteRequestBuilderV2<DocumentInfoRecordAttch>

Variables

Const defaultAttachmentServicePath

defaultAttachmentServicePath: "/sap/opu/odata/sap/API_CV_ATTACHMENT_SRV" = '/sap/opu/odata/sap/API_CV_ATTACHMENT_SRV'

Const functionImports

functionImports: { assignDocumentToBusinessObject: (parameters: AssignDocumentToBusinessObjectParameters) => FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>; createUrlAsAttachment: (parameters: CreateUrlAsAttachmentParameters) => FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>; getAllOriginals: (parameters: GetAllOriginalsParameters) => FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>; getAttachmentCount: (parameters: GetAttachmentCountParameters) => FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>; getSapObjectDocumentType: (parameters: GetSapObjectDocumentTypeParameters) => FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>; linkAttachmentToSapObject: (parameters: LinkAttachmentToSapObjectParameters) => FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>; renameAttachment: (parameters: RenameAttachmentParameters) => FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet> } = ...

Type declaration

assignDocumentToBusinessObject: (parameters: AssignDocumentToBusinessObjectParameters) => FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>
- - (parameters: AssignDocumentToBusinessObjectParameters): FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>
  - Assigns documents to business objects.
    
    Parameters
    - parameters: AssignDocumentToBusinessObjectParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
createUrlAsAttachment: (parameters: CreateUrlAsAttachmentParameters) => FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>
- - (parameters: CreateUrlAsAttachmentParameters): FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>
  - Uploads a URL as an attachment for a business object.
    
    Parameters
    - parameters: CreateUrlAsAttachmentParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
getAllOriginals: (parameters: GetAllOriginalsParameters) => FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>
- - (parameters: GetAllOriginalsParameters): FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>
  - Retrieves the metadata of the attachments associated with the business object.
    
    Parameters
    - parameters: GetAllOriginalsParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
getAttachmentCount: (parameters: GetAttachmentCountParameters) => FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>
- - (parameters: GetAttachmentCountParameters): FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>
  - Retrieves the number of attachments for a business object instance key.
    
    Parameters
    - parameters: GetAttachmentCountParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
getSapObjectDocumentType: (parameters: GetSapObjectDocumentTypeParameters) => FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>
- - (parameters: GetSapObjectDocumentTypeParameters): FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>
  - Reads the list of document types for a given SAP Object Type or SAP Object Node Type.
    
    Parameters
    - parameters: GetSapObjectDocumentTypeParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
linkAttachmentToSapObject: (parameters: LinkAttachmentToSapObjectParameters) => FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>
- - (parameters: LinkAttachmentToSapObjectParameters): FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>
  - Creates an object link between an attachment and business object.
    
    Parameters
    - parameters: LinkAttachmentToSapObjectParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
renameAttachment: (parameters: RenameAttachmentParameters) => FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>
- - (parameters: RenameAttachmentParameters): FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>
  - Renames an attachment that has been uploaded to a business object.
    
    Parameters
    - parameters: RenameAttachmentParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.

Functions

assignDocumentToBusinessObject

assignDocumentToBusinessObject(parameters: AssignDocumentToBusinessObjectParameters): FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>

- Defined in packages/vdm/attachment-service/function-imports.ts:306
Assigns documents to business objects.

Parameters
- parameters: AssignDocumentToBusinessObjectParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>

A request builder that allows to overwrite some of the values and execute the resulting request.

batch

batch(...requests: (ReadAttachmentServiceRequestBuilder | ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>)[]): ODataBatchRequestBuilderV2
batch(requests: (ReadAttachmentServiceRequestBuilder | ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>)[]): ODataBatchRequestBuilderV2

- Defined in packages/vdm/attachment-service/BatchRequest.ts:15
Batch builder for operations supported on the Attachment Service.

Parameters
- Rest ...requests: (ReadAttachmentServiceRequestBuilder | ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>)[]
  
  The requests of the batch
Returns ODataBatchRequestBuilderV2

A request builder for batch.
- Defined in packages/vdm/attachment-service/BatchRequest.ts:16
Parameters
- requests: (ReadAttachmentServiceRequestBuilder | ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>)[]
Returns ODataBatchRequestBuilderV2

changeset

changeset(...requests: WriteAttachmentServiceRequestBuilder[]): ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>
changeset(requests: WriteAttachmentServiceRequestBuilder[]): ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>

- Defined in packages/vdm/attachment-service/BatchRequest.ts:26
Change set constructor consists of write operations supported on the Attachment Service.

Parameters
- Rest ...requests: WriteAttachmentServiceRequestBuilder[]
  
  The requests of the change set
Returns ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>

A change set for batch.
- Defined in packages/vdm/attachment-service/BatchRequest.ts:27
Parameters
- requests: WriteAttachmentServiceRequestBuilder[]
Returns ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>

createAssignDocument

createAssignDocument(json: any): AssignDocument

- Defined in packages/vdm/attachment-service/AssignDocument.ts:21
deprecated

Since v1.6.0. Use AssignDocument.build instead.

Parameters
- json: any
Returns AssignDocument

createAttachmentsCount

createAttachmentsCount(json: any): AttachmentsCount

- Defined in packages/vdm/attachment-service/AttachmentsCount.ts:21
deprecated

Since v1.6.0. Use AttachmentsCount.build instead.

Parameters
- json: any
Returns AttachmentsCount

createUrlAsAttachment

createUrlAsAttachment(parameters: CreateUrlAsAttachmentParameters): FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>

- Defined in packages/vdm/attachment-service/function-imports.ts:370
Uploads a URL as an attachment for a business object.

Parameters
- parameters: CreateUrlAsAttachmentParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>

A request builder that allows to overwrite some of the values and execute the resulting request.

getAllOriginals

getAllOriginals(parameters: GetAllOriginalsParameters): FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>

- Defined in packages/vdm/attachment-service/function-imports.ts:45
Retrieves the metadata of the attachments associated with the business object.

Parameters
- parameters: GetAllOriginalsParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>

A request builder that allows to overwrite some of the values and execute the resulting request.

getAttachmentCount

getAttachmentCount(parameters: GetAttachmentCountParameters): FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>

- Defined in packages/vdm/attachment-service/function-imports.ts:89
Retrieves the number of attachments for a business object instance key.

Parameters
- parameters: GetAttachmentCountParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>

A request builder that allows to overwrite some of the values and execute the resulting request.

getSapObjectDocumentType

getSapObjectDocumentType(parameters: GetSapObjectDocumentTypeParameters): FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>

- Defined in packages/vdm/attachment-service/function-imports.ts:200
Reads the list of document types for a given SAP Object Type or SAP Object Node Type.

Parameters
- parameters: GetSapObjectDocumentTypeParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>

A request builder that allows to overwrite some of the values and execute the resulting request.

linkAttachmentToSapObject

linkAttachmentToSapObject(parameters: LinkAttachmentToSapObjectParameters): FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>

- Defined in packages/vdm/attachment-service/function-imports.ts:245
Creates an object link between an attachment and business object.

Parameters
- parameters: LinkAttachmentToSapObjectParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>

A request builder that allows to overwrite some of the values and execute the resulting request.

renameAttachment

renameAttachment(parameters: RenameAttachmentParameters): FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>

- Defined in packages/vdm/attachment-service/function-imports.ts:161
Renames an attachment that has been uploaded to a business object.

Parameters
- parameters: RenameAttachmentParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>

A request builder that allows to overwrite some of the values and execute the resulting request.

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ReadAttachmentServiceRequestBuilder

WriteAttachmentServiceRequestBuilder

Variables

Const defaultAttachmentServicePath

Const functionImports

Type declaration

assignDocumentToBusinessObject: (parameters: AssignDocumentToBusinessObjectParameters) => FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>

Parameters

parameters: AssignDocumentToBusinessObjectParameters

Returns FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>

createUrlAsAttachment: (parameters: CreateUrlAsAttachmentParameters) => FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>

Parameters

parameters: CreateUrlAsAttachmentParameters

Returns FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>

getAllOriginals: (parameters: GetAllOriginalsParameters) => FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>

Parameters

parameters: GetAllOriginalsParameters

Returns FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>

getAttachmentCount: (parameters: GetAttachmentCountParameters) => FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>

Parameters

parameters: GetAttachmentCountParameters

Returns FunctionImportRequestBuilderV2<GetAttachmentCountParameters, AttachmentsCount>

getSapObjectDocumentType: (parameters: GetSapObjectDocumentTypeParameters) => FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>

Parameters

parameters: GetSapObjectDocumentTypeParameters

Returns FunctionImportRequestBuilderV2<GetSapObjectDocumentTypeParameters, SapObjectDocumentTypeSet[]>

linkAttachmentToSapObject: (parameters: LinkAttachmentToSapObjectParameters) => FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>

Parameters

parameters: LinkAttachmentToSapObjectParameters

Returns FunctionImportRequestBuilderV2<LinkAttachmentToSapObjectParameters, AttachmentHarmonizedOperationSet>

renameAttachment: (parameters: RenameAttachmentParameters) => FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>

Parameters

parameters: RenameAttachmentParameters

Returns FunctionImportRequestBuilderV2<RenameAttachmentParameters, AttachmentContentSet>

Functions

assignDocumentToBusinessObject

Parameters

parameters: AssignDocumentToBusinessObjectParameters

Returns FunctionImportRequestBuilderV2<AssignDocumentToBusinessObjectParameters, AssignDocument>

batch

Parameters

Rest ...requests: (ReadAttachmentServiceRequestBuilder | ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>)[]

Returns ODataBatchRequestBuilderV2

Parameters

requests: (ReadAttachmentServiceRequestBuilder | ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>)[]

Returns ODataBatchRequestBuilderV2

changeset

Parameters

Rest ...requests: WriteAttachmentServiceRequestBuilder[]

Returns ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>

Parameters

requests: WriteAttachmentServiceRequestBuilder[]

Returns ODataBatchChangeSetV2<WriteAttachmentServiceRequestBuilder>

createAssignDocument

Parameters

json: any

Returns AssignDocument

createAttachmentsCount

Parameters

json: any

Returns AttachmentsCount

createUrlAsAttachment

Parameters

parameters: CreateUrlAsAttachmentParameters

Returns FunctionImportRequestBuilderV2<CreateUrlAsAttachmentParameters, AttachmentContentSet>

getAllOriginals

Parameters

parameters: GetAllOriginalsParameters

Returns FunctionImportRequestBuilderV2<GetAllOriginalsParameters, AttachmentContentSet[]>

getAttachmentCount

Parameters

parameters: GetAttachmentCountParameters