Upload File Attachment v2
post
/v2/file/upload
Upload a file type media object for the given structure and key. The 'moAdd' parameter takes a JSON string in the form of the MediaObjectUploadRequest class
Request
Supported Media Types
- multipart/form-data
Header Parameters
-
jde-AIS-Auth: string
Token
-
jde-AIS-Auth-Device: string
Device Name
-
jde-AIS-MonitorOnStart: boolean
Monitor on Start
-
jde-AIS-MonitorRequest: string
Monitor RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
Form Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Successful Execution
Root Schema : MediaObjectListResponse
Type:
object
MediaObjectListResponse is the output of the media object list operation.
Show Source
-
mediaObjects:
array mediaObjects
The list of media object items.
Nested Schema : mediaObjects
Type:
array
The list of media object items.
Show Source
-
Array of:
object MediaObjectListItem
MediaObjectListItem is an individual media object within the response returned from the list operation.
Nested Schema : MediaObjectListItem
Type:
object
MediaObjectListItem is an individual media object within the response returned from the list operation.
Show Source
-
data:
string
If this is an image and data was requested, this will contain a Base64 encoded string of the image, scaled down to thumbnail size based on the request.
-
deviceName:
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
downloadUrl:
string
For file type media objects this is the download URL needed ot download the item. Pass this value into a download request.
-
environment:
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
file:
string
The location of the file for this media object.
-
formName(required):
string
The name of the form the media object is associated with (for example W01012A).
-
isDefaultImage:
boolean
Indicates that this image was set as the default image for this media object structure and key.
-
isImage:
boolean
Indicates the file is an image.
-
isOLE:
boolean
Indicates the item is an OLE item.
-
isShortCut:
boolean
Indicates the item is a shortcut.
-
isText:
boolean
Indicates the item is a text type media object.
-
isUpdated:
boolean
Indicates the item has been updated.
-
isURL:
boolean
Indicates the item is a URL type media object.
-
itemName:
string
The name of the media object item.
-
jasserver:
string
The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
-
link:
string
The if it's a URL type it will have the URL, for file types it will have the file location, for text types this field is not returned.
-
moKey(required):
array moKey
An array of media object key values. You must pass the values in the same order that they appear in the data structure. The key values will be converted into the bar delimited key of the media object record stored in the F00165 table.
-
moStructure(required):
string
The media object data structure name, for example GT0801 or ABGT, which is a key to the F00165 table where media objects are stored.
-
moType:
integer(int32)
The media object type, 0-Text, 1-File, 5-URL.
-
password:
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
psToken:
string
Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
-
queue:
string
If the file was from the media object queue, the queue name will be returned.
-
role:
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
sequence:
integer(int32)
The sequence number of the media object item.
-
token:
string
The AIS token, which is required if other authentication methods are not being used.
-
updateDate:
string
The date the media object was last updated.
-
updateHourOfDay:
integer(int32)
The hour of the day the item was last updated.
-
updateMinuteOfHour:
integer(int32)
The minute of the hour of the day the item was last updated.
-
updateSecondOfMinute:
integer(int32)
The second of the minute of the hour day the item was last updated.
-
updateUserID:
string
The user that last updated the item.
-
username:
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
-
version(required):
string
The version of the application the media object is associated with (for example ZJDE0001).
Nested Schema : moKey
Type:
array
An array of media object key values. You must pass the values in the same order that they appear in the data structure. The key values will be converted into the bar delimited key of the media object record stored in the F00165 table.
Show Source
400 Response
Bad Request - Invalid JSON Input
403 Response
Authorization Failure
415 Response
Invalid Content-Type Header - Must use application/json
444 Response
Invalid Token
Root Schema : ServiceErrorResponse
Type:
object
Error Response
Show Source
-
errorText:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
500 Response
Server Failed to Process Request
Root Schema : ServiceErrorResponse
Type:
object
Error Response
Show Source
-
errorText:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
Examples
Example Request
The following shows an example of a media object request to upload a file attachment. The token value is from a prior call to the token request service to establish a session. The file being uploaded is in this location: C:\temp\billards.jpg and it is an image/jpeg type. The JSON being sent is stored in this location and text file: C:\temp\upload.json.
curl -i POST "Content-Type:multipart/related" http://ais_server_url/jderest/file/upload -F file="@C:\temp\billards.jpg;type=image/jpeg" -F moAdd="@C:\temp\upload.json;type=application/json" Contents of file: C:\temp\upload.json: { "token":"044HcnKxuypi6XVrCAtYtiAKcGHMpd9xA9HukRsiAyJY58=MDE5MDA4NjY0MTUzMTQ5MzQ4OTgxMjUyNk15RGV2aWNlMTQ4MjQzMTEzNTg0NQ==", "deviceName":"MyDevice", "ssoEnabled":false, "moStructure":"ABGT", "moKey":[ "7500" ], "formName":"P01012_W01012B", "version":"ZJDE0001", "file":{ "fileName":"billards.jpg", "fileLocation":"C:\\temp\\billards.jpg", "itemName":"Uploaded File APIs", "sequence":0 } }
Example Response
The following example shows the contents of the response body.
{ "uniquefilename":"FILE-7226089643494364133-1482431140345.jpg", "itemName":"Uploaded File APIs.jpg", "sequence":2 }