Remedy AR System Server - How to send attachments to a 3rd party REST service in a SetFields REST filter - INCLUDES VIDEO

Manage Support IDs

Use checkboxes to 'Remove support IDs/Users' or 'Allow to create Cases'
Support IDs for BMC Customer Support Site Guest User
Profiles Which Include    Back to All Support IDs
 

Knowledge Article

Remedy AR System Server - How to send attachments to a 3rd party REST service in a SetFields REST filter - INCLUDES VIDEO
When using Remedy Set Fields filter to call a 3rd party REST service, how to send attachments and what formats are supported
Remedy AR System Server
AR System Mid Tier
3rd party REST service in a SetFields REST filter
Remedy AR System Server
AR System Mid Tier
3rd party REST service in a SetFields REST filter
How to send attachments to a 3rd party REST service in a SetFields REST filter?
This knowledge article may contain information that does not apply to version 21.05 or later which runs in a container environment. Please refer to Article Number 000385088 for more information about troubleshooting BMC products in containers.

NOTE:  File encoding can be done in binary format only.  However if the 3rd party REST service requires the file in another format such as base64, a filter / run process operation can do that conversion.

Reference documentation:
https://docs.bmc.com/docs/ars2002/calling-third-party-rest-apis-in-a-remedy-application-909638089.html#Callingthird-partyRESTAPIsinaRemedyapplication-multi(Optional)Toaddattachmentdatainformation

There are some details that is not done, the attachements nor the data will be sent:
1. The attachments have to be mapped in the Request mapping
2. The attachments also have to be mapped in MultiPart info
3. A null entity with any name should be created in multipart info
4. All data that is not a file will only be sent if it is linked to the null entity created in step3

Details: 1 The attachments have to be mapped in the Request mapping


Minimal requirement: Field Name should map the attachment field
Optional : if JSONKey has a valid string the name (only the name) of the attachment will be sent as a property inside object called "something" 

Details: 2 The attachments also have to be mapped in MultiPart info
  • The key for "attach-Attachment1" is just a formality.  It could have any format name and doesn't need to match to Request Mapping
  • The value for "attach-Attachment1 has to be in a single line as follows:  ATTACH_FIELD_KEY:536870914#MULTSEP#ATTACH_HEADER_DATA_TYPE:application/octet-stream#MULTSEP#Content-Transfer-Encoding:binary#MULTSEP#some-fake-header:fake-value
  • The minimal format would be ATTACH_FIELD_KEY:<<attachment_field_id>>#MULTSEP#ATTACH_HEADER_DATA_TYPE:application/octet-stream
  • Additional headers can be specified by adding  #MULTSEP#header-name:header-value
  • Any header added will be part of the mime part but would not modify the way files are encoded, from remedy perspective they are always sent in binary format
Example of mime part

--Boundary_23_67127307_1588796349899
Content-Transfer-Encoding: binary
some-fake-header: fake-value
Content-Type: application/octet-stream
Content-Disposition: form-data; filename="encoded_png.txt"; name="attach-Attachment2"

iVBORw0...

--Boundary_23_67127307_1588796349899-

Details : 3. A null entity with any name should be created in multipart info
  • Notice that multipart info has a key labeled "something" with NULL value.   If this NULL entry is not present, the attachments would not be sent. 
  • The first key should have NULL value for attachments to be considered. If the first key doesn't have NULL value a 9130 error will be sent when invoking the WS 


Details 4. All data that is not a file will only be sent if it is linked to the null entity created in step3
  • Besides the attachments the key "something|will be sent" is the only piece of data that will be transferred as part of the REST request.

--Boundary_23_67127307_1588796349899
Content-Type: application/json
Content-Disposition: form-data; name="something"

{"something":{"a1":"encoded_png.txt","a2":null,"will be sent":"testasasd"}}
--Boundary_23_67127307_1588796349899




 
Remedy AR System Server
AR System Mid Tier
3rd party REST service in a SetFields REST filter
Attachment(s):
attachment_001
attachment_002
attachment_003
attachment_004