Content: Attachment Noun

The Attachment noun is used to model an attachment. An attachment is additional material that is associated with a business object. Attachments can be image files, documents, or URLs.

BOD Summary

Access Profile and Expression Builder columns are for Get BOD only.
BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
ProcessAttachment Add   Creates a new attachment. The request can create both the attachment asset and the attachment description for the attachment. The response returns the unique identifier of the created attachment. Request
Response

AttachmentFacadeClient.processAttachment()
Delete   Deletes an attachment. Request
Response

AttachmentFacadeClient.processAttachment()
ChangeAttachment Add /Attachment[]/AttachmentAsset[] Adds attachment assets to an attachment. Request
Response

AttachmentFacadeClient.changeAttachment()
Add /Attachment[]/AttachmentDescription[] Adds attachment descriptions to an attachment. Request
Response

AttachmentFacadeClient.changeAttachment()
Change /Attachment[] Changes the attachment. Request
Response

AttachmentFacadeClient.changeAttachment()
Change /Attachment[]/AttachmentAsset[] Changes the attachment assets of an attachment. Request
Response

AttachmentFacadeClient.changeAttachment()
Change /Attachment[]/AttachmentDescription[] Changes the attachment descriptions of an attachment. Request
Response

AttachmentFacadeClient.changeAttachment()
Delete /Attachment[]/AttachmentAsset[] Deletes the attachment assets from an attachment. Request
Response

AttachmentFacadeClient.changeAttachment()
GetAttachment IBM_Summary IBM_AttachmentWithAssets /Attachment/AttachmentIdentifier[UniqueID=] Retrieves an attachment using the unique identifier for the attachment. Request
Response

AttachmentFacadeClient.getAttachment()
IBM_Summary IBM_AttachmentWithAssets /Attachment/AttachmentAsset[StoreIdentifier[UniqueID=] and AttachmentAssetPath=] Retrieves the attachments to which an attachment asset is assigned. Request
Response

AttachmentFacadeClient.getAttachment()
IBM_Summary IBM_AttachmentWithAssets /Attachment Retrieves all attachments under the current store. Request
Response

AttachmentFacadeClient.getAttachment()

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile Data Returned
IBM_Summary
  • /Attachment/AttachmentIdentifier/UniqueID
  • /Attachment/AttachmentIdentifier/ExternalIdentifier/StoreIdentifier/UniqueID
  • /Attachment/AttachmentIdentifier/ExternalIdentifier/Identifier
  • /Attachment/AttachmentDescription@language
  • /Attachment/AttachmentDescription/Name
  • /Attachment/AttachmentDescription/ShortDescription
  • /Attachment/AttachmentDescription/LongDescription
IBM_AttachmentWithAssets
  • /Attachment/AttachmentIdentifier/UniqueID
  • /Attachment/AttachmentIdentifier/ExternalIdentifier/StoreIdentifier/UniqueID
  • /Attachment/AttachmentIdentifier/ExternalIdentifier/Identifier
  • /Attachment/AttachmentDescription@language
  • /Attachment/AttachmentDescription/Name
  • /Attachment/AttachmentDescription/ShortDescription
  • /Attachment/AttachmentDescription/LongDescription
  • /Attachment/AttachmentAsset/AttachmentAssetIdentifier/UniqueID
  • /Attachment/AttachmentAsset/StoreIdentifier/UniqueID
  • /Attachment/AttachmentAsset/AttachmentAssetPath
  • /Attachment/AttachmentAsset/DirectoryPath
  • /Attachment/AttachmentAsset/MimeType
  • /Attachment/AttachmentAsset/language

XSD files