Module @sap/cloud-sdk-vdm-attachment-service

Index

References

Namespaces

AttachmentsCount

Classes

Interfaces

Type aliases

Variables

defaultAttachmentServicePath

Functions

Object literals

functionImports

References

AttachmentContentSet

Re-exports AttachmentContentSet

AttachmentContentSetRequestBuilder

Re-exports AttachmentContentSetRequestBuilder

AttachmentContentSetType

Re-exports AttachmentContentSetType

AttachmentContentSetTypeForceMandatory

Re-exports AttachmentContentSetTypeForceMandatory

AttachmentsCount

Re-exports AttachmentsCount

AttachmentsCountField

Re-exports AttachmentsCountField

CreateUrlAsAttachmentParameters

Re-exports CreateUrlAsAttachmentParameters

DocumentInfoRecordAttch

Re-exports DocumentInfoRecordAttch

DocumentInfoRecordAttchRequestBuilder

Re-exports DocumentInfoRecordAttchRequestBuilder

DocumentInfoRecordAttchType

Re-exports DocumentInfoRecordAttchType

DocumentInfoRecordAttchTypeForceMandatory

Re-exports DocumentInfoRecordAttchTypeForceMandatory

GetAllOriginalsParameters

Re-exports GetAllOriginalsParameters

GetAttachmentCountParameters

Re-exports GetAttachmentCountParameters

ReadAttachmentServiceRequestBuilder

Re-exports ReadAttachmentServiceRequestBuilder

RenameAttachmentParameters

Re-exports RenameAttachmentParameters

WriteAttachmentServiceRequestBuilder

Re-exports WriteAttachmentServiceRequestBuilder

batch

Re-exports batch

changeset

Re-exports changeset

createAttachmentsCount

Re-exports createAttachmentsCount

createUrlAsAttachment

Re-exports createUrlAsAttachment

defaultAttachmentServicePath

Re-exports defaultAttachmentServicePath

functionImports

Re-exports functionImports

getAllOriginals

Re-exports getAllOriginals

getAttachmentCount

Re-exports getAttachmentCount

renameAttachment

Re-exports renameAttachment

Type aliases

ReadAttachmentServiceRequestBuilder

ReadAttachmentServiceRequestBuilder: GetAllRequestBuilder<AttachmentContentSet> | GetAllRequestBuilder<DocumentInfoRecordAttch> | GetByKeyRequestBuilder<AttachmentContentSet> | GetByKeyRequestBuilder<DocumentInfoRecordAttch>

WriteAttachmentServiceRequestBuilder

WriteAttachmentServiceRequestBuilder: CreateRequestBuilder<AttachmentContentSet> | UpdateRequestBuilder<AttachmentContentSet> | DeleteRequestBuilder<AttachmentContentSet> | CreateRequestBuilder<DocumentInfoRecordAttch> | UpdateRequestBuilder<DocumentInfoRecordAttch> | DeleteRequestBuilder<DocumentInfoRecordAttch>

Variables

Const defaultAttachmentServicePath

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

Functions

batch

batch(...requests: Array<ReadAttachmentServiceRequestBuilder | ODataBatchChangeSet<WriteAttachmentServiceRequestBuilder>>): ODataBatchRequestBuilder

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

Parameters
- Rest ...requests: Array<ReadAttachmentServiceRequestBuilder | ODataBatchChangeSet<WriteAttachmentServiceRequestBuilder>>
  
  The requests of the batch
Returns ODataBatchRequestBuilder

A request builder for batch.

changeset

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

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

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

A change set for batch.

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): FunctionImportRequestBuilder<CreateUrlAsAttachmentParameters, AttachmentContentSet>

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

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

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

getAllOriginals

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

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

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

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

getAttachmentCount

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

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

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

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

renameAttachment

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

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

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

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

Object literals

Const functionImports

functionImports: object

createUrlAsAttachment

createUrlAsAttachment: createUrlAsAttachment

getAllOriginals

getAllOriginals: getAllOriginals

getAttachmentCount

getAttachmentCount: getAttachmentCount

renameAttachment

renameAttachment: renameAttachment